"tree_parent" : []
},
"Roo" : {
- "props" : [
- {
- "name" : "grid",
- "type" : "Roo.grid.Grid",
- "desc" : "The grid for this panel",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "layout",
- "type" : "Roo.BorderLayout",
- "desc" : "The layout for this panel",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
+ "props" : [],
"events" : [],
"methods" : [
{
{
"name" : "getTabs",
"type" : "function",
- "desc" : "Returns the TabPanel component (creates it if it doesn't exist).\nNote: If you wish to simply check for the existence of tabs without creating them,\ncheck for a null 'tabs' property.",
+ "desc" : "Returns the panel.Tab component (creates it if it doesn't exist).\nNote: If you wish to simply check for the existence of tabs without creating them,\ncheck for a null 'tabs' property.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : [
{
"name" : "",
- "type" : "Roo.TabPanel",
+ "type" : "Roo.panel.Tab",
"desc" : "The tabs component"
}
]
"returns" : [
{
"name" : "",
- "type" : "Roo.TabPanel",
+ "type" : "Roo.panel.Tab",
"desc" : "The tabs component"
}
]
"builder"
]
},
- "Roo.BasicLayoutRegion" : {
+ "Roo.BoxComponent" : {
"props" : [
+ {
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "height (optional) size of component",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
{
"name" : "listeners",
"type" : "Object",
"memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "width (optional) size of component",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
- "name" : "beforecollapse",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fires when this region before collapse.",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforeremove",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument.",
- "sig" : "function (_self, panel, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Object",
- "desc" : "The cancel event object",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "collapsed",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires when this region is collapsed.",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "expanded",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Fires when this region is expanded.",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "invalidated",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires when the layout for this region is changed.",
+ "desc" : "Fires after the component is destroyed.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "panelactivated",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires when a panel is activated.",
- "sig" : "function (_self, panel)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The activated panel",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "paneladded",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires when a panel is added.",
- "sig" : "function (_self, panel)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "panelremoved",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires when a panel is removed.",
- "sig" : "function (_self, panel)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resized",
+ "name" : "move",
"type" : "function",
- "desc" : "Fires when the user resizes this region.",
- "sig" : "function (_self, newSize)\n{\n\n}",
+ "desc" : "Fires after the component is moved.",
+ "sig" : "function (_self, x, y)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
},
{
- "name" : "newSize",
+ "name" : "x",
"type" : "Number",
- "desc" : "The new size (width for east/west, height for north/south)",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "slidehide",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires when this region slides out of view.",
+ "desc" : "Fires after the component is rendered.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "slideshow",
+ "name" : "resize",
"type" : "function",
- "desc" : "Fires when this region is slid into view.",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Fires after the component is resized.",
+ "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "visibilitychange",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires when this region is shown or hidden",
- "sig" : "function (_self, visibility)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "visibility",
- "type" : "Boolean",
- "desc" : "true or false",
- "isOptional" : false
}
],
"returns" : []
}
],
"methods" : [
- {
- "name" : "add",
- "type" : "function",
- "desc" : "Add the passed ContentPanel(s)",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "ContentPanel...",
- "desc" : "The ContentPanel(s) to add (you can pass more than one)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel added (if only one was added)"
- }
- ]
- },
{
"name" : "addEvents",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
{
"name" : "fireEvent",
"type" : "function",
]
},
{
- "name" : "getActivePanel",
+ "name" : "focus",
"type" : "function",
- "desc" : "Get the active panel for this region.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The active panel or null"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
+ {
+ "name" : "getBox",
+ "type" : "function",
+ "desc" : "Gets the current box measurements of the component's underlying element.",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "getEl",
"type" : "function",
- "desc" : "Returns the container element for this region.",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Roo.Element",
+ "desc" : "The element"
+ }
+ ]
+ },
+ {
+ "name" : "getId",
+ "type" : "function",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
"desc" : ""
}
]
},
{
- "name" : "getPanel",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "Returns the panel specified or null if it's not in this region.",
- "sig" : "(panel)",
+ "desc" : "Gets the current XY position of the component's underlying element.",
+ "sig" : "(local)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : ""
+ "type" : "Array",
+ "desc" : "The XY position of the element (e.g., [100, 200])"
}
]
},
{
- "name" : "getPosition",
+ "name" : "getSize",
"type" : "function",
- "desc" : "Returns this regions position (north/south/east/west/center).",
+ "desc" : "Gets the current size of the component's underlying element.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Object",
+ "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
}
]
},
]
},
{
- "name" : "hasPanel",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns true if the panel is in this region.",
- "sig" : "(panel)",
+ "desc" : "Hide this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
"name" : "isVisible",
"type" : "function",
- "desc" : "Returns true if this region is currently visible.",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
"name" : "on",
],
"returns" : []
},
+ {
+ "name" : "onPosition",
+ "type" : "function",
+ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
+ "sig" : "(x, y)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "onResize",
+ "type" : "function",
+ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
+ "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "purgeListeners",
"type" : "function",
"returns" : []
},
{
- "name" : "remove",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
- "sig" : "(panel, preservePanel)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "preservePanel",
- "type" : "Boolean",
- "desc" : "Overrides the config preservePanel option",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel that was removed"
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "removeListener",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setPagePosition",
+ "type" : "function",
+ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
+ "sig" : "(x, y)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resizeTo",
+ "name" : "setPosition",
"type" : "function",
- "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
- "sig" : "(newSize)",
+ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
+ "sig" : "(left, top)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "newSize",
+ "name" : "left",
"type" : "Number",
- "desc" : "The new width or height",
+ "desc" : "The new left",
+ "isOptional" : false
+ },
+ {
+ "name" : "top",
+ "type" : "Number",
+ "desc" : "The new top",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "showPanel",
+ "name" : "setSize",
"type" : "function",
- "desc" : "Show the specified panel.",
- "sig" : "(panelId)",
+ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
+ "sig" : "(width, height)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "panelId",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
+ "name" : "width",
+ "type" : "Number/Object",
+ "desc" : "The new width to set, or a size object in the format {width, height}",
+ "isOptional" : false
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height to set (not required if a size object is passed as the first arg)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The shown panel or null"
+ "type" : "Roo.BoxComponent",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
+ {
+ "name" : "syncSize",
+ "type" : "function",
+ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "un",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "updateBox",
+ "type" : "function",
+ "desc" : "Sets the current box measurements of the component's underlying element.",
+ "sig" : "(box)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "box",
+ "type" : "Object",
+ "desc" : "An object in the format {x, y, width, height}",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [
- "Roo.LayoutRegion",
- "Roo.SplitLayoutRegion",
- "Roo.bootstrap.layout.Split"
+ "Roo.form.Checkbox",
+ "Roo.form.ComboBox",
+ "Roo.form.ComboBoxArray",
+ "Roo.form.ComboBoxArray.Item",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.FCKeditor",
+ "Roo.form.Field",
+ "Roo.form.GridField",
+ "Roo.form.Hidden",
+ "Roo.form.HtmlEditor",
+ "Roo.form.MonthField",
+ "Roo.form.NumberField",
+ "Roo.form.Radio",
+ "Roo.form.Select",
+ "Roo.form.Signature",
+ "Roo.form.TextArea",
+ "Roo.form.TextField",
+ "Roo.form.TextItem",
+ "Roo.form.TriggerField",
+ "Roo.panel.Cropbox"
],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.BorderLayout" : {
+ "Roo.Button" : {
"props" : [
{
- "name" : "center",
- "type" : "Roo.LayoutRegion",
- "desc" : "",
+ "name" : "clickEvent",
+ "type" : "String",
+ "desc" : "The type of event to map to the button's event handler (defaults to 'click')",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "east",
- "type" : "Roo.LayoutRegion",
- "desc" : "",
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "A CSS class to apply to the button's main element.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "True to start disabled (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableToggle",
+ "type" : "Boolean",
+ "desc" : "True to enable pressed/not pressed toggling (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "handleMouseEvents",
+ "type" : "Boolean",
+ "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "A function called when the button is clicked (can be used instead of click event)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "True to start hidden (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "icon",
+ "type" : "String",
+ "desc" : "The path to an image to display in the button (the image will be set as the background-image\nCSS property of the button by default, so if you want a mixed icon/text button, set cls:\"x-btn-text-icon\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "iconCls",
+ "type" : "String",
+ "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"optvals" : []
},
{
- "name" : "north",
- "type" : "Roo.LayoutRegion",
- "desc" : "",
+ "name" : "menu",
+ "type" : "Roo.menu.Menu",
+ "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "south",
- "type" : "Roo.LayoutRegion",
- "desc" : "",
+ "name" : "menuAlign",
+ "type" : "String",
+ "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "west",
- "type" : "Roo.LayoutRegion",
- "desc" : "",
+ "name" : "minWidth",
+ "type" : "Number",
+ "desc" : "The minimum width for this button (used to give a set of buttons a common width)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "pressed",
+ "type" : "Boolean",
+ "desc" : "True to start pressed (only if enableToggle = true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "renderTo",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The element to append the button to",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "repeat",
+ "type" : "Boolean/Object",
+ "desc" : "True to repeat fire the click event while the mouse is down. This can also be\n an {@link Roo.util.ClickRepeater} config object (defaults to false).",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "The scope of the handler",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tabIndex",
+ "type" : "Number",
+ "desc" : "The DOM tabIndex for this button (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "template",
+ "type" : "Roo.Template",
+ "desc" : "An {@link Roo.Template} with which to create the Button's main element. This Template must\ncontain numeric substitution parameter 0 if it is to display the tRoo property. Changing the template could\nrequire code modifications if required elements (e.g. a button) aren't present.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "The button text",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "toggleGroup",
+ "type" : "String",
+ "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tooltip",
+ "type" : "String/Object",
+ "desc" : "The tooltip for the button - can be a string or QuickTips config object",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tooltipType",
+ "type" : "String",
+ "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "type",
+ "type" : "String",
+ "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
],
"events" : [
{
- "name" : "layout",
+ "name" : "click",
"type" : "function",
- "desc" : "Fires when a layout is performed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.LayoutManager",
+ "desc" : "Fires when this button is clicked",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutManager",
+ "type" : "Button",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "The click event",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "regioncollapsed",
+ "name" : "mouseout",
"type" : "function",
- "desc" : "Fires when a region is collapsed.",
- "sig" : "function (region)\n{\n\n}",
- "memberOf" : "Roo.LayoutManager",
+ "desc" : "Fires when the mouse exits the button",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The collapsed region",
+ "name" : "this",
+ "type" : "Button",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "regionexpanded",
+ "name" : "mouseover",
"type" : "function",
- "desc" : "Fires when a region is expanded.",
- "sig" : "function (region)\n{\n\n}",
- "memberOf" : "Roo.LayoutManager",
+ "desc" : "Fires when the mouse hovers over the button",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The expanded region",
+ "name" : "this",
+ "type" : "Button",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "regionresized",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires when the user resizes a region.",
- "sig" : "function (region, newSize)\n{\n\n}",
- "memberOf" : "Roo.LayoutManager",
+ "desc" : "Fires when the button is rendered",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The resized region",
- "isOptional" : false
- },
- {
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new size (width for east/west, height for north/south)",
+ "name" : "this",
+ "type" : "Button",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "add",
+ "name" : "toggle",
"type" : "function",
- "desc" : "Adds a ContentPanel (or subclass) to this layout.",
- "sig" : "(target, panel)",
- "static" : false,
+ "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)",
+ "sig" : "function (_self, pressed)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "String",
- "desc" : "The target region key (north, south, east, west or center).",
+ "name" : "this",
+ "type" : "Button",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel to add",
+ "name" : "pressed",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The added panel"
- }
- ]
- },
+ "returns" : []
+ }
+ ],
+ "methods" : [
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "addRegion",
+ "name" : "capture",
"type" : "function",
- "desc" : "Creates and adds a new region if it doesn't already exist.",
- "sig" : "(target, config)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "String",
- "desc" : "The target region key (north, south, east, west or center).",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "config",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
"type" : "Object",
- "desc" : "The regions config object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "BorderLayoutRegion",
- "desc" : "The new region"
- }
- ]
+ "returns" : []
},
{
- "name" : "addxtype",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Adds a xtype elements to the layout.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'ContentPanel',\n region: 'west',\n items: [ .... ]\n }\n);\n\nlayout.addxtype({\n xtype : 'NestedLayoutPanel',\n region: 'west',\n layout: {\n center: { },\n west: { } \n },\n items : [ ... list of content panels or nested layout panels.. ]\n }\n);\n</code></pre>",
- "sig" : "(cfg)",
+ "desc" : "Destroys this Button and removes any listeners.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "cfg",
- "type" : "Object",
- "desc" : "Xtype definition of item to add.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "batchAdd",
+ "name" : "disable",
"type" : "function",
- "desc" : "Adds a batch of multiple ContentPanels dynamically by passing a special regions config object. This config\nobject should contain properties for each region to add ContentPanels to, and each property's value should be\na valid ContentPanel config object. Example:\n<pre><code>\n// Create the main layout\nvar layout = new Roo.BorderLayout('main-ct', {\n west: {\n split:true,\n minSize: 175,\n titlebar: true\n },\n center: {\n title:'Components'\n }\n}, 'main-ct');\n\n// Create and add multiple ContentPanels at once via configs\nlayout.batchAdd({\n west: {\n id: 'source-files',\n autoCreate:true,\n title:'Ext Source Files',\n autoScroll:true,\n fitToFrame:true\n },\n center : {\n el: cview,\n autoScroll:true,\n fitToFrame:true,\n toolbar: tb,\n resizeEl:'cbody'\n }\n});\n</code></pre>",
- "sig" : "(regions)",
+ "desc" : "Disable this button",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "regions",
- "type" : "Object",
- "desc" : "An object containing ContentPanel configs by region name",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "beginUpdate",
+ "name" : "enable",
"type" : "function",
- "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls",
+ "desc" : "Enable this button",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutManager",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "capture",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
"memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "create",
+ "name" : "focus",
"type" : "function",
- "desc" : "Shortcut for creating a new BorderLayout object and adding one or more ContentPanels to it in a single step, handling\nthe beginUpdate and endUpdate calls internally. The key to this method is the <b>panels</b> property that can be\nprovided with each region config, which allows you to add ContentPanel configs in addition to the region configs\nduring creation. The following code is equivalent to the constructor-based example at the beginning of this class:\n<pre><code>\n// shorthand\nvar CP = Roo.ContentPanel;\n\nvar layout = Roo.BorderLayout.create({\n north: {\n initialSize: 25,\n titlebar: false,\n panels: [new CP(\"north\", \"North\")]\n },\n west: {\n split:true,\n initialSize: 200,\n minSize: 175,\n maxSize: 400,\n titlebar: true,\n collapsible: true,\n panels: [new CP(\"west\", {title: \"West\"})]\n },\n east: {\n split:true,\n initialSize: 202,\n minSize: 175,\n maxSize: 400,\n titlebar: true,\n collapsible: true,\n panels: [new CP(\"autoTabs\", {title: \"Auto Tabs\", closable: true})]\n },\n south: {\n split:true,\n initialSize: 100,\n minSize: 100,\n maxSize: 200,\n titlebar: true,\n collapsible: true,\n panels: [new CP(\"south\", {title: \"South\", closable: true})]\n },\n center: {\n titlebar: true,\n autoScroll:true,\n resizeTabs: true,\n minTabWidth: 50,\n preferredTabWidth: 150,\n panels: [\n new CP(\"center1\", {title: \"Close Me\", closable: true}),\n new CP(\"center2\", {title: \"Center Panel\", closable: false})\n ]\n }\n}, document.body);\n\nlayout.getRegion(\"center\").showPanel(\"center1\");\n</code></pre>",
- "sig" : "(config, targetEl)",
- "static" : true,
+ "desc" : "Focus the button",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "config",
- "type" : "",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "targetEl",
- "type" : "",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "endUpdate",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
- "sig" : "(noLayout)",
+ "desc" : "Returns the button's underlying element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutManager",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "noLayout",
- "type" : "Boolean",
- "desc" : "true to disable a layout update",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "findPanel",
+ "name" : "getText",
"type" : "function",
- "desc" : "Searches all regions for a panel with the specified id",
- "sig" : "(panelId)",
+ "desc" : "Gets the text for this button",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "panelId",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel or null if it wasn't found"
+ "type" : "String",
+ "desc" : "The button text"
}
]
},
{
- "name" : "fireEvent",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "getEl",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns the Element this layout is bound to.",
+ "desc" : "Hide this button",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutManager",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getRegion",
+ "name" : "on",
"type" : "function",
- "desc" : "Returns the specified region.",
- "sig" : "(target)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.LayoutManager",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "target",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.LayoutRegion",
- "desc" : ""
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getViewSize",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutManager",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "The size as an object {width: (the width), height: (the height)}"
- }
- ]
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
"memberOf" : "Roo.util.Observable",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "isUpdating",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Returns true if this layout is currently being updated",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.LayoutManager",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "layout",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Performs a layout update.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Convenience function for boolean enable/disable",
+ "sig" : "(enabled)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "enabled",
+ "type" : "Boolean",
+ "desc" : "True to enable, false to disable",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "on",
+ "name" : "setHandler",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Assigns this button's click handler",
+ "sig" : "(handler, scope)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
{
"name" : "handler",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The function to call when the button is clicked",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "desc" : "(optional) Scope for the function passed in",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "setPressed",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Similar to toggle, but does not trigger event.",
+ "sig" : "(state)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "[required] Force a particular state",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "setText",
"type" : "function",
- "desc" : "Remove a ContentPanel (or subclass) to this layout.",
- "sig" : "(target, panel)",
+ "desc" : "Sets this button's text",
+ "sig" : "(text)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "target",
+ "name" : "text",
"type" : "String",
- "desc" : "The target region key (north, south, east, west or center).",
- "isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Number/String/Roo.ContentPanel",
- "desc" : "The index, id or panel to remove",
+ "desc" : "The button text",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The removed panel"
- }
- ]
+ "returns" : []
},
{
- "name" : "removeListener",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Convenience function for boolean show/hide",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "restoreState",
+ "name" : "show",
"type" : "function",
- "desc" : "Restores this layout's state using Roo.state.Manager or the state provided by the passed provider.",
- "sig" : "(provider)",
+ "desc" : "Show this button",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "provider",
- "type" : "Roo.state.Provider",
- "desc" : "(optional) An alternate state provider",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "showPanel",
+ "name" : "toggle",
"type" : "function",
- "desc" : "Searches all regions for a panel with the specified id and activates (shows) it.",
- "sig" : "(panelId)",
+ "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.",
+ "sig" : "(state)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "panelId",
- "type" : "String/ContentPanel",
- "desc" : "The panels id or the panel itself",
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "(optional) Force a particular state",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The shown panel or null"
- }
- ]
+ "returns" : []
},
{
"name" : "un",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [
- "Roo.ReaderLayout"
- ],
- "tree_children" : [
- "Roo.ContentPanel",
- "Roo.GridPanel",
- "Roo.NestedLayoutPanel",
- "Roo.TreePanel"
+ "Roo.SplitButton",
+ "Roo.Toolbar.Button",
+ "Roo.Toolbar.SplitButton"
],
+ "tree_children" : [],
"tree_parent" : []
},
- "Roo.BoxComponent" : {
+ "Roo.ColorPalette" : {
"props" : [
{
"name" : "actionMode",
"optvals" : []
},
{
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
+ "name" : "allowReselect",
+ "type" : "Boolean",
+ "desc" : "If set to true then reselecting a color that is already selected fires the selection event",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "height (optional) size of component",
- "memberOf" : "",
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
"visibility"
]
},
+ {
+ "name" : "itemCls",
+ "type" : "String",
+ "desc" : "The CSS class to apply to the containing element (defaults to \"x-color-palette\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"optvals" : []
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "width (optional) size of component",
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The initial color to highlight (should be a valid 6-digit color hex code without the # symbol). Note that\nthe hex codes are case-sensitive.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
],
"returns" : []
},
- {
- "name" : "move",
- "type" : "function",
- "desc" : "Fires after the component is moved.",
- "sig" : "function (_self, x, y)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
"returns" : []
},
{
- "name" : "resize",
+ "name" : "select",
"type" : "function",
- "desc" : "Fires after the component is resized.",
- "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "desc" : "Fires when a color is selected",
+ "sig" : "function (_self, color)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "ColorPalette",
"desc" : "",
"isOptional" : false
},
{
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
- "isOptional" : false
- },
- {
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
- "isOptional" : false
- },
- {
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
+ "name" : "color",
+ "type" : "String",
+ "desc" : "The 6-digit color hex code (without the # symbol)",
"isOptional" : false
}
],
}
]
},
- {
- "name" : "getBox",
- "type" : "function",
- "desc" : "Gets the current box measurements of the component's underlying element.",
- "sig" : "(local)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "getEl",
"type" : "function",
}
]
},
- {
- "name" : "getPosition",
- "type" : "function",
- "desc" : "Gets the current XY position of the component's underlying element.",
- "sig" : "(local)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Array",
- "desc" : "The XY position of the element (e.g., [100, 200])"
- }
- ]
- },
- {
- "name" : "getSize",
- "type" : "function",
- "desc" : "Gets the current size of the component's underlying element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
- }
- ]
- },
{
"name" : "hasListener",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "onPosition",
- "type" : "function",
- "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
- "sig" : "(x, y)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "onResize",
- "type" : "function",
- "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
- "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
- "isOptional" : false
- },
- {
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
- "isOptional" : false
- },
- {
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "purgeListeners",
"type" : "function",
"returns" : []
},
{
- "name" : "setDisabled",
- "type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setPagePosition",
+ "name" : "select",
"type" : "function",
- "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
- "sig" : "(x, y)",
+ "desc" : "Selects the specified color in the palette (fires the select event)",
+ "sig" : "(color)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
+ "name" : "color",
+ "type" : "String",
+ "desc" : "A valid 6-digit color hex code (# will be stripped if included)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setPosition",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
- "sig" : "(left, top)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "left",
- "type" : "Number",
- "desc" : "The new left",
- "isOptional" : false
- },
- {
- "name" : "top",
- "type" : "Number",
- "desc" : "The new top",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "setSize",
- "type" : "function",
- "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
- "sig" : "(width, height)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "width",
- "type" : "Number/Object",
- "desc" : "The new width to set, or a size object in the format {width, height}",
- "isOptional" : false
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "The new height to set (not required if a size object is passed as the first arg)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.BoxComponent",
- "desc" : "this"
- }
- ]
- },
{
"name" : "setVisible",
"type" : "function",
}
]
},
- {
- "name" : "syncSize",
- "type" : "function",
- "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "un",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "updateBox",
- "type" : "function",
- "desc" : "Sets the current box measurements of the component's underlying element.",
- "sig" : "(box)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "box",
- "type" : "Object",
- "desc" : "An object in the format {x, y, width, height}",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.dialog.UploadCropbox",
- "Roo.form.Checkbox",
- "Roo.form.ComboBox",
- "Roo.form.ComboBoxArray",
- "Roo.form.ComboBoxArray.Item",
- "Roo.form.ComboCheck",
- "Roo.form.ComboNested",
- "Roo.form.DateField",
- "Roo.form.DayPicker",
- "Roo.form.DisplayField",
- "Roo.form.FCKeditor",
- "Roo.form.Field",
- "Roo.form.GridField",
- "Roo.form.Hidden",
- "Roo.form.HtmlEditor",
- "Roo.form.MonthField",
- "Roo.form.NumberField",
- "Roo.form.Radio",
- "Roo.form.Select",
- "Roo.form.Signature",
- "Roo.form.TextArea",
- "Roo.form.TextField",
- "Roo.form.TextItem",
- "Roo.form.TriggerField"
- ],
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.Button" : {
+ "Roo.Component" : {
"props" : [
{
- "name" : "clickEvent",
- "type" : "String",
- "desc" : "The type of event to map to the button's event handler (defaults to 'click')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cls",
+ "name" : "actionMode",
"type" : "String",
- "desc" : "A CSS class to apply to the button's main element.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "True to start disabled (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "enableToggle",
- "type" : "Boolean",
- "desc" : "True to enable pressed/not pressed toggling (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "handleMouseEvents",
- "type" : "Boolean",
- "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "A function called when the button is clicked (can be used instead of click event)",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hidden",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "True to start hidden (defaults to false)",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "icon",
+ "name" : "disableClass",
"type" : "String",
- "desc" : "The path to an image to display in the button (the image will be set as the background-image\nCSS property of the button by default, so if you want a mixed icon/text button, set cls:\"x-btn-text-icon\")",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "iconCls",
+ "name" : "hideMode",
"type" : "String",
- "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
"memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "listeners",
"optvals" : []
},
{
- "name" : "menu",
- "type" : "Roo.menu.Menu",
- "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "menuAlign",
+ "name" : "style",
"type" : "String",
- "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minWidth",
- "type" : "Number",
- "desc" : "The minimum width for this button (used to give a set of buttons a common width)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "pressed",
- "type" : "Boolean",
- "desc" : "True to start pressed (only if enableToggle = true)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "renderTo",
- "type" : "String/HTMLElement/Element",
- "desc" : "The element to append the button to",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "repeat",
- "type" : "Boolean/Object",
- "desc" : "True to repeat fire the click event while the mouse is down. This can also be\n an {@link Roo.util.ClickRepeater} config object (defaults to false).",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "The scope of the handler",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "tabIndex",
- "type" : "Number",
- "desc" : "The DOM tabIndex for this button (defaults to undefined)",
+ "desc" : "css styles to add to component\neg. text-align:right;",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
- },
+ }
+ ],
+ "events" : [
{
- "name" : "template",
- "type" : "Roo.Template",
- "desc" : "An {@link Roo.Template} with which to create the Button's main element. This Template must\ncontain numeric substitution parameter 0 if it is to display the tRoo property. Changing the template could\nrequire code modifications if required elements (e.g. a button) aren't present.",
+ "name" : "beforedestroy",
+ "type" : "function",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "text",
- "type" : "String",
- "desc" : "The button text",
+ "name" : "beforehide",
+ "type" : "function",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "toggleGroup",
- "type" : "String",
- "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
+ "name" : "beforerender",
+ "type" : "function",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "tooltip",
- "type" : "String/Object",
- "desc" : "The tooltip for the button - can be a string or QuickTips config object",
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "tooltipType",
- "type" : "String",
- "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "type",
- "type" : "String",
- "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "click",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires when this button is clicked",
- "sig" : "function (_self, e)\n{\n\n}",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Button",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "e",
- "type" : "EventObject",
- "desc" : "The click event",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "mouseout",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires when the mouse exits the button",
- "sig" : "function (_self, e)\n{\n\n}",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Button",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "mouseover",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires when the mouse hovers over the button",
- "sig" : "function (_self, e)\n{\n\n}",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Button",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
- "isOptional" : false
}
],
"returns" : []
{
"name" : "render",
"type" : "function",
- "desc" : "Fires when the button is rendered",
+ "desc" : "Fires after the component is rendered.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"params" : [
{
"name" : "this",
- "type" : "Button",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "toggle",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)",
- "sig" : "function (_self, pressed)\n{\n\n}",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Button",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "pressed",
- "type" : "Boolean",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
{
"name" : "destroy",
"type" : "function",
- "desc" : "Destroys this Button and removes any listeners.",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
{
"name" : "disable",
"type" : "function",
- "desc" : "Disable this button",
+ "desc" : "Disable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "enable",
"type" : "function",
- "desc" : "Enable this button",
+ "desc" : "Enable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "fireEvent",
{
"name" : "focus",
"type" : "function",
- "desc" : "Focus the button",
- "sig" : "()\n{\n\n}",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "getEl",
"type" : "function",
- "desc" : "Returns the button's underlying element",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
]
},
{
- "name" : "getText",
+ "name" : "getId",
"type" : "function",
- "desc" : "Gets the text for this button",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
{
"name" : "",
"type" : "String",
- "desc" : "The button text"
+ "desc" : ""
}
]
},
{
"name" : "hide",
"type" : "function",
- "desc" : "Hide this button",
+ "desc" : "Hide this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "render",
"type" : "function",
- "desc" : "Convenience function for boolean enable/disable",
- "sig" : "(enabled)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "enabled",
- "type" : "Boolean",
- "desc" : "True to enable, false to disable",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setHandler",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Assigns this button's click handler",
- "sig" : "(handler, scope)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The function to call when the button is clicked",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) Scope for the function passed in",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setPressed",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Similar to toggle, but does not trigger event.",
- "sig" : "(state)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "state",
+ "name" : "visible",
"type" : "Boolean",
- "desc" : "[required] Force a particular state",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "setText",
+ "name" : "show",
"type" : "function",
- "desc" : "Sets this button's text",
- "sig" : "(text)",
+ "desc" : "Show this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "text",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The button text",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.BoxComponent",
+ "Roo.ColorPalette",
+ "Roo.DatePicker",
+ "Roo.Editor",
+ "Roo.HtmlEditorCore",
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Body",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.CardFooter",
+ "Roo.bootstrap.CardHeader",
+ "Roo.bootstrap.CardImageTop",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.Component",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Modal",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Popover",
+ "Roo.bootstrap.PopoverNav",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.TableBody",
+ "Roo.bootstrap.TableCell",
+ "Roo.bootstrap.TableRow",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Item",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.HtmlEditorToolbar.Standard",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.layout.Border",
+ "Roo.bootstrap.layout.Manager",
+ "Roo.bootstrap.menu.Item",
+ "Roo.bootstrap.menu.Menu",
+ "Roo.bootstrap.menu.Separator",
+ "Roo.bootstrap.nav.Bar",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.Item",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar",
+ "Roo.form.Checkbox",
+ "Roo.form.Column",
+ "Roo.form.ComboBox",
+ "Roo.form.ComboBoxArray",
+ "Roo.form.ComboBoxArray.Item",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.FCKeditor",
+ "Roo.form.Field",
+ "Roo.form.FieldSet",
+ "Roo.form.GridField",
+ "Roo.form.Hidden",
+ "Roo.form.HtmlEditor",
+ "Roo.form.Layout",
+ "Roo.form.MonthField",
+ "Roo.form.NumberField",
+ "Roo.form.Radio",
+ "Roo.form.Row",
+ "Roo.form.Select",
+ "Roo.form.Signature",
+ "Roo.form.TextArea",
+ "Roo.form.TextField",
+ "Roo.form.TextItem",
+ "Roo.form.TriggerField",
+ "Roo.grid.GridEditor",
+ "Roo.menu.Adapter",
+ "Roo.menu.BaseItem",
+ "Roo.menu.CheckItem",
+ "Roo.menu.ColorItem",
+ "Roo.menu.DateItem",
+ "Roo.menu.Item",
+ "Roo.menu.Separator",
+ "Roo.menu.TextItem",
+ "Roo.panel.Calendar",
+ "Roo.panel.Cropbox",
+ "Roo.tree.TreeEditor"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.ComponentMgr" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "setVisible",
+ "name" : "get",
"type" : "function",
- "desc" : "Convenience function for boolean show/hide",
- "sig" : "(visible)",
+ "desc" : "Returns a component by id",
+ "sig" : "(id)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The component id",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "onAvailable",
"type" : "function",
- "desc" : "Show this button",
- "sig" : "()\n{\n\n}",
+ "desc" : "Registers a function that will be called when a specified component is added to ComponentMgr",
+ "sig" : "(id, fn, scope)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The component id",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Funtction",
+ "desc" : "The callback function",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "The scope of the callback",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "toggle",
+ "name" : "register",
"type" : "function",
- "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.",
- "sig" : "(state)",
+ "desc" : "Registers a component.",
+ "sig" : "(c)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "state",
- "type" : "Boolean",
- "desc" : "(optional) Force a particular state",
+ "name" : "c",
+ "type" : "Roo.Component",
+ "desc" : "The component",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "un",
+ "name" : "unregister",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Unregisters a component.",
+ "sig" : "(c)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "c",
+ "type" : "Roo.Component",
+ "desc" : "The component",
"isOptional" : false
}
],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.SplitButton",
- "Roo.Toolbar.Button",
- "Roo.Toolbar.SplitButton"
- ],
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.CalendarPanel" : {
- "props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "css styles to add to component\neg. text-align:right;",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
+ "Roo.CompositeElement" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "beforedestroy",
+ "name" : "add",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Adds elements to this composite.",
+ "sig" : "(els)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "els",
+ "type" : "String/Array",
+ "desc" : "A string CSS selector, an array of elements or an element",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "CompositeElement",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "beforerender",
+ "name" : "clear",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Removes all elements.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "contains",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Returns true if this composite contains the passed element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "",
+ "desc" : "Boolean"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "destroy",
+ "name" : "each",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Calls the passed function passing (el, this, index) for each element in this composite.",
+ "sig" : "(fn, scope)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The <i>this</i> object (defaults to the element)",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "CompositeElement",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "eventclick",
+ "name" : "fill",
"type" : "function",
- "desc" : "Fires when the mouse click an",
- "sig" : "function (_self, )\n{\n\n}",
+ "desc" : "Clears this composite and adds the elements returned by the passed selector.",
+ "sig" : "(els)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Calendar",
- "desc" : "",
+ "name" : "els",
+ "type" : "String/Array",
+ "desc" : "A string CSS selector, an array of elements or an element",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
"name" : "",
- "type" : "event",
- "desc" : "",
- "isOptional" : false
+ "type" : "CompositeElement",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "evententer",
+ "name" : "filter",
"type" : "function",
- "desc" : "Fires when mouse over an event",
- "sig" : "function (_self, Event)\n{\n\n}",
+ "desc" : "Filters this composite to only elements that match the passed selector.",
+ "sig" : "(selector, inverse)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Calendar",
- "desc" : "",
+ "name" : "selector",
+ "type" : "String",
+ "desc" : "A string CSS selector",
"isOptional" : false
},
{
- "name" : "Event",
- "type" : "event",
- "desc" : "",
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "return inverse filter (not matches)",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "eventleave",
- "type" : "function",
- "desc" : "Fires when the mouse leaves an",
- "sig" : "function (_self, )\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Calendar",
- "desc" : "",
- "isOptional" : false
- },
+ "returns" : [
{
"name" : "",
- "type" : "event",
- "desc" : "",
- "isOptional" : false
+ "type" : "CompositeElement",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "hide",
+ "name" : "first",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Returns the first Element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "monthchange",
+ "name" : "getCount",
"type" : "function",
- "desc" : "Fires when the displayed month changes",
- "sig" : "function (_self, date)\n{\n\n}",
+ "desc" : "Returns the number of elements in this composite",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "DatePicker",
- "desc" : "",
- "isOptional" : false
- },
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "date",
- "type" : "Date",
- "desc" : "The selected month",
- "isOptional" : false
+ "name" : "",
+ "type" : "",
+ "desc" : "Number"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "render",
+ "name" : "indexOf",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Returns true if this composite contains the passed element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "",
+ "desc" : "Boolean"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "rendered",
+ "name" : "item",
"type" : "function",
- "desc" : "Fires when the grid is rendered",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Returns the Element object at the specified index",
+ "sig" : "(index)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Calendar",
+ "name" : "index",
+ "type" : "Number",
"desc" : "",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when a date is selected",
- "sig" : "function (_self, date)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "DatePicker",
- "desc" : "",
- "isOptional" : false
- },
+ "returns" : [
{
- "name" : "date",
- "type" : "Date",
- "desc" : "The selected date",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "show",
+ "name" : "last",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Returns the last Element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : ""
}
- ],
- "returns" : []
- }
- ],
- "methods" : [
+ ]
+ },
{
- "name" : "addEvents",
+ "name" : "removeElement",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Removes the specified element(s).",
+ "sig" : "(el, removeDom)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "el",
+ "type" : "Mixed",
+ "desc" : "The id of an element, the Element itself, the index of the element in this composite\nor an array of any of those.",
+ "isOptional" : false
+ },
+ {
+ "name" : "removeDom",
+ "type" : "Boolean",
+ "desc" : "(optional) True to also remove the element from the document",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "CompositeElement",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "addListener",
+ "name" : "replaceElement",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Replaces the specified element with the passed element.",
+ "sig" : "(el, replacement, domReplace)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element/Number",
+ "desc" : "The id of an element, the Element itself, the index of the element in this composite\nto replace.",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "replacement",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id of an element or the Element itself.",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "domReplace",
+ "type" : "Boolean",
+ "desc" : "True to remove and replace the element in the document too.",
"isOptional" : false
}
],
- "returns" : []
- },
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "CompositeElement",
+ "desc" : "this"
+ }
+ ]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.CompositeElementLite"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.CompositeElementLite" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "capture",
+ "name" : "add",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Adds elements to this composite.",
+ "sig" : "(els)",
+ "static" : false,
+ "memberOf" : "Roo.CompositeElement",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "els",
+ "type" : "String/Array",
+ "desc" : "A string CSS selector, an array of elements or an element",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "CompositeElement",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "destroy",
+ "name" : "clear",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "desc" : "Removes all elements.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.CompositeElement",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "disable",
+ "name" : "contains",
"type" : "function",
- "desc" : "Disable this component.",
+ "desc" : "Returns true if this composite contains the passed element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.CompositeElement",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "",
+ "desc" : "Boolean"
}
]
},
{
- "name" : "enable",
+ "name" : "each",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Calls the passed function passing (el, this, index) for each element in this composite. <b>The element\npassed is the flyweight (shared) Roo.Element instance, so if you require a\na reference to the dom node, use el.dom.</b>",
+ "sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The <i>this</i> object (defaults to the element)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
+ "type" : "CompositeElement",
"desc" : "this"
}
]
},
{
- "name" : "fireEvent",
+ "name" : "fill",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Clears this composite and adds the elements returned by the passed selector.",
+ "sig" : "(els)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.CompositeElement",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "els",
+ "type" : "String/Array",
+ "desc" : "A string CSS selector, an array of elements or an element",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "CompositeElement",
+ "desc" : "this"
}
]
},
{
- "name" : "focus",
+ "name" : "filter",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Filters this composite to only elements that match the passed selector.",
+ "sig" : "(selector, inverse)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.CompositeElement",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "selectText",
+ "name" : "selector",
+ "type" : "String",
+ "desc" : "A string CSS selector",
+ "isOptional" : false
+ },
+ {
+ "name" : "inverse",
"type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "desc" : "return inverse filter (not matches)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
+ "type" : "CompositeElement",
"desc" : "this"
}
]
},
{
- "name" : "getEl",
+ "name" : "first",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Returns the first Element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.CompositeElement",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "The element"
+ "desc" : ""
}
]
},
{
- "name" : "getId",
+ "name" : "getCount",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Returns the number of elements in this composite",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.CompositeElement",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "",
+ "desc" : "Number"
}
]
},
{
- "name" : "hasListener",
+ "name" : "indexOf",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Returns true if this composite contains the passed element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.CompositeElement",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "",
+ "desc" : "Boolean"
+ }
+ ]
+ },
+ {
+ "name" : "item",
+ "type" : "function",
+ "desc" : "Returns a flyweight Element of the dom element object at the specified index",
+ "sig" : "(index)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "Roo.Element",
+ "desc" : ""
}
]
},
{
- "name" : "hide",
+ "name" : "last",
"type" : "function",
- "desc" : "Hide this component.",
+ "desc" : "Returns the last Element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.CompositeElement",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.Element",
+ "desc" : ""
}
]
},
{
- "name" : "isVisible",
+ "name" : "removeElement",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes the specified element(s).",
+ "sig" : "(el, removeDom)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.CompositeElement",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "Mixed",
+ "desc" : "The id of an element, the Element itself, the index of the element in this composite\nor an array of any of those.",
+ "isOptional" : false
+ },
+ {
+ "name" : "removeDom",
+ "type" : "Boolean",
+ "desc" : "(optional) True to also remove the element from the document",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "CompositeElement",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "on",
+ "name" : "replaceElement",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Replaces the specified element with the passed element.",
+ "sig" : "(el, replacement, domReplace)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.CompositeElement",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element/Number",
+ "desc" : "The id of an element, the Element itself, the index of the element in this composite\nto replace.",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "replacement",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id of an element or the Element itself.",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "domReplace",
+ "type" : "Boolean",
+ "desc" : "True to remove and replace the element in the document too.",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "CompositeElement",
+ "desc" : "this"
+ }
+ ]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.DDView" : {
+ "props" : [
+ {
+ "name" : "allowCopy",
+ "type" : "Boolean",
+ "desc" : "Causes ctrl/drag operations to copy nodes rather than move.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "purgeListeners",
+ "name" : "copy",
+ "type" : "Boolean",
+ "desc" : "Causes drag operations to copy nodes rather than move.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dragGroup",
+ "type" : "String/Array",
+ "desc" : "The ddgroup name(s) for the View's DragZone.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dropGroup",
+ "type" : "String/Array",
+ "desc" : "The ddgroup name(s) for the View's DropZone.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "getContextMenu",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Return the context menu for this DDView.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "getDragData",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Create the drag data which consists of an object which has the property \"ddel\" as\n\tthe drag proxy element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "getDropPoint",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Decide whether to drop above or below a View node.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "render",
+ "name" : "getName",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Allows this class to be an Roo.form.Field so it can be found using {@link Roo.form.BasicForm#findField}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "getTargetFromEvent",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Part of the Roo.dd.DropZone interface. If no target node is found, the\n\twhole Element becomes the target, and this causes the drop gesture to append.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "getValue",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "String",
+ "desc" : "a parenthesised list of the ids of the Records in the View."
}
]
},
{
- "name" : "show",
+ "name" : "onDblClick",
"type" : "function",
- "desc" : "Show this component.",
+ "desc" : "Double click fires the event, but also, if this is draggable, and there is only one other\n\trelated DropZone, it transfers the selected node.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "un",
+ "name" : "remove",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Remove {@link Roo.data.Record}s at the specified indices.",
+ "sig" : "(selectedIndices)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "selectedIndices",
+ "type" : "Array/Number",
+ "desc" : "The index (or Array of indices) of Records to remove.",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
+ },
+ {
+ "name" : "setDeletable",
+ "type" : "function",
+ "desc" : "Utility method. Add a delete option to the DDView's context menu.",
+ "sig" : "(imageUrl)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "imageUrl",
+ "type" : "String",
+ "desc" : "The URL of the \"delete\" icon image.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setDraggable",
+ "type" : "function",
+ "desc" : "Specify to which ddGroup items in this DDView may be dragged.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "setDroppable",
+ "type" : "function",
+ "desc" : "Specify from which ddGroup this DDView accepts drops.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Loads the View from a JSON string representing the Records to put into the Store.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.ColorPalette" : {
+ "Roo.DatePicker" : {
"props" : [
{
"name" : "actionMode",
"optvals" : []
},
{
- "name" : "allowReselect",
+ "name" : "cancelText",
+ "type" : "String",
+ "desc" : "The text to display on the cancel button",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "constrainToViewport",
"type" : "Boolean",
- "desc" : "If set to true then reselecting a color that is already selected fires the selection event",
+ "desc" : "True to constrain the date picker to the viewport (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dayNames",
+ "type" : "Array",
+ "desc" : "An array of textual day names which can be overriden for localization support (defaults to Date.dayNames)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "disabledDatesRE",
+ "type" : "RegExp",
+ "desc" : "JavaScript regular expression used to disable a pattern of dates (defaults to null)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabledDatesText",
+ "type" : "String",
+ "desc" : "The tooltip text to display when the date falls on a disabled date (defaults to \"\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabledDays",
+ "type" : "Array",
+ "desc" : "An array of days to disable, 0-based. For example, [0, 6] disables Sunday and Saturday (defaults to null).",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabledDaysText",
+ "type" : "String",
+ "desc" : "The tooltip to display when the date falls on a disabled day (defaults to \"\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "format",
+ "type" : "String",
+ "desc" : "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "hideMode",
"type" : "String",
]
},
{
- "name" : "itemCls",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxDate",
+ "type" : "Date",
+ "desc" : "Maximum allowable date (JavaScript date object, defaults to null)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxText",
"type" : "String",
- "desc" : "The CSS class to apply to the containing element (defaults to \"x-color-palette\")",
+ "desc" : "The error text to display if the maxDate validation fails (defaults to \"This date is after the maximum date\")",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
+ "name" : "minDate",
+ "type" : "Date",
+ "desc" : "Minimum allowable date (JavaScript date object, defaults to null)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minText",
+ "type" : "String",
+ "desc" : "The error text to display if the minDate validation fails (defaults to \"This date is before the minimum date\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "monthNames",
+ "type" : "Array",
+ "desc" : "An array of textual month names which can be overriden for localization support (defaults to Date.monthNames)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "monthYearText",
+ "type" : "String",
+ "desc" : "The header month selector tooltip (defaults to 'Choose a month (Control+Up/Down to move years)')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "nextText",
+ "type" : "String",
+ "desc" : "The next month navigation button tooltip (defaults to 'Next Month (Control+Right)')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "okText",
+ "type" : "String",
+ "desc" : "The text to display on the ok button",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "prevText",
+ "type" : "String",
+ "desc" : "The previous month navigation button tooltip (defaults to 'Previous Month (Control+Left)')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "showClear",
+ "type" : "Bool",
+ "desc" : "Show a clear button (usefull for date form elements that can be blank.)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "startDay",
+ "type" : "Number",
+ "desc" : "Day index at which the week should begin, 0-based (defaults to 0, which is Sunday)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "value",
+ "name" : "todayText",
"type" : "String",
- "desc" : "The initial color to highlight (should be a valid 6-digit color hex code without the # symbol). Note that\nthe hex codes are case-sensitive.",
+ "desc" : "The text to display on the button that selects the current date (defaults to \"Today\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "todayTip",
+ "type" : "String",
+ "desc" : "The tooltip to display for the button that selects the current date (defaults to \"{current date} (Spacebar)\")",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
],
"returns" : []
},
+ {
+ "name" : "monthchange",
+ "type" : "function",
+ "desc" : "Fires when the displayed month changes",
+ "sig" : "function (_self, date)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "DatePicker",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "date",
+ "type" : "Date",
+ "desc" : "The selected month",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
{
"name" : "select",
"type" : "function",
- "desc" : "Fires when a color is selected",
- "sig" : "function (_self, color)\n{\n\n}",
+ "desc" : "Fires when a date is selected",
+ "sig" : "function (_self, date)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "ColorPalette",
+ "type" : "DatePicker",
"desc" : "",
"isOptional" : false
},
{
- "name" : "color",
- "type" : "String",
- "desc" : "The 6-digit color hex code (without the # symbol)",
+ "name" : "date",
+ "type" : "Date",
+ "desc" : "The selected date",
"isOptional" : false
}
],
}
]
},
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Gets the current selected value of the date field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Date",
+ "desc" : "The selected date"
+ }
+ ]
+ },
{
"name" : "hasListener",
"type" : "function",
"returns" : []
},
{
- "name" : "select",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Selects the specified color in the palette (fires the select event)",
- "sig" : "(color)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "color",
- "type" : "String",
- "desc" : "A valid 6-digit color hex code (# will be stripped if included)",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "setValue",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Sets the value of the date field",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "value",
+ "type" : "Date",
+ "desc" : "The date to set",
"isOptional" : false
}
],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.Component" : {
- "props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "css styles to add to component\neg. text-align:right;",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
+ "Roo.DialogManager" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "beforerender",
+ "name" : "bringToFront",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Brings the specified dialog to the front",
+ "sig" : "(dlg)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "dlg",
+ "type" : "String/Object",
+ "desc" : "The id of the dialog or a dialog",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.BasicDialog",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "destroy",
+ "name" : "get",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Gets a registered dialog by id",
+ "sig" : "(id)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "id",
+ "type" : "String/Object",
+ "desc" : "The id of the dialog or a dialog",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.BasicDialog",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "enable",
+ "name" : "hideAll",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Hides all dialogs",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "hide",
+ "name" : "sendToBack",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Sends the specified dialog to the back",
+ "sig" : "(dlg)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "dlg",
+ "type" : "String/Object",
+ "desc" : "The id of the dialog or a dialog",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.BasicDialog",
+ "desc" : "this"
}
- ],
- "returns" : []
- },
+ ]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.Document" : {
+ "props" : [
{
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
+ "events" : [],
"methods" : [
{
"name" : "addEvents",
],
"returns" : []
},
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
{
"name" : "fireEvent",
"type" : "function",
}
]
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
- }
- ]
- },
- {
- "name" : "getId",
- "type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
- },
{
"name" : "hasListener",
"type" : "function",
}
]
},
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
"returns" : []
},
{
- "name" : "render",
+ "name" : "un",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.DomHelper" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "append",
+ "type" : "function",
+ "desc" : "Creates new Dom element(s) and appends them to el",
+ "sig" : "(el, o, returnElement)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
+ "name" : "el",
"type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "desc" : "The context element",
+ "isOptional" : false
+ },
+ {
+ "name" : "o",
+ "type" : "Object/String",
+ "desc" : "The Dom object spec (and children) or raw HTML blob",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnElement",
+ "type" : "Boolean",
+ "desc" : "(optional) true to return a Roo.Element",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The new node"
+ }
+ ]
},
{
- "name" : "setDisabled",
+ "name" : "applyStyles",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Applies a style specification to an element",
+ "sig" : "(el, styles)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "el",
+ "type" : "String/HTMLElement",
+ "desc" : "The element to apply styles to",
+ "isOptional" : false
+ },
+ {
+ "name" : "styles",
+ "type" : "String/Object/Function",
+ "desc" : "A style specification string eg \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "createTemplate",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Creates a new Roo.DomHelper.Template from the Dom object spec",
+ "sig" : "(o)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The Dom object spec (and children)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.DomHelper.Template",
+ "desc" : "The new template"
}
]
},
{
- "name" : "show",
+ "name" : "insertAfter",
"type" : "function",
- "desc" : "Show this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Creates new Dom element(s) and inserts them after el",
+ "sig" : "(el, o, returnElement)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The context element",
+ "isOptional" : false
+ },
+ {
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The Dom object spec (and children)",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnElement",
+ "type" : "Boolean",
+ "desc" : "(optional) true to return a Roo.Element",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The new node"
}
]
},
{
- "name" : "un",
+ "name" : "insertBefore",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Creates new Dom element(s) and inserts them before el",
+ "sig" : "(el, o, returnElement)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The context element",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "o",
+ "type" : "Object/String",
+ "desc" : "The Dom object spec (and children) or raw HTML blob",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "returnElement",
+ "type" : "Boolean",
+ "desc" : "(optional) true to return a Roo.Element",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.BoxComponent",
- "Roo.CalendarPanel",
- "Roo.ColorPalette",
- "Roo.DatePicker",
- "Roo.Editor",
- "Roo.HtmlEditorCore",
- "Roo.bootstrap.Alert",
- "Roo.bootstrap.BezierSignature",
- "Roo.bootstrap.Body",
- "Roo.bootstrap.Brick",
- "Roo.bootstrap.Button",
- "Roo.bootstrap.ButtonGroup",
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.Calendar",
- "Roo.bootstrap.Card",
- "Roo.bootstrap.CardFooter",
- "Roo.bootstrap.CardHeader",
- "Roo.bootstrap.CardImageTop",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.Component",
- "Roo.bootstrap.Container",
- "Roo.bootstrap.DocumentManager",
- "Roo.bootstrap.DocumentSlider",
- "Roo.bootstrap.DocumentViewer",
- "Roo.bootstrap.DropTarget",
- "Roo.bootstrap.Element",
- "Roo.bootstrap.Graph",
- "Roo.bootstrap.Header",
- "Roo.bootstrap.Img",
- "Roo.bootstrap.LayoutMasonry",
- "Roo.bootstrap.LayoutMasonryAuto",
- "Roo.bootstrap.Link",
- "Roo.bootstrap.LocationPicker",
- "Roo.bootstrap.MasonryBrick",
- "Roo.bootstrap.MessageBar",
- "Roo.bootstrap.Modal",
- "Roo.bootstrap.Pagination",
- "Roo.bootstrap.PaginationItem",
- "Roo.bootstrap.PagingToolbar",
- "Roo.bootstrap.Popover",
- "Roo.bootstrap.PopoverNav",
- "Roo.bootstrap.Progress",
- "Roo.bootstrap.ProgressBar",
- "Roo.bootstrap.Row",
- "Roo.bootstrap.Slider",
- "Roo.bootstrap.TabGroup",
- "Roo.bootstrap.TabPanel",
- "Roo.bootstrap.Table",
- "Roo.bootstrap.TableBody",
- "Roo.bootstrap.TableCell",
- "Roo.bootstrap.TableRow",
- "Roo.bootstrap.UploadCropbox",
- "Roo.bootstrap.breadcrumb.Item",
- "Roo.bootstrap.breadcrumb.Nav",
- "Roo.bootstrap.dash.NumberBox",
- "Roo.bootstrap.dash.TabBox",
- "Roo.bootstrap.dash.TabPane",
- "Roo.bootstrap.form.CardUploader",
- "Roo.bootstrap.form.CheckBox",
- "Roo.bootstrap.form.ComboBox",
- "Roo.bootstrap.form.DateField",
- "Roo.bootstrap.form.DateSplitField",
- "Roo.bootstrap.form.FieldLabel",
- "Roo.bootstrap.form.Form",
- "Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.HtmlEditorToolbar.Standard",
- "Roo.bootstrap.form.Input",
- "Roo.bootstrap.form.Markdown",
- "Roo.bootstrap.form.MoneyField",
- "Roo.bootstrap.form.MonthField",
- "Roo.bootstrap.form.NumberField",
- "Roo.bootstrap.form.Password",
- "Roo.bootstrap.form.PhoneInput",
- "Roo.bootstrap.form.Radio",
- "Roo.bootstrap.form.RadioSet",
- "Roo.bootstrap.form.SecurePass",
- "Roo.bootstrap.form.TextArea",
- "Roo.bootstrap.form.TimeField",
- "Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.layout.Border",
- "Roo.bootstrap.layout.Manager",
- "Roo.bootstrap.menu.Item",
- "Roo.bootstrap.menu.Menu",
- "Roo.bootstrap.menu.Separator",
- "Roo.bootstrap.nav.Bar",
- "Roo.bootstrap.nav.Group",
- "Roo.bootstrap.nav.Headerbar",
- "Roo.bootstrap.nav.Item",
- "Roo.bootstrap.nav.ProgressBar",
- "Roo.bootstrap.nav.ProgressBarItem",
- "Roo.bootstrap.nav.Sidebar",
- "Roo.bootstrap.nav.SidebarItem",
- "Roo.bootstrap.nav.Simplebar",
- "Roo.dialog.UploadCropbox",
- "Roo.form.Checkbox",
- "Roo.form.Column",
- "Roo.form.ComboBox",
- "Roo.form.ComboBoxArray",
- "Roo.form.ComboBoxArray.Item",
- "Roo.form.ComboCheck",
- "Roo.form.ComboNested",
- "Roo.form.DateField",
- "Roo.form.DayPicker",
- "Roo.form.DisplayField",
- "Roo.form.FCKeditor",
- "Roo.form.Field",
- "Roo.form.FieldSet",
- "Roo.form.GridField",
- "Roo.form.Hidden",
- "Roo.form.HtmlEditor",
- "Roo.form.Layout",
- "Roo.form.MonthField",
- "Roo.form.NumberField",
- "Roo.form.Radio",
- "Roo.form.Row",
- "Roo.form.Select",
- "Roo.form.Signature",
- "Roo.form.TextArea",
- "Roo.form.TextField",
- "Roo.form.TextItem",
- "Roo.form.TriggerField",
- "Roo.grid.GridEditor",
- "Roo.menu.Adapter",
- "Roo.menu.BaseItem",
- "Roo.menu.CheckItem",
- "Roo.menu.ColorItem",
- "Roo.menu.DateItem",
- "Roo.menu.Item",
- "Roo.menu.Separator",
- "Roo.menu.TextItem",
- "Roo.tree.TreeEditor"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.ComponentMgr" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The new node"
+ }
+ ]
+ },
{
- "name" : "get",
+ "name" : "insertFirst",
"type" : "function",
- "desc" : "Returns a component by id",
- "sig" : "(id)",
+ "desc" : "Creates new Dom element(s) and inserts them as the first child of el",
+ "sig" : "(el, o, returnElement)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String",
- "desc" : "The component id",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The context element",
+ "isOptional" : false
+ },
+ {
+ "name" : "o",
+ "type" : "Object/String",
+ "desc" : "The Dom object spec (and children) or raw HTML blob",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnElement",
+ "type" : "Boolean",
+ "desc" : "(optional) true to return a Roo.Element",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The new node"
+ }
+ ]
},
{
- "name" : "onAvailable",
+ "name" : "insertHtml",
"type" : "function",
- "desc" : "Registers a function that will be called when a specified component is added to ComponentMgr",
- "sig" : "(id, fn, scope)",
+ "desc" : "Inserts an HTML fragment into the Dom",
+ "sig" : "(where, el, html)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
+ "name" : "where",
"type" : "String",
- "desc" : "The component id",
+ "desc" : "Where to insert the html in relation to el - beforeBegin, afterBegin, beforeEnd, afterEnd.",
"isOptional" : false
},
{
- "name" : "fn",
- "type" : "Funtction",
- "desc" : "The callback function",
+ "name" : "el",
+ "type" : "HTMLElement",
+ "desc" : "The context element",
"isOptional" : false
},
{
- "name" : "scope",
+ "name" : "html",
+ "type" : "String",
+ "desc" : "The HTML fragmenet",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "The new node"
+ }
+ ]
+ },
+ {
+ "name" : "markup",
+ "type" : "function",
+ "desc" : "Returns the markup for the passed Element(s) config",
+ "sig" : "(o)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
"type" : "Object",
- "desc" : "The scope of the callback",
+ "desc" : "The Dom object spec (and children)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "register",
+ "name" : "overwrite",
"type" : "function",
- "desc" : "Registers a component.",
- "sig" : "(c)",
+ "desc" : "Creates new Dom element(s) and overwrites the contents of el with them",
+ "sig" : "(el, o, returnElement)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "c",
- "type" : "Roo.Component",
- "desc" : "The component",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The context element",
+ "isOptional" : false
+ },
+ {
+ "name" : "o",
+ "type" : "Object/String",
+ "desc" : "The Dom object spec (and children) or raw HTML blob",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnElement",
+ "type" : "Boolean",
+ "desc" : "(optional) true to return a Roo.Element",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The new node"
+ }
+ ]
},
{
- "name" : "unregister",
+ "name" : "update",
"type" : "function",
- "desc" : "Unregisters a component.",
- "sig" : "(c)",
+ "desc" : "Updates the first element with the spec from the o (replacing if necessary)\nThis iterates through the children, and updates attributes / children etc..",
+ "sig" : "(el, o)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "c",
- "type" : "Roo.Component",
- "desc" : "The component",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The context element",
+ "isOptional" : false
+ },
+ {
+ "name" : "o",
+ "type" : "Object/String",
+ "desc" : "The Dom object spec (and children) or raw HTML blob",
"isOptional" : false
}
],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.CompositeElement" : {
+ "Roo.DomQuery" : {
"props" : [],
"events" : [],
"methods" : [
{
- "name" : "add",
+ "name" : "compile",
"type" : "function",
- "desc" : "Adds elements to this composite.",
- "sig" : "(els)",
+ "desc" : "Compiles a selector/xpath query into a reusable function. The returned function\ntakes one parameter \"root\" (optional), which is the context node from where the query should start.",
+ "sig" : "(selector, type)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "els",
- "type" : "String/Array",
- "desc" : "A string CSS selector, an array of elements or an element",
+ "name" : "selector",
+ "type" : "String",
+ "desc" : "The selector/xpath query",
+ "isOptional" : false
+ },
+ {
+ "name" : "type",
+ "type" : "String",
+ "desc" : "(optional) Either \"select\" (the default) or \"simple\" for a simple selector match",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "CompositeElement",
- "desc" : "this"
+ "type" : "Function",
+ "desc" : ""
}
]
},
{
- "name" : "clear",
+ "name" : "filter",
"type" : "function",
- "desc" : "Removes all elements.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "contains",
- "type" : "function",
- "desc" : "Returns true if this composite contains the passed element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "",
- "desc" : "Boolean"
- }
- ]
- },
- {
- "name" : "each",
- "type" : "function",
- "desc" : "Calls the passed function passing (el, this, index) for each element in this composite.",
- "sig" : "(fn, scope)",
+ "desc" : "Filters an array of elements to only include matches of a simple selector (e.g. div.some-class or span:first-child)",
+ "sig" : "(el, selector, nonMatches)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "el",
+ "type" : "Array",
+ "desc" : "An array of elements to filter",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The <i>this</i> object (defaults to the element)",
+ "name" : "selector",
+ "type" : "String",
+ "desc" : "The simple selector to test",
+ "isOptional" : false
+ },
+ {
+ "name" : "nonMatches",
+ "type" : "Boolean",
+ "desc" : "If true, it returns the elements that DON'T match\nthe selector instead of the ones that match",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "CompositeElement",
- "desc" : "this"
+ "type" : "Array",
+ "desc" : ""
}
]
},
{
- "name" : "fill",
+ "name" : "is",
"type" : "function",
- "desc" : "Clears this composite and adds the elements returned by the passed selector.",
- "sig" : "(els)",
+ "desc" : "Returns true if the passed element(s) match the passed simple selector (e.g. div.some-class or span:first-child)",
+ "sig" : "(el, selector)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "els",
- "type" : "String/Array",
- "desc" : "A string CSS selector, an array of elements or an element",
+ "name" : "el",
+ "type" : "String/HTMLElement/Array",
+ "desc" : "An element id, element or array of elements",
+ "isOptional" : false
+ },
+ {
+ "name" : "selector",
+ "type" : "String",
+ "desc" : "The simple selector to test",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "CompositeElement",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : ""
}
]
},
{
- "name" : "filter",
+ "name" : "select",
"type" : "function",
- "desc" : "Filters this composite to only elements that match the passed selector.",
- "sig" : "(selector, inverse)",
+ "desc" : "Selects a group of elements.",
+ "sig" : "(selector, root)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
{
"name" : "selector",
"type" : "String",
- "desc" : "A string CSS selector",
+ "desc" : "The selector/xpath query (can be a comma separated list of selectors)",
"isOptional" : false
},
{
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "return inverse filter (not matches)",
+ "name" : "root",
+ "type" : "Node",
+ "desc" : "(optional) The start of the query (defaults to document).",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "CompositeElement",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "first",
- "type" : "function",
- "desc" : "Returns the first Element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
+ "type" : "Array",
"desc" : ""
}
]
},
{
- "name" : "getCount",
- "type" : "function",
- "desc" : "Returns the number of elements in this composite",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "",
- "desc" : "Number"
- }
- ]
- },
- {
- "name" : "indexOf",
- "type" : "function",
- "desc" : "Returns true if this composite contains the passed element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "",
- "desc" : "Boolean"
- }
- ]
- },
- {
- "name" : "item",
+ "name" : "selectNode",
"type" : "function",
- "desc" : "Returns the Element object at the specified index",
- "sig" : "(index)",
+ "desc" : "Selects a single element.",
+ "sig" : "(selector, root)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "",
+ "name" : "selector",
+ "type" : "String",
+ "desc" : "The selector/xpath query",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : ""
+ "name" : "root",
+ "type" : "Node",
+ "desc" : "(optional) The start of the query (defaults to document).",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "last",
- "type" : "function",
- "desc" : "Returns the last Element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
+ "type" : "Element",
"desc" : ""
}
]
},
{
- "name" : "removeElement",
+ "name" : "selectNumber",
"type" : "function",
- "desc" : "Removes the specified element(s).",
- "sig" : "(el, removeDom)",
+ "desc" : "Selects the value of a node, parsing integers and floats.",
+ "sig" : "(selector, root, defaultValue)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "Mixed",
- "desc" : "The id of an element, the Element itself, the index of the element in this composite\nor an array of any of those.",
+ "name" : "selector",
+ "type" : "String",
+ "desc" : "The selector/xpath query",
"isOptional" : false
},
{
- "name" : "removeDom",
- "type" : "Boolean",
- "desc" : "(optional) True to also remove the element from the document",
+ "name" : "root",
+ "type" : "Node",
+ "desc" : "(optional) The start of the query (defaults to document).",
+ "isOptional" : false
+ },
+ {
+ "name" : "defaultValue",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "CompositeElement",
- "desc" : "this"
+ "type" : "Number",
+ "desc" : ""
}
]
},
{
- "name" : "replaceElement",
+ "name" : "selectValue",
"type" : "function",
- "desc" : "Replaces the specified element with the passed element.",
- "sig" : "(el, replacement, domReplace)",
+ "desc" : "Selects the value of a node, optionally replacing null with the defaultValue.",
+ "sig" : "(selector, root, defaultValue)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element/Number",
- "desc" : "The id of an element, the Element itself, the index of the element in this composite\nto replace.",
+ "name" : "selector",
+ "type" : "String",
+ "desc" : "The selector/xpath query",
"isOptional" : false
},
{
- "name" : "replacement",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id of an element or the Element itself.",
+ "name" : "root",
+ "type" : "Node",
+ "desc" : "(optional) The start of the query (defaults to document).",
"isOptional" : false
},
{
- "name" : "domReplace",
- "type" : "Boolean",
- "desc" : "True to remove and replace the element in the document too.",
+ "name" : "defaultValue",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "CompositeElement",
- "desc" : "this"
- }
- ]
+ "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.CompositeElementLite"
- ],
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.CompositeElementLite" : {
- "props" : [],
+ "Roo.DomTemplate" : {
+ "props" : [
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "The HTML fragment or an array of fragments to join(\"\") or multiple arguments to join(\"\")",
+ "memberOf" : "Roo.Template",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "onLoad",
+ "type" : "Function",
+ "desc" : "Called after the template has been loaded and complied (usually from a remove source)",
+ "memberOf" : "Roo.Template",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "url",
+ "type" : "String",
+ "desc" : "The Url to load the template from. beware if you are loading from a url, the data may not be ready if you use it instantly..\n it should be fixed so that template is observable...",
+ "memberOf" : "Roo.Template",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
"events" : [],
"methods" : [
{
- "name" : "add",
+ "name" : "append",
"type" : "function",
- "desc" : "Adds elements to this composite.",
- "sig" : "(els)",
+ "desc" : "Applies the supplied values to the template and appends the new node(s) to el.",
+ "sig" : "(el, values, returnElement)",
"static" : false,
- "memberOf" : "Roo.CompositeElement",
+ "memberOf" : "Roo.Template",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "els",
- "type" : "String/Array",
- "desc" : "A string CSS selector, an array of elements or an element",
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The context element",
+ "isOptional" : false
+ },
+ {
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnElement",
+ "type" : "Boolean",
+ "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "CompositeElement",
- "desc" : "this"
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The new node or Element"
}
]
},
{
- "name" : "clear",
+ "name" : "apply",
"type" : "function",
- "desc" : "Removes all elements.",
+ "desc" : "Alias for {@link #applyTemplate}",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.CompositeElement",
+ "memberOf" : "Roo.Template",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "contains",
- "type" : "function",
- "desc" : "Returns true if this composite contains the passed element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.CompositeElement",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "",
- "desc" : "Boolean"
- }
- ]
- },
- {
- "name" : "each",
+ "name" : "applySubTemplate",
"type" : "function",
- "desc" : "Calls the passed function passing (el, this, index) for each element in this composite. <b>The element\npassed is the flyweight (shared) Roo.Element instance, so if you require a\na reference to the dom node, use el.dom.</b>",
- "sig" : "(fn, scope)",
+ "desc" : "same as applyTemplate, except it's done to one of the subTemplates\nwhen using named templates, you can do:\n\nvar str = pl.applySubTemplate('your-name', values);",
+ "sig" : "(id, values, parent)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "id",
+ "type" : "Number",
+ "desc" : "of the template",
"isOptional" : false
},
{
- "name" : "scope",
+ "name" : "values",
"type" : "Object",
- "desc" : "(optional) The <i>this</i> object (defaults to the element)",
+ "desc" : "to apply to template",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "CompositeElement",
- "desc" : "this"
+ "name" : "parent",
+ "type" : "Object",
+ "desc" : "(normaly the instance of this object)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "fill",
+ "name" : "applyTemplate",
"type" : "function",
- "desc" : "Clears this composite and adds the elements returned by the passed selector.",
- "sig" : "(els)",
+ "desc" : "Returns an HTML fragment of this template with the specified values applied.",
+ "sig" : "(values)",
"static" : false,
- "memberOf" : "Roo.CompositeElement",
+ "memberOf" : "Roo.Template",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "els",
- "type" : "String/Array",
- "desc" : "A string CSS selector, an array of elements or an element",
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "CompositeElement",
- "desc" : "this"
+ "type" : "String",
+ "desc" : "The HTML fragment"
}
]
},
{
- "name" : "filter",
+ "name" : "compile",
"type" : "function",
- "desc" : "Filters this composite to only elements that match the passed selector.",
- "sig" : "(selector, inverse)",
+ "desc" : "compile the template\n\nThis is not recursive, so I'm not sure how nested templates are really going to be handled..",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.CompositeElement",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "selector",
- "type" : "String",
- "desc" : "A string CSS selector",
- "isOptional" : false
- },
- {
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "return inverse filter (not matches)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "CompositeElement",
- "desc" : "this"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "first",
+ "name" : "compileTpl",
"type" : "function",
- "desc" : "Returns the first Element",
+ "desc" : "Compile a segment of the template into a 'sub-template'",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.CompositeElement",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getCount",
+ "name" : "from",
"type" : "function",
- "desc" : "Returns the number of elements in this composite",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.CompositeElement",
- "isStatic" : false,
+ "desc" : "Creates a template from the passed element's value (<i>display:none</i> textarea, preferred) or innerHTML.",
+ "sig" : "(el)",
+ "static" : true,
+ "memberOf" : "Roo.Template",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "",
- "desc" : "Number"
+ "name" : "el",
+ "type" : "String/HTMLElement",
+ "desc" : "A DOM element or its id",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "indexOf",
+ "name" : "insertAfter",
"type" : "function",
- "desc" : "Returns true if this composite contains the passed element",
- "sig" : "()\n{\n\n}",
+ "desc" : "Applies the supplied values to the template and inserts the new node(s) after el.",
+ "sig" : "(el, values, returnElement)",
"static" : false,
- "memberOf" : "Roo.CompositeElement",
+ "memberOf" : "Roo.Template",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The context element",
+ "isOptional" : false
+ },
+ {
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnElement",
+ "type" : "Boolean",
+ "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "",
- "desc" : "Boolean"
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The new node or Element"
}
]
},
{
- "name" : "item",
+ "name" : "insertBefore",
"type" : "function",
- "desc" : "Returns a flyweight Element of the dom element object at the specified index",
- "sig" : "(index)",
+ "desc" : "Applies the supplied values to the template and inserts the new node(s) before el.",
+ "sig" : "(el, values, returnElement)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Template",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "",
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The context element",
+ "isOptional" : false
+ },
+ {
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnElement",
+ "type" : "Boolean",
+ "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : ""
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The new node or Element"
}
]
},
{
- "name" : "last",
+ "name" : "insertFirst",
"type" : "function",
- "desc" : "Returns the last Element",
- "sig" : "()\n{\n\n}",
+ "desc" : "Applies the supplied values to the template and inserts the new node(s) as the first child of el.",
+ "sig" : "(el, values, returnElement)",
"static" : false,
- "memberOf" : "Roo.CompositeElement",
+ "memberOf" : "Roo.Template",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The context element",
+ "isOptional" : false
+ },
+ {
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnElement",
+ "type" : "Boolean",
+ "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : ""
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The new node or Element"
}
]
},
{
- "name" : "removeElement",
+ "name" : "overwrite",
"type" : "function",
- "desc" : "Removes the specified element(s).",
- "sig" : "(el, removeDom)",
+ "desc" : "Applies the supplied values to the template and overwrites the content of el with the new node(s).",
+ "sig" : "(el, values, returnElement)",
"static" : false,
- "memberOf" : "Roo.CompositeElement",
+ "memberOf" : "Roo.Template",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [
{
"name" : "el",
- "type" : "Mixed",
- "desc" : "The id of an element, the Element itself, the index of the element in this composite\nor an array of any of those.",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The context element",
"isOptional" : false
},
{
- "name" : "removeDom",
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnElement",
"type" : "Boolean",
- "desc" : "(optional) True to also remove the element from the document",
+ "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "CompositeElement",
- "desc" : "this"
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The new node or Element"
}
]
},
{
- "name" : "replaceElement",
+ "name" : "set",
"type" : "function",
- "desc" : "Replaces the specified element with the passed element.",
- "sig" : "(el, replacement, domReplace)",
+ "desc" : "Sets the HTML used as the template and optionally compiles it.",
+ "sig" : "(html, compile)",
"static" : false,
- "memberOf" : "Roo.CompositeElement",
+ "memberOf" : "Roo.Template",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element/Number",
- "desc" : "The id of an element, the Element itself, the index of the element in this composite\nto replace.",
- "isOptional" : false
- },
- {
- "name" : "replacement",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id of an element or the Element itself.",
+ "name" : "html",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "domReplace",
+ "name" : "compile",
"type" : "Boolean",
- "desc" : "True to remove and replace the element in the document too.",
+ "desc" : "(optional) True to compile the template (defaults to undefined)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "CompositeElement",
+ "type" : "Roo.Template",
"desc" : "this"
}
]
"tree_children" : [],
"tree_parent" : []
},
- "Roo.ContentPanel" : {
+ "Roo.Editor" : {
"props" : [
{
- "name" : "adjustments",
- "type" : "Array",
- "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
- "memberOf" : "",
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "autoCreate",
- "type" : "Boolean|Object",
- "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
+ "name" : "alignment",
+ "type" : "String",
+ "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details, defaults to \"c-c?\").",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "autoScroll",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
- "memberOf" : "",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "background",
- "type" : "Boolean",
- "desc" : "True if the panel should not be activated when it is added (defaults to false)",
+ "name" : "autosize",
+ "type" : "Boolean/String",
+ "desc" : "True for the editor to automatically adopt the size of the underlying field, \"width\" to adopt the width only,\nor \"height\" to adopt the height only (defaults to false)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "closable",
+ "name" : "cancelOnEsc",
"type" : "Boolean",
- "desc" : "True if the panel can be closed/removed",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "content",
- "type" : "String",
- "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
+ "desc" : "True to cancel the edit when the escape key is pressed (defaults to false)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "fitContainer",
+ "name" : "completeOnEnter",
"type" : "Boolean",
- "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
+ "desc" : "True to complete the edit when the enter key is pressed (defaults to false)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "fitToFrame",
+ "name" : "constrain",
"type" : "Boolean",
- "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
+ "desc" : "True to constrain the editor to the viewport",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "loadOnce",
+ "name" : "hideEl",
"type" : "Boolean",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "desc" : "False to keep the bound element visible while the editor is displayed (defaults to true)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "menu",
- "type" : "Roo.menu.Menu",
- "desc" : "popup menu",
- "memberOf" : "",
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "params",
- "type" : "String|Object",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "name" : "ignoreNoChange",
+ "type" : "Boolean",
+ "desc" : "True to skip the the edit completion process (no save, no events fired) if the user completes an edit and\nthe value has not changed (defaults to false). Applies only to string values - edits for other data types\nwill never be ignored.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "region",
- "type" : "String",
- "desc" : "t) which region to put this panel on (when used with xtype constructor",
- "memberOf" : "",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
"isOptional" : false,
- "optvals" : [
- "center",
- "north",
- "south",
- "east",
- "west"
- ]
+ "optvals" : []
},
{
- "name" : "resizeEl",
- "type" : "String|HTMLElement|Element",
- "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
+ "name" : "revertInvalid",
+ "type" : "Boolean",
+ "desc" : "True to automatically revert the field value and cancel the edit when the user completes an edit and the field\nvalidation fails (defaults to true)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "Extra style to add to the content panel",
+ "name" : "shadow",
+ "type" : "Boolean/String",
+ "desc" : "\"sides\" for sides/bottom only, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"frame\")",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "title",
+ "name" : "style",
"type" : "String",
- "desc" : "The title for this panel",
- "memberOf" : "",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "toolbar",
- "type" : "Roo.Toolbar",
- "desc" : "A toolbar for this panel",
+ "name" : "updateEl",
+ "type" : "Boolean",
+ "desc" : "True to update the innerHTML of the bound element when the update completes (defaults to false)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "url",
- "type" : "String",
- "desc" : "Calls {@link #setUrl} with this value",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The data value of the underlying field (defaults to \"\")",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
],
"events" : [
{
- "name" : "activate",
+ "name" : "beforecomplete",
"type" : "function",
- "desc" : "Fires when this panel is activated.",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Fires after a change has been made to the field, but before the change is reflected in the underlying\nfield. Saving the change to the field can be canceled by returning false from the handler of this event.\nNote that if the value has not changed and ignoreNoChange = true, the editing will still end but this\nevent will not fire since no edit actually occurred.",
+ "sig" : "function (_self, value, startValue)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.ContentPanel",
+ "type" : "Editor",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The current field value",
+ "isOptional" : false
+ },
+ {
+ "name" : "startValue",
+ "type" : "Mixed",
+ "desc" : "The original field value",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "deactivate",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fires when this panel is activated.",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.ContentPanel",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "render",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Fires when this tab is created",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.ContentPanel",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "resize",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires when this panel is resized if fitToFrame is true.",
- "sig" : "function (_self, width, height)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.ContentPanel",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The width after any component adjustments",
- "isOptional" : false
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "The height after any component adjustments",
- "isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "addEvents",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "beforestartedit",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when editing is initiated, but before the value changes. Editing can be canceled by returning\nfalse from the handler of this event.",
+ "sig" : "function (_self, boundEl, value)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "this",
+ "type" : "Editor",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "boundEl",
+ "type" : "Roo.Element",
+ "desc" : "The underlying element bound to this editor",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The field value being set",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addxtype",
+ "name" : "complete",
"type" : "function",
- "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'Form',\n items: [ .... ]\n }\n);\n\n</code></pre>",
- "sig" : "(cfg)",
- "static" : false,
+ "desc" : "Fires after editing is complete and any changed value has been written to the underlying field.",
+ "sig" : "function (_self, value, startValue)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "cfg",
- "type" : "Object",
- "desc" : "Xtype definition of item to add.",
+ "name" : "this",
+ "type" : "Editor",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The current field value",
+ "isOptional" : false
+ },
+ {
+ "name" : "startValue",
+ "type" : "Mixed",
+ "desc" : "The original field value",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "disable",
"type" : "function",
- "desc" : "Destroys this panel",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
},
{
- "name" : "getEl",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns this panel's element - used by regiosn to add.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : ""
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "startedit",
+ "type" : "function",
+ "desc" : "Fires when this editor is displayed",
+ "sig" : "function (boundEl, value)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "boundEl",
+ "type" : "Roo.Element",
+ "desc" : "The underlying element bound to this editor",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The starting field value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "cancelEdit",
+ "type" : "function",
+ "desc" : "Cancels the editing process and hides the editor without persisting any changes. The field value will be\nreverted to the original starting value.",
+ "sig" : "(remainVisible)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "remainVisible",
+ "type" : "Boolean",
+ "desc" : "Override the default behavior and keep the editor visible after\ncancel (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "capture",
+ "type" : "function",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "completeEdit",
+ "type" : "function",
+ "desc" : "Ends the editing process, persists the changed value to the underlying field, and hides the editor.",
+ "sig" : "(remainVisible)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "remainVisible",
+ "type" : "Boolean",
+ "desc" : "Override the default behavior and keep the editor visible after edit (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getId",
+ "name" : "enable",
"type" : "function",
- "desc" : "Returns this panel's id",
+ "desc" : "Enable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "fireEvent",
+ "type" : "function",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
"type" : "String",
- "desc" : ""
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "getTitle",
+ "name" : "focus",
"type" : "function",
- "desc" : "Returns this panel's title",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "getToolbar",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns the toolbar for this Panel if one was configured.",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Toolbar",
+ "type" : "String",
"desc" : ""
}
]
},
{
- "name" : "getUpdateManager",
+ "name" : "getValue",
"type" : "function",
- "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
+ "desc" : "Gets the data value of the editor",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : [
{
"name" : "",
- "type" : "Roo.UpdateManager",
- "desc" : "The UpdateManager"
+ "type" : "Mixed",
+ "desc" : "The data value"
}
]
},
]
},
{
- "name" : "isClosable",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns true is this panel was configured to be closable",
+ "desc" : "Hide this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "load",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.",
- "sig" : "(url, params, callback, discardUrl)",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "url",
- "type" : "Object/String/Function",
- "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\npanel.load({\n url: \"your-url.php\",\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n callback: yourFunction,\n scope: yourObject, //(optional scope)\n discardUrl: false,\n nocache: false,\n text: \"Loading...\",\n timeout: 30,\n scripts: false\n});\n</code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
- "isOptional" : false
- },
- {
- "name" : "discardUrl",
- "type" : "Boolean",
- "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "this"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
"name" : "on",
"returns" : []
},
{
- "name" : "refresh",
+ "name" : "realign",
"type" : "function",
- "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
+ "desc" : "Realigns the editor to the bound field based on the current alignment config value.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : []
},
{
- "name" : "setContent",
+ "name" : "render",
"type" : "function",
- "desc" : "Updates this panel's element",
- "sig" : "(content, loadScripts)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "content",
- "type" : "String",
- "desc" : "The new content",
- "isOptional" : false
- },
- {
- "name" : "loadScripts",
- "type" : "Boolean",
- "desc" : "(optional) true to look for and process scripts",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setTitle",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Set this panel's title",
- "sig" : "(title)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "title",
- "type" : "String",
+ "name" : "disabled",
+ "type" : "Boolean",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "setUrl",
+ "name" : "setSize",
"type" : "function",
- "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
- "sig" : "(url, params, loadOnce)",
+ "desc" : "Sets the height and width of this editor.",
+ "sig" : "(width, height)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "url",
- "type" : "String/Function",
- "desc" : "The URL to load the content from or a function to call to get the URL",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The new width",
"isOptional" : false
},
{
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets the data value of the editor",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "loadOnce",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "Any valid value supported by the underlying field",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "visible",
"type" : "Boolean",
- "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.UpdateManager",
- "desc" : "The UpdateManager"
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
+ {
+ "name" : "startEdit",
+ "type" : "function",
+ "desc" : "Starts the editing process and shows the editor.",
+ "sig" : "(el, value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The element to edit",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "(optional) A value to initialize the editor with. If a value is not provided, it defaults\nto the innerHTML of el.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "un",
"type" : "function",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [
- "Roo.GridPanel",
- "Roo.NestedLayoutPanel",
- "Roo.TreePanel"
- ],
- "tree_children" : [
- "Roo.form.Form",
- "Roo.JsonView",
- "Roo.View",
- "Roo.JsonView"
+ "Roo.grid.GridEditor",
+ "Roo.tree.TreeEditor"
],
- "tree_parent" : [
- "Roo.BorderLayout",
- "Roo.LayoutDialog",
- "builder"
- ]
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.DDView" : {
- "props" : [
- {
- "name" : "allowCopy",
- "type" : "Boolean",
- "desc" : "Causes ctrl/drag operations to copy nodes rather than move.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "copy",
- "type" : "Boolean",
- "desc" : "Causes drag operations to copy nodes rather than move.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "dragGroup",
- "type" : "String/Array",
- "desc" : "The ddgroup name(s) for the View's DragZone.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "dropGroup",
- "type" : "String/Array",
- "desc" : "The ddgroup name(s) for the View's DropZone.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
+ "Roo.Element" : {
+ "props" : [],
"events" : [],
"methods" : [
{
- "name" : "getContextMenu",
+ "name" : "addClass",
"type" : "function",
- "desc" : "Return the context menu for this DDView.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out.",
+ "sig" : "(className)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "className",
+ "type" : "String/Array",
+ "desc" : "The CSS class to add, or an array of classes",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "getDragData",
+ "name" : "addClassOnClick",
"type" : "function",
- "desc" : "Create the drag data which consists of an object which has the property \"ddel\" as\n\tthe drag proxy element.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets up event handlers to add and remove a css class when the mouse is down and then up on this element (a click effect)",
+ "sig" : "(className)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "className",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "getDropPoint",
+ "name" : "addClassOnFocus",
"type" : "function",
- "desc" : "Decide whether to drop above or below a View node.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets up event handlers to add and remove a css class when this element has the focus",
+ "sig" : "(className)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "className",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "getName",
+ "name" : "addClassOnOver",
"type" : "function",
- "desc" : "Allows this class to be an Roo.form.Field so it can be found using {@link Roo.form.BasicForm#findField}.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets up event handlers to add and remove a css class when the mouse is over this element",
+ "sig" : "(className, preventFlicker)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "className",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "preventFlicker",
+ "type" : "Boolean",
+ "desc" : "(optional) If set to true, it prevents flickering by filtering\nmouseout events for children elements",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "getTargetFromEvent",
+ "name" : "addKeyListener",
"type" : "function",
- "desc" : "Part of the Roo.dd.DropZone interface. If no target node is found, the\n\twhole Element becomes the target, and this causes the drop gesture to append.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Convenience method for constructing a KeyMap",
+ "sig" : "(key, fn, scope)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "key",
+ "type" : "Number/Array/Object/String",
+ "desc" : "Either a string with the keys to listen for, the numeric key code, array of key codes or an object with the following options:\n {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the function",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.KeyMap",
+ "desc" : "The KeyMap created"
+ }
+ ]
},
{
- "name" : "getValue",
+ "name" : "addKeyMap",
"type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
+ "desc" : "Creates a KeyMap for this element",
+ "sig" : "(config)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The KeyMap config. See {@link Roo.KeyMap} for more details",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "a parenthesised list of the ids of the Records in the View."
+ "type" : "Roo.KeyMap",
+ "desc" : "The KeyMap created"
}
]
},
{
- "name" : "onDblClick",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Double click fires the event, but also, if this is draggable, and there is only one other\n\trelated DropZone, it transfers the selected node.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Appends an event handler",
+ "sig" : "(eventName, fn, scope, options)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to append",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) of the fn",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)An object with standard {@link Roo.EventManager#addListener} options",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "alignTo",
"type" : "function",
- "desc" : "Remove {@link Roo.data.Record}s at the specified indices.",
- "sig" : "(selectedIndices)",
+ "desc" : "Aligns this element with another element relative to the specified anchor points. If the other element is the\ndocument it aligns it to the viewport.\nThe position parameter is optional, and can be specified in any one of the following formats:\n<ul>\n <li><b>Blank</b>: Defaults to aligning the element's top-left corner to the target's bottom-left corner (\"tl-bl\").</li>\n <li><b>One anchor (deprecated)</b>: The passed anchor position is used as the target element's anchor point.\n The element being aligned will position its top-left corner (tl) to that point. <i>This method has been\n deprecated in favor of the newer two anchor syntax below</i>.</li>\n <li><b>Two anchors</b>: If two values from the table below are passed separated by a dash, the first value is used as the\n element's anchor point, and the second value is used as the target's anchor point.</li>\n</ul>\nIn addition to the anchor points, the position parameter also supports the \"?\" character. If \"?\" is passed at the end of\nthe position string, the element will attempt to align as specified, but the position will be adjusted to constrain to\nthe viewport if necessary. Note that the element being aligned might be swapped to align to a different position than\nthat specified in order to enforce the viewport constraints.\nFollowing are all of the supported anchor positions:\n <pre>\n Value Description\n ----- -----------------------------\n tl The top left corner (default)\n t The center of the top edge\n tr The top right corner\n l The center of the left edge\n c In the center of the element\n r The center of the right edge\n bl The bottom left corner\n b The center of the bottom edge\n br The bottom right corner\n </pre>\n Example Usage:\n <pre><code>\n // align el to other-el using the default positioning (\"tl-bl\", non-constrained)\n el.alignTo(\"other-el\");\n\n // align the top left corner of el with the top right corner of other-el (constrained to viewport)\n el.alignTo(\"other-el\", \"tr?\");\n\n // align the bottom right corner of el with the center left edge of other-el\n el.alignTo(\"other-el\", \"br-l?\");\n\n // align the center of el with the bottom left corner of other-el and\n // adjust the x position by -6 pixels (and the y position by 0)\n el.alignTo(\"other-el\", \"c-bl\", [-6, 0]);\n </code></pre>",
+ "sig" : "(element, position, offsets, animate)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "selectedIndices",
- "type" : "Array/Number",
- "desc" : "The index (or Array of indices) of Records to remove.",
+ "name" : "element",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element to align to.",
+ "isOptional" : false
+ },
+ {
+ "name" : "position",
+ "type" : "String",
+ "desc" : "The position to align to.",
+ "isOptional" : false
+ },
+ {
+ "name" : "offsets",
+ "type" : "Array",
+ "desc" : "(optional) Offset the positioning by [x, y]",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "setDeletable",
+ "name" : "anchorTo",
"type" : "function",
- "desc" : "Utility method. Add a delete option to the DDView's context menu.",
- "sig" : "(imageUrl)",
+ "desc" : "Anchors an element to another element and realigns it when the window is resized.",
+ "sig" : "(element, position, offsets, animate, monitorScroll, callback)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "imageUrl",
+ "name" : "element",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element to align to.",
+ "isOptional" : false
+ },
+ {
+ "name" : "position",
"type" : "String",
- "desc" : "The URL of the \"delete\" icon image.",
+ "desc" : "The position to align to.",
+ "isOptional" : false
+ },
+ {
+ "name" : "offsets",
+ "type" : "Array",
+ "desc" : "(optional) Offset the positioning by [x, y]",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) True for the default animation or a standard Element animation config object",
+ "isOptional" : false
+ },
+ {
+ "name" : "monitorScroll",
+ "type" : "Boolean/Number",
+ "desc" : "(optional) True to monitor body scroll and reposition. If this parameter\nis a number, it is used as the buffer delay (defaults to 50ms).",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "The function to call after the animation finishes",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "setDraggable",
+ "name" : "animate",
"type" : "function",
- "desc" : "Specify to which ddGroup items in this DDView may be dragged.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Perform animation on this element.",
+ "sig" : "(args, duration, onComplete, easing, animType)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "args",
+ "type" : "Object",
+ "desc" : "The YUI animation control args",
+ "isOptional" : false
+ },
+ {
+ "name" : "duration",
+ "type" : "Float",
+ "desc" : "(optional) How long the animation lasts in seconds (defaults to .35)",
+ "isOptional" : false
+ },
+ {
+ "name" : "onComplete",
+ "type" : "Function",
+ "desc" : "(optional) Function to call when animation completes",
+ "isOptional" : false
+ },
+ {
+ "name" : "easing",
+ "type" : "String",
+ "desc" : "(optional) Easing method to use (defaults to 'easeOut')",
+ "isOptional" : false
+ },
+ {
+ "name" : "animType",
+ "type" : "String",
+ "desc" : "(optional) 'run' is the default. Can also be 'color', 'motion', or 'scroll'",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "setDroppable",
+ "name" : "appendChild",
"type" : "function",
- "desc" : "Specify from which ddGroup this DDView accepts drops.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Appends the passed element(s) to this element",
+ "sig" : "(el)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Array/Element/CompositeElement",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "setValue",
+ "name" : "appendTo",
"type" : "function",
- "desc" : "Loads the View from a JSON string representing the Records to put into the Store.",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "desc" : "Appends this element to the passed element",
+ "sig" : "(el)",
+ "static" : false,
"memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.DatePicker" : {
- "props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cancelText",
- "type" : "String",
- "desc" : "The text to display on the cancel button",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "constrainToViewport",
- "type" : "Boolean",
- "desc" : "True to constrain the date picker to the viewport (defaults to true)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "dayNames",
- "type" : "Array",
- "desc" : "An array of textual day names which can be overriden for localization support (defaults to Date.dayNames)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabledDatesRE",
- "type" : "RegExp",
- "desc" : "JavaScript regular expression used to disable a pattern of dates (defaults to null)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabledDatesText",
- "type" : "String",
- "desc" : "The tooltip text to display when the date falls on a disabled date (defaults to \"\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabledDays",
- "type" : "Array",
- "desc" : "An array of days to disable, 0-based. For example, [0, 6] disables Sunday and Saturday (defaults to null).",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabledDaysText",
- "type" : "String",
- "desc" : "The tooltip to display when the date falls on a disabled day (defaults to \"\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "format",
- "type" : "String",
- "desc" : "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxDate",
- "type" : "Date",
- "desc" : "Maximum allowable date (JavaScript date object, defaults to null)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxText",
- "type" : "String",
- "desc" : "The error text to display if the maxDate validation fails (defaults to \"This date is after the maximum date\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minDate",
- "type" : "Date",
- "desc" : "Minimum allowable date (JavaScript date object, defaults to null)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minText",
- "type" : "String",
- "desc" : "The error text to display if the minDate validation fails (defaults to \"This date is before the minimum date\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "monthNames",
- "type" : "Array",
- "desc" : "An array of textual month names which can be overriden for localization support (defaults to Date.monthNames)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "monthYearText",
- "type" : "String",
- "desc" : "The header month selector tooltip (defaults to 'Choose a month (Control+Up/Down to move years)')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "nextText",
- "type" : "String",
- "desc" : "The next month navigation button tooltip (defaults to 'Next Month (Control+Right)')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "okText",
- "type" : "String",
- "desc" : "The text to display on the ok button",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "prevText",
- "type" : "String",
- "desc" : "The previous month navigation button tooltip (defaults to 'Previous Month (Control+Left)')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "showClear",
- "type" : "Bool",
- "desc" : "Show a clear button (usefull for date form elements that can be blank.)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "startDay",
- "type" : "Number",
- "desc" : "Day index at which the week should begin, 0-based (defaults to 0, which is Sunday)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "css styles to add to component\neg. text-align:right;",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "todayText",
- "type" : "String",
- "desc" : "The text to display on the button that selects the current date (defaults to \"Today\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "todayTip",
- "type" : "String",
- "desc" : "The tooltip to display for the button that selects the current date (defaults to \"{current date} (Spacebar)\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The new parent element",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "beforerender",
+ "name" : "applyStyles",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "More flexible version of {@link #setStyle} for setting style properties.",
+ "sig" : "(styles)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "styles",
+ "type" : "String/Object/Function",
+ "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "destroy",
+ "name" : "attr",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Sets or Returns the value the dom attribute value",
+ "sig" : "(name, value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "name",
+ "type" : "String|Object",
+ "desc" : "The attribute name (or object to set multiple attributes)",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "value",
+ "type" : "String",
+ "desc" : "(optional) The value to set the attribute to",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "The attribute value"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "hide",
+ "name" : "autoHeight",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Measures the element's content height and updates height to match. Note: this function uses setTimeout so\nthe new height may not be available immediately.",
+ "sig" : "(animate, duration, onComplete, easing)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "animate",
+ "type" : "Boolean",
+ "desc" : "(optional) Animate the transition (defaults to false)",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "monthchange",
- "type" : "function",
- "desc" : "Fires when the displayed month changes",
- "sig" : "function (_self, date)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "DatePicker",
- "desc" : "",
+ "name" : "duration",
+ "type" : "Float",
+ "desc" : "(optional) Length of the animation in seconds (defaults to .35)",
"isOptional" : false
},
{
- "name" : "date",
- "type" : "Date",
- "desc" : "The selected month",
+ "name" : "onComplete",
+ "type" : "Function",
+ "desc" : "(optional) Function to call when animation completes",
+ "isOptional" : false
+ },
+ {
+ "name" : "easing",
+ "type" : "String",
+ "desc" : "(optional) Easing method to use (defaults to easeOut)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "render",
+ "name" : "beginMeasure",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Temporarily enables offsets (width,height,x,y) for an element with display:none, use endMeasure() when done.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "select",
+ "name" : "blur",
"type" : "function",
- "desc" : "Fires when a date is selected",
- "sig" : "function (_self, date)\n{\n\n}",
+ "desc" : "Tries to blur the element. Any exceptions are caught and ignored.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "DatePicker",
- "desc" : "",
- "isOptional" : false
- },
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "date",
- "type" : "Date",
- "desc" : "The selected date",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "show",
+ "name" : "boxWrap",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Wraps the specified element with a special markup/CSS block that renders by default as a gray container with a\ngradient background, rounded corners and a 4-way shadow.",
+ "sig" : "(class)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "class",
+ "type" : "String",
+ "desc" : "(optional) A base CSS class to apply to the containing wrapper element (defaults to 'x-box').\nNote that there are a number of CSS rules that are dependent on this name to make the overall effect work,\nso if you supply an alternate base class, make sure you also supply all of the necessary rules.",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "methods" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
{
- "name" : "addEvents",
+ "name" : "center",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Centers the Element in either the viewport, or another Element.",
+ "sig" : "(centerIn)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "centerIn",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "(optional) The element in which to center the element.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "child",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Selects a single child at any depth below this element based on the passed CSS selector (the selector should not contain an id).",
+ "sig" : "(selector, returnDom)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "selector",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "desc" : "The CSS selector",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "returnDom",
+ "type" : "Boolean",
+ "desc" : "(optional) True to return the DOM node instead of Roo.Element (defaults to false)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The child Roo.Element (or DOM node if returnDom = true)"
+ }
+ ]
},
{
- "name" : "capture",
+ "name" : "clean",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Removes worthless text nodes",
+ "sig" : "(forceReclean)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "forceReclean",
+ "type" : "Boolean",
+ "desc" : "(optional) By default the element\nkeeps track if it has been cleaned already so\nyou can call this over and over. However, if you update the element and\nneed to force a reclean, you can pass true.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "clearOpacity",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "desc" : "Clears any opacity settings from this element. Required in some cases for IE.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "disable",
+ "name" : "clearPositioning",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Clear positioning back to the default when the document was loaded",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "(optional) The value to use for the left,right,top,bottom, defaults to '' (empty string). You could use 'auto'.",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
+ "type" : "Roo.Element",
"desc" : "this"
}
]
},
{
- "name" : "enable",
+ "name" : "clip",
"type" : "function",
- "desc" : "Enable this component.",
+ "desc" : "Store the current overflow setting and clip overflow on the element - use {@link #unclip} to remove",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
+ "type" : "Roo.Element",
"desc" : "this"
}
]
},
{
- "name" : "fireEvent",
+ "name" : "contains",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Returns true if this element is an ancestor of the passed element",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "el",
+ "type" : "HTMLElement/String",
+ "desc" : "The element to check",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "desc" : "True if this element is an ancestor of el, else false"
}
]
},
{
- "name" : "focus",
+ "name" : "createChild",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child element.",
+ "sig" : "(config, insertBefore, returnDom)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "selectText",
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "DomHelper element config object. If no tag is specified (e.g., {tag:'input'}) then a div will be\nautomatically generated with the specified attributes.",
+ "isOptional" : false
+ },
+ {
+ "name" : "insertBefore",
+ "type" : "HTMLElement",
+ "desc" : "(optional) a child element of this element",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnDom",
"type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "desc" : "(optional) true to return the dom node instead of creating an Element",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.Element",
+ "desc" : "The new child element"
}
]
},
{
- "name" : "getEl",
+ "name" : "createProxy",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Creates a proxy element of this element",
+ "sig" : "(config, renderTo, matchBox)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "String/Object",
+ "desc" : "The class name of the proxy element or a DomHelper config object",
+ "isOptional" : false
+ },
+ {
+ "name" : "renderTo",
+ "type" : "String/HTMLElement",
+ "desc" : "(optional) The element or element id to render the proxy to (defaults to document.body)",
+ "isOptional" : false
+ },
+ {
+ "name" : "matchBox",
+ "type" : "Boolean",
+ "desc" : "(optional) True to align and size the proxy to this element now (defaults to false)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "The element"
+ "desc" : "The new proxy element"
}
]
},
{
- "name" : "getId",
+ "name" : "createShim",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Creates an iframe shim for this element to keep selects and other windowed objects from\nshowing through.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "The new shim element"
}
]
},
{
- "name" : "getValue",
+ "name" : "down",
"type" : "function",
- "desc" : "Gets the current selected value of the date field",
- "sig" : "()\n{\n\n}",
+ "desc" : "Selects a single *direct* child based on the passed CSS selector (the selector should not contain an id).",
+ "sig" : "(selector, returnDom)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "selector",
+ "type" : "String",
+ "desc" : "The CSS selector",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnDom",
+ "type" : "Boolean",
+ "desc" : "(optional) True to return the DOM node instead of Roo.Element (defaults to false)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Date",
- "desc" : "The selected date"
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The child Roo.Element (or DOM node if returnDom = true)"
}
]
},
{
- "name" : "hasListener",
+ "name" : "enableDisplayMode",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Convenience method for setVisibilityMode(Element.DISPLAY)",
+ "sig" : "(display)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "display",
"type" : "String",
- "desc" : "The name of the event to check for",
+ "desc" : "(optional) What to set display to when visible",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "Roo.Element",
+ "desc" : "this"
}
]
},
{
- "name" : "hide",
+ "name" : "endMeasure",
"type" : "function",
- "desc" : "Hide this component.",
+ "desc" : "Restores displays to before beginMeasure was called",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
+ "type" : "Roo.Element",
"desc" : "this"
}
]
},
{
- "name" : "isVisible",
+ "name" : "findParent",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Looks at this node and then at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)",
+ "sig" : "(selector, maxDepth, returnEl)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "selector",
+ "type" : "String",
+ "desc" : "The simple selector to test",
+ "isOptional" : false
+ },
+ {
+ "name" : "maxDepth",
+ "type" : "Number/String/HTMLElement/Element",
+ "desc" : "(optional) The max depth to\n search as a number or element (defaults to 10 || document.body)",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnEl",
+ "type" : "Boolean",
+ "desc" : "(optional) True to return a Roo.Element object instead of DOM node",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "The matching DOM node (or null if no match was found)"
+ }
+ ]
},
{
- "name" : "on",
+ "name" : "findParentNode",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)",
+ "sig" : "(selector, maxDepth, returnEl)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "selector",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The simple selector to test",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "maxDepth",
+ "type" : "Number/String/HTMLElement/Element",
+ "desc" : "(optional) The max depth to\n search as a number or element (defaults to 10 || document.body)",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "returnEl",
+ "type" : "Boolean",
+ "desc" : "(optional) True to return a Roo.Element object instead of DOM node",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "The matching DOM node (or null if no match was found)"
+ }
+ ]
},
{
- "name" : "purgeListeners",
+ "name" : "findScrollableParent",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Looks at the scrollable parent element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "fitToParent",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Sizes this element to its parent element's dimensions performing\nneccessary box adjustments.",
+ "sig" : "(monitorResize, targetParent)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "monitorResize",
+ "type" : "Boolean",
+ "desc" : "(optional) If true maintains the fit when the browser window is resized.",
+ "isOptional" : false
+ },
+ {
+ "name" : "targetParent",
+ "type" : "String/HTMLElment/Element",
+ "desc" : "(optional) The target parent, default to the parentNode.",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "removeListener",
+ "name" : "fly",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
+ "desc" : "Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element -\nthe dom node can be overwritten by other code.",
+ "sig" : "(el, named)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "el",
+ "type" : "String/HTMLElement",
+ "desc" : "The dom node or id",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "named",
+ "type" : "String",
+ "desc" : "(optional) Allows for creation of named reusable flyweights to\n prevent conflicts (e.g. internally Roo uses \"_internal\")",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Element",
+ "desc" : "The shared Element object"
+ }
+ ]
},
{
- "name" : "render",
+ "name" : "focus",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Tries to focus the element. Any exceptions are caught and ignored.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setDisabled",
+ "name" : "get",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
+ "desc" : "Static method to retrieve Element objects. Uses simple caching to consistently return the same object.\nAutomatically fixes if an object was recreated with the same id via AJAX or DOM.",
+ "sig" : "(el)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id of the node, a DOM Node or an existing Element.",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Element",
+ "desc" : "The Element object"
+ }
+ ]
},
{
- "name" : "setValue",
+ "name" : "getAlignToXY",
"type" : "function",
- "desc" : "Sets the value of the date field",
- "sig" : "(value)",
+ "desc" : "Gets the x,y coordinates to align this element with another element. See {@link #alignTo} for more info on the\nsupported position values.",
+ "sig" : "(element, position, offsets)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Date",
- "desc" : "The date to set",
+ "name" : "element",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element to align to.",
+ "isOptional" : false
+ },
+ {
+ "name" : "position",
+ "type" : "String",
+ "desc" : "The position to align to.",
+ "isOptional" : false
+ },
+ {
+ "name" : "offsets",
+ "type" : "Array",
+ "desc" : "(optional) Offset the positioning by [x, y]",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "[x, y]"
+ }
+ ]
},
{
- "name" : "setVisible",
+ "name" : "getAnchorXY",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Gets the x,y coordinates specified by the anchor position on the element.",
+ "sig" : "(anchor, size, local)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
+ "name" : "anchor",
+ "type" : "String",
+ "desc" : "(optional) The specified anchor position (defaults to \"c\"). See {@link #alignTo} for details on supported anchor positions.",
+ "isOptional" : false
+ },
+ {
+ "name" : "size",
+ "type" : "Object",
+ "desc" : "(optional) An object containing the size to use for calculating anchor position\n {width: (target width), height: (target height)} (defaults to the element's current size)",
+ "isOptional" : false
+ },
+ {
+ "name" : "local",
"type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "desc" : "(optional) True to get the local (element top/left-relative) anchor position instead of page coordinates",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Array",
+ "desc" : "[x, y] An array containing the element's x and y coordinates"
}
]
},
{
- "name" : "show",
+ "name" : "getAttributeNS",
"type" : "function",
- "desc" : "Show this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the value of a namespaced attribute from the element's underlying DOM node.",
+ "sig" : "(namespace, name)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "namespace",
+ "type" : "String",
+ "desc" : "The namespace in which to look for the attribute",
+ "isOptional" : false
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The attribute name",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "String",
+ "desc" : "The attribute value"
}
]
},
{
- "name" : "un",
+ "name" : "getBorderWidth",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Gets the width of the border(s) for the specified side(s)",
+ "sig" : "(side)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "side",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "Can be t, l, r, b or any combination of those to add multiple values. For example,\npassing lr would get the border (l)eft width + the border (r)ight width.",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.DialogManager" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The width of the sides passed added together"
+ }
+ ]
+ },
{
- "name" : "bringToFront",
+ "name" : "getBottom",
"type" : "function",
- "desc" : "Brings the specified dialog to the front",
- "sig" : "(dlg)",
+ "desc" : "Gets the bottom Y coordinate of the element (element Y position + element height)",
+ "sig" : "(local)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "dlg",
- "type" : "String/Object",
- "desc" : "The id of the dialog or a dialog",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "True to get the local css position instead of page coordinate",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.BasicDialog",
- "desc" : "this"
+ "type" : "Number",
+ "desc" : ""
}
]
},
{
- "name" : "get",
+ "name" : "getBox",
"type" : "function",
- "desc" : "Gets a registered dialog by id",
- "sig" : "(id)",
+ "desc" : "Return a box {x, y, width, height} that can be used to set another elements\nsize/location to match this element.",
+ "sig" : "(contentBox, local)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String/Object",
- "desc" : "The id of the dialog or a dialog",
+ "name" : "contentBox",
+ "type" : "Boolean",
+ "desc" : "(optional) If true a box for the content of the element is returned.",
+ "isOptional" : false
+ },
+ {
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page x/y.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.BasicDialog",
- "desc" : "this"
+ "type" : "Object",
+ "desc" : "box An object in the format {x, y, width, height}"
}
]
},
{
- "name" : "hideAll",
+ "name" : "getCenterXY",
"type" : "function",
- "desc" : "Hides all dialogs",
+ "desc" : "Calculates the x, y to center this element on the screen",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "The x, y values [x, y]"
+ }
+ ]
},
{
- "name" : "sendToBack",
+ "name" : "getColor",
"type" : "function",
- "desc" : "Sends the specified dialog to the back",
- "sig" : "(dlg)",
+ "desc" : "Return the CSS color for the specified CSS attribute. rgb, 3 digit (like #fff) and valid values\nare convert to standard 6 digit hex color.",
+ "sig" : "(attr, defaultValue, prefix)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "dlg",
- "type" : "String/Object",
- "desc" : "The id of the dialog or a dialog",
+ "name" : "attr",
+ "type" : "String",
+ "desc" : "The css attribute",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.BasicDialog",
- "desc" : "this"
+ "name" : "defaultValue",
+ "type" : "String",
+ "desc" : "The default value to use when a valid color isn't found",
+ "isOptional" : false
+ },
+ {
+ "name" : "prefix",
+ "type" : "String",
+ "desc" : "(optional) defaults to #. Use an empty string when working with\nYUI color anims.",
+ "isOptional" : false
}
- ]
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.Document" : {
- "props" : [
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
+ ],
+ "returns" : []
+ },
{
- "name" : "addEvents",
+ "name" : "getComputedHeight",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders\nwhen needed to simulate offsetHeight when offsets aren't available. This may not work on display:none elements\nif a height has not been set using CSS.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "addListener",
+ "name" : "getComputedWidth",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders\nwhen needed to simulate offsetWidth when offsets aren't available. This may not work on display:none elements\nif a width has not been set using CSS.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
- "isOptional" : false
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "capture",
+ "name" : "getFrameWidth",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Returns the sum width of the padding and borders for the passed \"sides\". See getBorderWidth()\n for more information about the sides.",
+ "sig" : "(sides)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "sides",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "fireEvent",
+ "name" : "getHeight",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Returns the offset height of the element",
+ "sig" : "(contentHeight)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "contentHeight",
+ "type" : "Boolean",
+ "desc" : "(optional) true to get the height minus borders and padding",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "Number",
+ "desc" : "The element's height"
}
]
},
{
- "name" : "hasListener",
+ "name" : "getLeft",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Gets the left X coordinate",
+ "sig" : "(local)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "True to get the local css position instead of page coordinate",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "Number",
+ "desc" : ""
}
]
},
{
- "name" : "on",
+ "name" : "getMargins",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Returns an object with properties top, left, right and bottom representing the margins of this element unless sides is passed,\nthen it returns the calculated width of the sides (see getPadding)",
+ "sig" : "(sides)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "sides",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "desc" : "(optional) Any combination of l, r, t, b to get the sum of those sides",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object/Number",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "purgeListeners",
+ "name" : "getNextSibling",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Gets the next sibling, skipping text nodes",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "The next sibling or null"
+ }
+ ]
},
{
- "name" : "releaseCapture",
+ "name" : "getPadding",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Gets the width of the padding(s) for the specified side(s)",
+ "sig" : "(side)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "side",
+ "type" : "String",
+ "desc" : "Can be t, l, r, b or any combination of those to add multiple values. For example,\npassing lr would get the padding (l)eft + the padding (r)ight.",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The padding of the sides passed added together"
+ }
+ ]
},
{
- "name" : "removeListener",
+ "name" : "getPositioning",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Gets an object with all CSS positioning properties. Useful along with setPostioning to get\nsnapshot before performing an update and then restoring the element.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "scope",
+ "name" : "",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "un",
+ "name" : "getPrevSibling",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Gets the previous sibling, skipping text nodes",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "The previous sibling or null"
}
- ],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.DomHelper" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ ]
+ },
{
- "name" : "append",
+ "name" : "getRegion",
"type" : "function",
- "desc" : "Creates new Dom element(s) and appends them to el",
- "sig" : "(el, o, returnElement)",
+ "desc" : "Returns the region of the given element.\nThe element must be part of the DOM tree to have a region (display:none or elements not appended return false).",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The context element",
- "isOptional" : false
- },
- {
- "name" : "o",
- "type" : "Object/String",
- "desc" : "The Dom object spec (and children) or raw HTML blob",
- "isOptional" : false
- },
- {
- "name" : "returnElement",
- "type" : "Boolean",
- "desc" : "(optional) true to return a Roo.Element",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The new node"
+ "type" : "Region",
+ "desc" : "A Roo.lib.Region containing \"top, left, bottom, right\" member data."
}
]
},
{
- "name" : "applyStyles",
+ "name" : "getRight",
"type" : "function",
- "desc" : "Applies a style specification to an element",
- "sig" : "(el, styles)",
+ "desc" : "Gets the right X coordinate of the element (element X position + element width)",
+ "sig" : "(local)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement",
- "desc" : "The element to apply styles to",
- "isOptional" : false
- },
- {
- "name" : "styles",
- "type" : "String/Object/Function",
- "desc" : "A style specification string eg \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "True to get the local css position instead of page coordinate",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "createTemplate",
+ "name" : "getScroll",
"type" : "function",
- "desc" : "Creates a new Roo.DomHelper.Template from the Dom object spec",
- "sig" : "(o)",
+ "desc" : "Returns the current scroll position of the element.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Object",
- "desc" : "The Dom object spec (and children)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.DomHelper.Template",
- "desc" : "The new template"
+ "type" : "Object",
+ "desc" : "An object containing the scroll position in the format {left: (scrollLeft), top: (scrollTop)}"
}
]
},
{
- "name" : "insertAfter",
+ "name" : "getSize",
"type" : "function",
- "desc" : "Creates new Dom element(s) and inserts them after el",
- "sig" : "(el, o, returnElement)",
+ "desc" : "Returns the size of the element.",
+ "sig" : "(contentSize)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The context element",
- "isOptional" : false
- },
- {
- "name" : "o",
- "type" : "Object",
- "desc" : "The Dom object spec (and children)",
- "isOptional" : false
- },
- {
- "name" : "returnElement",
+ "name" : "contentSize",
"type" : "Boolean",
- "desc" : "(optional) true to return a Roo.Element",
+ "desc" : "(optional) true to get the width/size minus borders and padding",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The new node"
+ "type" : "Object",
+ "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
}
]
},
{
- "name" : "insertBefore",
+ "name" : "getStyle",
"type" : "function",
- "desc" : "Creates new Dom element(s) and inserts them before el",
- "sig" : "(el, o, returnElement)",
+ "desc" : "Normalizes currentStyle and computedStyle. This is not YUI getStyle, it is an optimised version.",
+ "sig" : "(property)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The context element",
- "isOptional" : false
- },
- {
- "name" : "o",
- "type" : "Object/String",
- "desc" : "The Dom object spec (and children) or raw HTML blob",
- "isOptional" : false
- },
- {
- "name" : "returnElement",
- "type" : "Boolean",
- "desc" : "(optional) true to return a Roo.Element",
+ "name" : "property",
+ "type" : "String",
+ "desc" : "The style property whose value is returned.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The new node"
+ "type" : "String",
+ "desc" : "The current value of the style property for this element."
}
]
},
{
- "name" : "insertFirst",
+ "name" : "getStyles",
"type" : "function",
- "desc" : "Creates new Dom element(s) and inserts them as the first child of el",
- "sig" : "(el, o, returnElement)",
+ "desc" : "Returns an object with properties matching the styles requested.\nFor example, el.getStyles('color', 'font-size', 'width') might return\n{'color': '#FFFFFF', 'font-size': '13px', 'width': '100px'}.",
+ "sig" : "(style1, style2)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The context element",
- "isOptional" : false
- },
- {
- "name" : "o",
- "type" : "Object/String",
- "desc" : "The Dom object spec (and children) or raw HTML blob",
+ "name" : "style1",
+ "type" : "String",
+ "desc" : "A style name",
"isOptional" : false
},
{
- "name" : "returnElement",
- "type" : "Boolean",
- "desc" : "(optional) true to return a Roo.Element",
+ "name" : "style2",
+ "type" : "String",
+ "desc" : "A style name",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The new node"
+ "type" : "Object",
+ "desc" : "The style object"
}
]
},
{
- "name" : "insertHtml",
+ "name" : "getTop",
"type" : "function",
- "desc" : "Inserts an HTML fragment into the Dom",
- "sig" : "(where, el, html)",
+ "desc" : "Gets the top Y coordinate",
+ "sig" : "(local)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "where",
- "type" : "String",
- "desc" : "Where to insert the html in relation to el - beforeBegin, afterBegin, beforeEnd, afterEnd.",
- "isOptional" : false
- },
- {
- "name" : "el",
- "type" : "HTMLElement",
- "desc" : "The context element",
- "isOptional" : false
- },
- {
- "name" : "html",
- "type" : "String",
- "desc" : "The HTML fragmenet",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "True to get the local css position instead of page coordinate",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "HTMLElement",
- "desc" : "The new node"
+ "type" : "Number",
+ "desc" : ""
}
]
},
{
- "name" : "markup",
+ "name" : "getUpdateManager",
"type" : "function",
- "desc" : "Returns the markup for the passed Element(s) config",
- "sig" : "(o)",
+ "desc" : "Gets this element's UpdateManager",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Object",
- "desc" : "The Dom object spec (and children)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Roo.UpdateManager",
+ "desc" : "The UpdateManager"
}
]
},
{
- "name" : "overwrite",
+ "name" : "getValue",
"type" : "function",
- "desc" : "Creates new Dom element(s) and overwrites the contents of el with them",
- "sig" : "(el, o, returnElement)",
+ "desc" : "Returns the value of the \"value\" attribute",
+ "sig" : "(asNumber)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The context element",
- "isOptional" : false
- },
- {
- "name" : "o",
- "type" : "Object/String",
- "desc" : "The Dom object spec (and children) or raw HTML blob",
- "isOptional" : false
- },
- {
- "name" : "returnElement",
+ "name" : "asNumber",
"type" : "Boolean",
- "desc" : "(optional) true to return a Roo.Element",
+ "desc" : "true to parse the value as a number",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The new node"
+ "type" : "String/Number",
+ "desc" : ""
}
]
},
{
- "name" : "update",
+ "name" : "getViewSize",
"type" : "function",
- "desc" : "Updates the first element with the spec from the o (replacing if necessary)\nThis iterates through the children, and updates attributes / children etc..",
- "sig" : "(el, o)",
+ "desc" : "Returns the width and height of the viewport.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The context element",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "o",
- "type" : "Object/String",
- "desc" : "The Dom object spec (and children) or raw HTML blob",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "An object containing the viewport's size {width: (viewport width), height: (viewport height)}"
}
- ],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.DomQuery" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ ]
+ },
{
- "name" : "compile",
+ "name" : "getWidth",
"type" : "function",
- "desc" : "Compiles a selector/xpath query into a reusable function. The returned function\ntakes one parameter \"root\" (optional), which is the context node from where the query should start.",
- "sig" : "(selector, type)",
+ "desc" : "Returns the offset width of the element",
+ "sig" : "(contentWidth)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "selector",
- "type" : "String",
- "desc" : "The selector/xpath query",
- "isOptional" : false
- },
- {
- "name" : "type",
- "type" : "String",
- "desc" : "(optional) Either \"select\" (the default) or \"simple\" for a simple selector match",
+ "name" : "contentWidth",
+ "type" : "Boolean",
+ "desc" : "(optional) true to get the width minus borders and padding",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Function",
- "desc" : ""
+ "type" : "Number",
+ "desc" : "The element's width"
}
]
},
{
- "name" : "filter",
+ "name" : "getX",
"type" : "function",
- "desc" : "Filters an array of elements to only include matches of a simple selector (e.g. div.some-class or span:first-child)",
- "sig" : "(el, selector, nonMatches)",
+ "desc" : "Gets the current X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "Array",
- "desc" : "An array of elements to filter",
- "isOptional" : false
- },
- {
- "name" : "selector",
- "type" : "String",
- "desc" : "The simple selector to test",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "nonMatches",
- "type" : "Boolean",
- "desc" : "If true, it returns the elements that DON'T match\nthe selector instead of the ones that match",
- "isOptional" : false
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The X position of the element"
}
- ],
+ ]
+ },
+ {
+ "name" : "getXY",
+ "type" : "function",
+ "desc" : "Gets the current position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
"type" : "Array",
- "desc" : ""
+ "desc" : "The XY position of the element"
}
]
},
{
- "name" : "is",
+ "name" : "getY",
"type" : "function",
- "desc" : "Returns true if the passed element(s) match the passed simple selector (e.g. div.some-class or span:first-child)",
- "sig" : "(el, selector)",
+ "desc" : "Gets the current Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement/Array",
- "desc" : "An element id, element or array of elements",
- "isOptional" : false
- },
- {
- "name" : "selector",
- "type" : "String",
- "desc" : "The simple selector to test",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "type" : "Number",
+ "desc" : "The Y position of the element"
}
]
},
{
- "name" : "select",
+ "name" : "hasClass",
"type" : "function",
- "desc" : "Selects a group of elements.",
- "sig" : "(selector, root)",
+ "desc" : "Checks if the specified CSS class exists on this element's DOM node.",
+ "sig" : "(className)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "selector",
+ "name" : "className",
"type" : "String",
- "desc" : "The selector/xpath query (can be a comma separated list of selectors)",
- "isOptional" : false
- },
- {
- "name" : "root",
- "type" : "Node",
- "desc" : "(optional) The start of the query (defaults to document).",
+ "desc" : "The CSS class to check for",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Array",
- "desc" : ""
+ "type" : "Boolean",
+ "desc" : "True if the class exists, else false"
}
]
},
{
- "name" : "selectNode",
+ "name" : "hide",
"type" : "function",
- "desc" : "Selects a single element.",
- "sig" : "(selector, root)",
+ "desc" : "Hide this element - Uses display mode to determine whether to use \"display\" or \"visibility\". See {@link #setVisible}.",
+ "sig" : "(animate)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "selector",
- "type" : "String",
- "desc" : "The selector/xpath query",
- "isOptional" : false
- },
- {
- "name" : "root",
- "type" : "Node",
- "desc" : "(optional) The start of the query (defaults to document).",
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Element",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "this"
}
]
},
{
- "name" : "selectNumber",
+ "name" : "initDD",
"type" : "function",
- "desc" : "Selects the value of a node, parsing integers and floats.",
- "sig" : "(selector, root, defaultValue)",
+ "desc" : "Initializes a {@link Roo.dd.DD} drag drop object for this element.",
+ "sig" : "(group, config, overrides)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "selector",
+ "name" : "group",
"type" : "String",
- "desc" : "The selector/xpath query",
+ "desc" : "The group the DD object is member of",
"isOptional" : false
},
{
- "name" : "root",
- "type" : "Node",
- "desc" : "(optional) The start of the query (defaults to document).",
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The DD config object",
"isOptional" : false
},
{
- "name" : "defaultValue",
- "type" : "Number",
- "desc" : "",
+ "name" : "overrides",
+ "type" : "Object",
+ "desc" : "An object containing methods to override/implement on the DD object",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : ""
+ "type" : "Roo.dd.DD",
+ "desc" : "The DD object"
}
]
},
{
- "name" : "selectValue",
+ "name" : "initDDProxy",
"type" : "function",
- "desc" : "Selects the value of a node, optionally replacing null with the defaultValue.",
- "sig" : "(selector, root, defaultValue)",
+ "desc" : "Initializes a {@link Roo.dd.DDProxy} object for this element.",
+ "sig" : "(group, config, overrides)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "selector",
+ "name" : "group",
"type" : "String",
- "desc" : "The selector/xpath query",
+ "desc" : "The group the DDProxy object is member of",
"isOptional" : false
},
{
- "name" : "root",
- "type" : "Node",
- "desc" : "(optional) The start of the query (defaults to document).",
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The DDProxy config object",
"isOptional" : false
},
{
- "name" : "defaultValue",
- "type" : "String",
- "desc" : "",
+ "name" : "overrides",
+ "type" : "Object",
+ "desc" : "An object containing methods to override/implement on the DDProxy object",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.DomTemplate" : {
- "props" : [
- {
- "name" : "html",
- "type" : "String",
- "desc" : "The HTML fragment or an array of fragments to join(\"\") or multiple arguments to join(\"\")",
- "memberOf" : "Roo.Template",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "onLoad",
- "type" : "Function",
- "desc" : "Called after the template has been loaded and complied (usually from a remove source)",
- "memberOf" : "Roo.Template",
- "isOptional" : false,
- "optvals" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.dd.DDProxy",
+ "desc" : "The DDProxy object"
+ }
+ ]
},
{
- "name" : "url",
- "type" : "String",
- "desc" : "The Url to load the template from. beware if you are loading from a url, the data may not be ready if you use it instantly..\n it should be fixed so that template is observable...",
- "memberOf" : "Roo.Template",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
- {
- "name" : "append",
+ "name" : "initDDTarget",
"type" : "function",
- "desc" : "Applies the supplied values to the template and appends the new node(s) to el.",
- "sig" : "(el, values, returnElement)",
+ "desc" : "Initializes a {@link Roo.dd.DDTarget} object for this element.",
+ "sig" : "(group, config, overrides)",
"static" : false,
- "memberOf" : "Roo.Template",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The context element",
+ "name" : "group",
+ "type" : "String",
+ "desc" : "The group the DDTarget object is member of",
"isOptional" : false
},
{
- "name" : "values",
+ "name" : "config",
"type" : "Object",
- "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
+ "desc" : "The DDTarget config object",
"isOptional" : false
},
{
- "name" : "returnElement",
- "type" : "Boolean",
- "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
+ "name" : "overrides",
+ "type" : "Object",
+ "desc" : "An object containing methods to override/implement on the DDTarget object",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The new node or Element"
+ "type" : "Roo.dd.DDTarget",
+ "desc" : "The DDTarget object"
}
]
},
{
- "name" : "apply",
- "type" : "function",
- "desc" : "Alias for {@link #applyTemplate}",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Template",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "applySubTemplate",
+ "name" : "insertAfter",
"type" : "function",
- "desc" : "same as applyTemplate, except it's done to one of the subTemplates\nwhen using named templates, you can do:\n\nvar str = pl.applySubTemplate('your-name', values);",
- "sig" : "(id, values, parent)",
+ "desc" : "Inserts this element after the passed element in the DOM",
+ "sig" : "(el)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "Number",
- "desc" : "of the template",
- "isOptional" : false
- },
- {
- "name" : "values",
- "type" : "Object",
- "desc" : "to apply to template",
- "isOptional" : false
- },
- {
- "name" : "parent",
- "type" : "Object",
- "desc" : "(normaly the instance of this object)",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The element to insert after",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "applyTemplate",
+ "name" : "insertBefore",
"type" : "function",
- "desc" : "Returns an HTML fragment of this template with the specified values applied.",
- "sig" : "(values)",
+ "desc" : "Inserts this element before the passed element in the DOM",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "Roo.Template",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "values",
- "type" : "Object",
- "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The element to insert before",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "The HTML fragment"
+ "type" : "Roo.Element",
+ "desc" : "this"
}
]
},
{
- "name" : "compile",
- "type" : "function",
- "desc" : "compile the template\n\nThis is not recursive, so I'm not sure how nested templates are really going to be handled..",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "compileTpl",
+ "name" : "insertFirst",
"type" : "function",
- "desc" : "Compile a segment of the template into a 'sub-template'",
- "sig" : "()\n{\n\n}",
+ "desc" : "Inserts (or creates) an element (or DomHelper config) as the first child of the this element",
+ "sig" : "(el)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "from",
- "type" : "function",
- "desc" : "Creates a template from the passed element's value (<i>display:none</i> textarea, preferred) or innerHTML.",
- "sig" : "(el)",
- "static" : true,
- "memberOf" : "Roo.Template",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
"name" : "el",
- "type" : "String/HTMLElement",
- "desc" : "A DOM element or its id",
+ "type" : "String/HTMLElement/Element/Object",
+ "desc" : "The id or element to insert or a DomHelper config to create and insert",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "The new child"
+ }
+ ]
},
{
- "name" : "insertAfter",
+ "name" : "insertHtml",
"type" : "function",
- "desc" : "Applies the supplied values to the template and inserts the new node(s) after el.",
- "sig" : "(el, values, returnElement)",
+ "desc" : "Inserts an html fragment into this element",
+ "sig" : "(where, html, returnEl)",
"static" : false,
- "memberOf" : "Roo.Template",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The context element",
+ "name" : "where",
+ "type" : "String",
+ "desc" : "Where to insert the html in relation to the this element - beforeBegin, afterBegin, beforeEnd, afterEnd.",
"isOptional" : false
},
{
- "name" : "values",
- "type" : "Object",
- "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
+ "name" : "html",
+ "type" : "String",
+ "desc" : "The HTML fragment",
"isOptional" : false
},
{
- "name" : "returnElement",
+ "name" : "returnEl",
"type" : "Boolean",
- "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
+ "desc" : "True to return an Roo.Element",
"isOptional" : false
}
],
{
"name" : "",
"type" : "HTMLElement/Roo.Element",
- "desc" : "The new node or Element"
+ "desc" : "The inserted node (or nearest related if more than 1 inserted)"
}
]
},
{
- "name" : "insertBefore",
+ "name" : "insertSibling",
"type" : "function",
- "desc" : "Applies the supplied values to the template and inserts the new node(s) before el.",
- "sig" : "(el, values, returnElement)",
+ "desc" : "Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element",
+ "sig" : "(el, where, returnDom)",
"static" : false,
- "memberOf" : "Roo.Template",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [
{
"name" : "el",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The context element",
+ "type" : "String/HTMLElement/Element/Object",
+ "desc" : "The id or element to insert or a DomHelper config to create and insert",
"isOptional" : false
},
{
- "name" : "values",
- "type" : "Object",
- "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
+ "name" : "where",
+ "type" : "String",
+ "desc" : "(optional) 'before' or 'after' defaults to before",
"isOptional" : false
},
{
- "name" : "returnElement",
+ "name" : "returnDom",
"type" : "Boolean",
- "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
+ "desc" : "(optional) True to return the raw DOM element instead of Roo.Element",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The new node or Element"
+ "type" : "Roo.Element",
+ "desc" : "the inserted Element"
}
]
},
{
- "name" : "insertFirst",
+ "name" : "is",
"type" : "function",
- "desc" : "Applies the supplied values to the template and inserts the new node(s) as the first child of el.",
- "sig" : "(el, values, returnElement)",
+ "desc" : "Returns true if this element matches the passed simple selector (e.g. div.some-class or span:first-child)",
+ "sig" : "(selector)",
"static" : false,
- "memberOf" : "Roo.Template",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The context element",
- "isOptional" : false
- },
- {
- "name" : "values",
- "type" : "Object",
- "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
- "isOptional" : false
- },
- {
- "name" : "returnElement",
- "type" : "Boolean",
- "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
+ "name" : "selector",
+ "type" : "String",
+ "desc" : "The simple selector to test",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The new node or Element"
+ "type" : "Boolean",
+ "desc" : "True if this element matches the selector, else false"
}
]
},
{
- "name" : "overwrite",
+ "name" : "isBorderBox",
"type" : "function",
- "desc" : "Applies the supplied values to the template and overwrites the content of el with the new node(s).",
- "sig" : "(el, values, returnElement)",
+ "desc" : "Tests various css rules/browsers to determine if this element uses a border box",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Template",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The context element",
- "isOptional" : false
- },
- {
- "name" : "values",
- "type" : "Object",
- "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
- "isOptional" : false
- },
- {
- "name" : "returnElement",
- "type" : "Boolean",
- "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The new node or Element"
+ "type" : "Boolean",
+ "desc" : ""
}
]
},
{
- "name" : "set",
+ "name" : "isDisplayed",
"type" : "function",
- "desc" : "Sets the HTML used as the template and optionally compiles it.",
- "sig" : "(html, compile)",
+ "desc" : "Returns true if display is not \"none\"",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Template",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "html",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "compile",
- "type" : "Boolean",
- "desc" : "(optional) True to compile the template (defaults to undefined)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Template",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : ""
}
]
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.Editor" : {
- "props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "alignment",
- "type" : "String",
- "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details, defaults to \"c-c?\").",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autosize",
- "type" : "Boolean/String",
- "desc" : "True for the editor to automatically adopt the size of the underlying field, \"width\" to adopt the width only,\nor \"height\" to adopt the height only (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cancelOnEsc",
- "type" : "Boolean",
- "desc" : "True to cancel the edit when the escape key is pressed (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "completeOnEnter",
- "type" : "Boolean",
- "desc" : "True to complete the edit when the enter key is pressed (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "constrain",
- "type" : "Boolean",
- "desc" : "True to constrain the editor to the viewport",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideEl",
- "type" : "Boolean",
- "desc" : "False to keep the bound element visible while the editor is displayed (defaults to true)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
- },
- {
- "name" : "ignoreNoChange",
- "type" : "Boolean",
- "desc" : "True to skip the the edit completion process (no save, no events fired) if the user completes an edit and\nthe value has not changed (defaults to false). Applies only to string values - edits for other data types\nwill never be ignored.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "revertInvalid",
- "type" : "Boolean",
- "desc" : "True to automatically revert the field value and cancel the edit when the user completes an edit and the field\nvalidation fails (defaults to true)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "shadow",
- "type" : "Boolean/String",
- "desc" : "\"sides\" for sides/bottom only, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"frame\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "css styles to add to component\neg. text-align:right;",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "updateEl",
- "type" : "Boolean",
- "desc" : "True to update the innerHTML of the bound element when the update completes (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
},
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The data value of the underlying field (defaults to \"\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "beforecomplete",
+ "name" : "isMasked",
"type" : "function",
- "desc" : "Fires after a change has been made to the field, but before the change is reflected in the underlying\nfield. Saving the change to the field can be canceled by returning false from the handler of this event.\nNote that if the value has not changed and ignoreNoChange = true, the editing will still end but this\nevent will not fire since no edit actually occurred.",
- "sig" : "function (_self, value, startValue)\n{\n\n}",
+ "desc" : "Returns true if this element is masked",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Editor",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The current field value",
- "isOptional" : false
- },
- {
- "name" : "startValue",
- "type" : "Mixed",
- "desc" : "The original field value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "beforehide",
+ "name" : "isScrollable",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Returns true if this element is scrollable.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "beforerender",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Checks whether the element is currently visible using both visibility and display properties.",
+ "sig" : "(deep)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "deep",
+ "type" : "Boolean",
+ "desc" : "(optional) True to walk the dom and see if parent elements are hidden (defaults to false)",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the element is currently visible, else false"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "beforestartedit",
+ "name" : "load",
"type" : "function",
- "desc" : "Fires when editing is initiated, but before the value changes. Editing can be canceled by returning\nfalse from the handler of this event.",
- "sig" : "function (_self, boundEl, value)\n{\n\n}",
+ "desc" : "Direct access to the UpdateManager update() method (takes the same parameters).",
+ "sig" : "(url, params, callback, discardUrl)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Editor",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "boundEl",
- "type" : "Roo.Element",
- "desc" : "The underlying element bound to this editor",
+ "name" : "url",
+ "type" : "String/Function",
+ "desc" : "The url for this request or a function to call to get the url",
"isOptional" : false
},
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The field value being set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "complete",
- "type" : "function",
- "desc" : "Fires after editing is complete and any changed value has been written to the underlying field.",
- "sig" : "function (_self, value, startValue)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Editor",
- "desc" : "",
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The parameters to pass as either a url encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
"isOptional" : false
},
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The current field value",
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)",
"isOptional" : false
},
{
- "name" : "startValue",
- "type" : "Mixed",
- "desc" : "The original field value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "discardUrl",
+ "type" : "Boolean",
+ "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used url. If true, it will not store the url.",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "enable",
+ "name" : "mask",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Puts a mask over this element to disable user interaction. Requires core.css.\nThis method can only be applied to elements which accept child nodes.",
+ "sig" : "(msg, msgCls)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "(optional) A message to display in the mask",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "msgCls",
+ "type" : "String",
+ "desc" : "(optional) A css class to apply to the msg element - use no-spinner to hide the spinner on bootstrap",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Element",
+ "desc" : "The mask element"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "show",
+ "name" : "move",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Move this element relative to its current position.",
+ "sig" : "(direction, distance, animate)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "direction",
+ "type" : "String",
+ "desc" : "Possible values are: \"l\",\"left\" - \"r\",\"right\" - \"t\",\"top\",\"up\" - \"b\",\"bottom\",\"down\".",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "distance",
+ "type" : "Number",
+ "desc" : "How far to move the element in pixels",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "startedit",
- "type" : "function",
- "desc" : "Fires when this editor is displayed",
- "sig" : "function (boundEl, value)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "returns" : [
{
- "name" : "boundEl",
+ "name" : "",
"type" : "Roo.Element",
- "desc" : "The underlying element bound to this editor",
- "isOptional" : false
- },
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The starting field value",
- "isOptional" : false
+ "desc" : "this"
}
- ],
- "returns" : []
- }
- ],
- "methods" : [
+ ]
+ },
{
- "name" : "addEvents",
+ "name" : "moveTo",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
+ "sig" : "(x, y, animate)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "X value for new position (coordinates are page-based)",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "Y value for new position (coordinates are page-based)",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) True for the default animation, or a standard Element animation config object",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "addListener",
+ "name" : "on",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Appends an event handler (Shorthand for addListener)",
+ "sig" : "(eventName, fn, scope, options)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The type of event to listen for",
+ "desc" : "The type of event to append",
"isOptional" : false
},
{
- "name" : "handler",
+ "name" : "fn",
"type" : "Function",
"desc" : "The method the event invokes",
"isOptional" : false
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "desc" : "(optional) The scope (this object) of the fn",
"isOptional" : false
},
{
"name" : "options",
"type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "desc" : "(optional)An object with standard {@link Roo.EventManager#addListener} options",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "cancelEdit",
+ "name" : "position",
"type" : "function",
- "desc" : "Cancels the editing process and hides the editor without persisting any changes. The field value will be\nreverted to the original starting value.",
- "sig" : "(remainVisible)",
+ "desc" : "Initializes positioning on this element. If a desired position is not passed, it will make the\nthe element positioned relative IF it is not already positioned.",
+ "sig" : "(pos, zIndex, x, y)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "remainVisible",
- "type" : "Boolean",
- "desc" : "Override the default behavior and keep the editor visible after\ncancel (defaults to false)",
+ "name" : "pos",
+ "type" : "String",
+ "desc" : "(optional) Positioning to use \"relative\", \"absolute\" or \"fixed\"",
+ "isOptional" : false
+ },
+ {
+ "name" : "zIndex",
+ "type" : "Number",
+ "desc" : "(optional) The zIndex to apply",
+ "isOptional" : false
+ },
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "(optional) Set the page X position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "(optional) Set the page Y position",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "query",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Selects child nodes based on the passed CSS selector (the selector should not contain an id).",
+ "sig" : "(selector)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "selector",
+ "type" : "String",
+ "desc" : "The CSS selector",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "An array of the matched nodes"
+ }
+ ]
},
{
- "name" : "completeEdit",
+ "name" : "radioClass",
"type" : "function",
- "desc" : "Ends the editing process, persists the changed value to the underlying field, and hides the editor.",
- "sig" : "(remainVisible)",
+ "desc" : "Adds one or more CSS classes to this element and removes the same class(es) from all siblings.",
+ "sig" : "(className)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "remainVisible",
- "type" : "Boolean",
- "desc" : "Override the default behavior and keep the editor visible after edit (defaults to false)",
+ "name" : "className",
+ "type" : "String/Array",
+ "desc" : "The CSS class to add, or an array of classes",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "destroy",
+ "name" : "remove",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "desc" : "Removes this element from the DOM and deletes it from the cache",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "disable",
+ "name" : "removeAllListeners",
"type" : "function",
- "desc" : "Disable this component.",
+ "desc" : "Removes all previous added listeners from this element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
+ "type" : "Roo.Element",
"desc" : "this"
}
]
},
{
- "name" : "enable",
+ "name" : "removeClass",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes one or more CSS classes from the element.",
+ "sig" : "(className)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "className",
+ "type" : "String/Array",
+ "desc" : "The CSS class to remove, or an array of classes",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
+ "type" : "Roo.Element",
"desc" : "this"
}
]
},
{
- "name" : "fireEvent",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Removes an event handler from this element",
+ "sig" : "(eventName, fn, scope)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "",
+ "desc" : "the type of event to remove",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "the method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Function",
+ "desc" : "(needed for svg fake listeners)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "Roo.Element",
+ "desc" : "this"
}
]
},
{
- "name" : "focus",
+ "name" : "repaint",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Forces the browser to repaint this element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
+ "type" : "Roo.Element",
"desc" : "this"
}
]
},
{
- "name" : "getEl",
+ "name" : "replace",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Replaces the passed element with this element",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The element to replace",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "The element"
+ "desc" : "this"
}
]
},
{
- "name" : "getId",
+ "name" : "replaceClass",
"type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Replaces a CSS class on the element with another. If the old name does not exist, the new name will simply be added.",
+ "sig" : "(oldClassName, newClassName)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
+ "name" : "oldClassName",
"type" : "String",
- "desc" : ""
+ "desc" : "The CSS class to replace",
+ "isOptional" : false
+ },
+ {
+ "name" : "newClassName",
+ "type" : "String",
+ "desc" : "The replacement CSS class",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Gets the data value of the editor",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ ],
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "The data value"
+ "type" : "Roo.Element",
+ "desc" : "this"
}
]
},
{
- "name" : "hasListener",
+ "name" : "scroll",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Scrolls this element the specified direction. Does bounds checking to make sure the scroll is\nwithin this element's scrollable range.",
+ "sig" : "(direction, distance, animate)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "direction",
"type" : "String",
- "desc" : "The name of the event to check for",
+ "desc" : "Possible values are: \"l\",\"left\" - \"r\",\"right\" - \"t\",\"top\",\"up\" - \"b\",\"bottom\",\"down\".",
+ "isOptional" : false
+ },
+ {
+ "name" : "distance",
+ "type" : "Number",
+ "desc" : "How far to scroll the element in pixels",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "desc" : "Returns true if a scroll was triggered or false if the element\nwas scrolled as far as it could go."
}
]
},
{
- "name" : "hide",
+ "name" : "scrollIntoView",
"type" : "function",
- "desc" : "Hide this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Scrolls this element into view within the passed container.",
+ "sig" : "(container, hscroll)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The container element to scroll (defaults to document.body)",
+ "isOptional" : false
+ },
+ {
+ "name" : "hscroll",
+ "type" : "Boolean",
+ "desc" : "(optional) False to disable horizontal scroll (defaults to true)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
+ "type" : "Roo.Element",
"desc" : "this"
}
]
},
{
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "on",
+ "name" : "scrollTo",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Scrolls this element the specified scroll point. It does NOT do bounds checking so if you scroll to a weird value it will try to do it. For auto bounds checking, use scroll().",
+ "sig" : "(side, value, animate)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "side",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "Either \"left\" for scrollLeft values or \"top\" for scrollTop values.",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "value",
+ "type" : "Number",
+ "desc" : "The new scroll value",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "realign",
- "type" : "function",
- "desc" : "Realigns the editor to the bound field based on the current alignment config value.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ "returns" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
+ "name" : "",
+ "type" : "Element",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "removeListener",
+ "name" : "select",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Creates a {@link Roo.CompositeElement} for child nodes based on the passed CSS selector (the selector should not contain an id).",
+ "sig" : "(selector, unique)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "selector",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "The CSS selector",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "unique",
+ "type" : "Boolean",
+ "desc" : "(optional) True to create a unique Roo.Element for each child (defaults to false, which creates a single shared flyweight object)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "CompositeElement/CompositeElementLite",
+ "desc" : "The composite element"
+ }
+ ]
},
{
- "name" : "render",
+ "name" : "set",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function)",
+ "sig" : "(o, useSet)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The object with the attributes",
+ "isOptional" : false
+ },
+ {
+ "name" : "useSet",
+ "type" : "Boolean",
+ "desc" : "(optional) false to override the default setAttribute to use expandos.",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "setDisabled",
+ "name" : "setBottom",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Sets the element's CSS bottom style.",
+ "sig" : "(bottom)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "bottom",
+ "type" : "String",
+ "desc" : "The bottom CSS property value",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "setSize",
+ "name" : "setBounds",
"type" : "function",
- "desc" : "Sets the height and width of this editor.",
- "sig" : "(width, height)",
+ "desc" : "Sets the element's position and size in one shot. If animation is true then width, height, x and y will be animated concurrently.",
+ "sig" : "(x, y, width, height, animate)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"exceptions" : "",
"requires" : "",
"params" : [
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "X value for new position (coordinates are page-based)",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "Y value for new position (coordinates are page-based)",
+ "isOptional" : false
+ },
{
"name" : "width",
"type" : "Number",
"type" : "Number",
"desc" : "The new height",
"isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
+ "isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "setValue",
+ "name" : "setBox",
"type" : "function",
- "desc" : "Sets the data value of the editor",
- "sig" : "(value)",
+ "desc" : "Sets the element's box. Use getBox() on another element to get a box obj. If animate is true then width, height, x and y will be animated concurrently.",
+ "sig" : "(box, adjust, animate)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "Any valid value supported by the underlying field",
+ "name" : "box",
+ "type" : "Object",
+ "desc" : "The box to fill {x, y, width, height}",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "visible",
+ "name" : "adjust",
"type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "desc" : "(optional) Whether to adjust for box-model issues automatically",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
+ "type" : "Roo.Element",
"desc" : "this"
}
]
},
{
- "name" : "show",
+ "name" : "setDisplayed",
"type" : "function",
- "desc" : "Show this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the CSS display property. Uses originalDisplay if the specified value is a boolean true.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Boolean",
+ "desc" : "Boolean value to display the element using its default display, or a string to set the display directly",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
+ "type" : "Roo.Element",
"desc" : "this"
}
]
},
{
- "name" : "startEdit",
+ "name" : "setHeight",
"type" : "function",
- "desc" : "Starts the editing process and shows the editor.",
- "sig" : "(el, value)",
+ "desc" : "Set the height of the element",
+ "sig" : "(height, animate)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The element to edit",
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height",
"isOptional" : false
},
{
- "name" : "value",
- "type" : "String",
- "desc" : "(optional) A value to initialize the editor with. If a value is not provided, it defaults\nto the innerHTML of el.",
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "un",
+ "name" : "setLeft",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Sets the element's left position directly using CSS style (instead of {@link #setX}).",
+ "sig" : "(left)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "left",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "The left CSS property value",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.grid.GridEditor",
- "Roo.tree.TreeEditor"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.Element" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
{
- "name" : "addClass",
+ "name" : "setLeftTop",
"type" : "function",
- "desc" : "Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out.",
- "sig" : "(className)",
+ "desc" : "Quick set left and top adding default units",
+ "sig" : "(left, top)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "className",
- "type" : "String/Array",
- "desc" : "The CSS class to add, or an array of classes",
+ "name" : "left",
+ "type" : "String",
+ "desc" : "The left CSS property value",
+ "isOptional" : false
+ },
+ {
+ "name" : "top",
+ "type" : "String",
+ "desc" : "The top CSS property value",
"isOptional" : false
}
],
]
},
{
- "name" : "addClassOnClick",
+ "name" : "setLocation",
"type" : "function",
- "desc" : "Sets up event handlers to add and remove a css class when the mouse is down and then up on this element (a click effect)",
- "sig" : "(className)",
+ "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
+ "sig" : "(x, y, animate)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "className",
- "type" : "String",
- "desc" : "",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "X value for new position (coordinates are page-based)",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "Y value for new position (coordinates are page-based)",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) True for the default animation, or a standard Element animation config object",
"isOptional" : false
}
],
]
},
{
- "name" : "addClassOnFocus",
+ "name" : "setOpacity",
"type" : "function",
- "desc" : "Sets up event handlers to add and remove a css class when this element has the focus",
- "sig" : "(className)",
+ "desc" : "Set the opacity of the element",
+ "sig" : "(opacity, animate)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "className",
- "type" : "String",
- "desc" : "",
+ "name" : "opacity",
+ "type" : "Float",
+ "desc" : "The new opacity. 0 = transparent, .5 = 50% visibile, 1 = fully visible, etc",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
"isOptional" : false
}
],
]
},
{
- "name" : "addClassOnOver",
+ "name" : "setPositioning",
"type" : "function",
- "desc" : "Sets up event handlers to add and remove a css class when the mouse is over this element",
- "sig" : "(className, preventFlicker)",
+ "desc" : "Set positioning with an object returned by getPositioning().",
+ "sig" : "(posCfg)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "className",
- "type" : "String",
+ "name" : "posCfg",
+ "type" : "Object",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "preventFlicker",
- "type" : "Boolean",
- "desc" : "(optional) If set to true, it prevents flickering by filtering\nmouseout events for children elements",
- "isOptional" : false
}
],
"returns" : [
]
},
{
- "name" : "addKeyListener",
+ "name" : "setRegion",
"type" : "function",
- "desc" : "Convenience method for constructing a KeyMap",
- "sig" : "(key, fn, scope)",
+ "desc" : "Sets the element's position and size the the specified region. If animation is true then width, height, x and y will be animated concurrently.",
+ "sig" : "(region, animate)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "key",
- "type" : "Number/Array/Object/String",
- "desc" : "Either a string with the keys to listen for, the numeric key code, array of key codes or an object with the following options:\n {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "region",
+ "type" : "Roo.lib.Region",
+ "desc" : "The region to fill",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the function",
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.KeyMap",
- "desc" : "The KeyMap created"
+ "type" : "Roo.Element",
+ "desc" : "this"
}
]
},
{
- "name" : "addKeyMap",
+ "name" : "setRight",
"type" : "function",
- "desc" : "Creates a KeyMap for this element",
- "sig" : "(config)",
+ "desc" : "Sets the element's CSS right style.",
+ "sig" : "(right)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "config",
- "type" : "Object",
- "desc" : "The KeyMap config. See {@link Roo.KeyMap} for more details",
+ "name" : "right",
+ "type" : "String",
+ "desc" : "The right CSS property value",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.KeyMap",
- "desc" : "The KeyMap created"
+ "type" : "Roo.Element",
+ "desc" : "this"
}
]
},
{
- "name" : "addListener",
+ "name" : "setSize",
"type" : "function",
- "desc" : "Appends an event handler",
- "sig" : "(eventName, fn, scope, options)",
+ "desc" : "Set the size of the element. If animation is true, both width an height will be animated concurrently.",
+ "sig" : "(width, height, animate)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to append",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The new width",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) of the fn",
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)An object with standard {@link Roo.EventManager#addListener} options",
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "alignTo",
+ "name" : "setStyle",
"type" : "function",
- "desc" : "Aligns this element with another element relative to the specified anchor points. If the other element is the\ndocument it aligns it to the viewport.\nThe position parameter is optional, and can be specified in any one of the following formats:\n<ul>\n <li><b>Blank</b>: Defaults to aligning the element's top-left corner to the target's bottom-left corner (\"tl-bl\").</li>\n <li><b>One anchor (deprecated)</b>: The passed anchor position is used as the target element's anchor point.\n The element being aligned will position its top-left corner (tl) to that point. <i>This method has been\n deprecated in favor of the newer two anchor syntax below</i>.</li>\n <li><b>Two anchors</b>: If two values from the table below are passed separated by a dash, the first value is used as the\n element's anchor point, and the second value is used as the target's anchor point.</li>\n</ul>\nIn addition to the anchor points, the position parameter also supports the \"?\" character. If \"?\" is passed at the end of\nthe position string, the element will attempt to align as specified, but the position will be adjusted to constrain to\nthe viewport if necessary. Note that the element being aligned might be swapped to align to a different position than\nthat specified in order to enforce the viewport constraints.\nFollowing are all of the supported anchor positions:\n <pre>\n Value Description\n ----- -----------------------------\n tl The top left corner (default)\n t The center of the top edge\n tr The top right corner\n l The center of the left edge\n c In the center of the element\n r The center of the right edge\n bl The bottom left corner\n b The center of the bottom edge\n br The bottom right corner\n </pre>\n Example Usage:\n <pre><code>\n // align el to other-el using the default positioning (\"tl-bl\", non-constrained)\n el.alignTo(\"other-el\");\n\n // align the top left corner of el with the top right corner of other-el (constrained to viewport)\n el.alignTo(\"other-el\", \"tr?\");\n\n // align the bottom right corner of el with the center left edge of other-el\n el.alignTo(\"other-el\", \"br-l?\");\n\n // align the center of el with the bottom left corner of other-el and\n // adjust the x position by -6 pixels (and the y position by 0)\n el.alignTo(\"other-el\", \"c-bl\", [-6, 0]);\n </code></pre>",
- "sig" : "(element, position, offsets, animate)",
+ "desc" : "Wrapper for setting style properties, also takes single object parameter of multiple styles.",
+ "sig" : "(property, value)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "element",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The element to align to.",
+ "name" : "property",
+ "type" : "String/Object",
+ "desc" : "The style property to be set, or an object of multiple styles.",
"isOptional" : false
},
{
- "name" : "position",
+ "name" : "value",
"type" : "String",
- "desc" : "The position to align to.",
- "isOptional" : false
- },
- {
- "name" : "offsets",
- "type" : "Array",
- "desc" : "(optional) Offset the positioning by [x, y]",
- "isOptional" : false
- },
- {
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) true for the default animation or a standard Element animation config object",
+ "desc" : "(optional) The value to apply to the given property, or null if an object was passed.",
"isOptional" : false
}
],
]
},
{
- "name" : "anchorTo",
+ "name" : "setTop",
"type" : "function",
- "desc" : "Anchors an element to another element and realigns it when the window is resized.",
- "sig" : "(element, position, offsets, animate, monitorScroll, callback)",
+ "desc" : "Sets the element's top position directly using CSS style (instead of {@link #setY}).",
+ "sig" : "(top)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "element",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The element to align to.",
- "isOptional" : false
- },
- {
- "name" : "position",
+ "name" : "top",
"type" : "String",
- "desc" : "The position to align to.",
- "isOptional" : false
- },
- {
- "name" : "offsets",
- "type" : "Array",
- "desc" : "(optional) Offset the positioning by [x, y]",
- "isOptional" : false
- },
- {
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) True for the default animation or a standard Element animation config object",
- "isOptional" : false
- },
- {
- "name" : "monitorScroll",
- "type" : "Boolean/Number",
- "desc" : "(optional) True to monitor body scroll and reposition. If this parameter\nis a number, it is used as the buffer delay (defaults to 50ms).",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "The function to call after the animation finishes",
+ "desc" : "The top CSS property value",
"isOptional" : false
}
],
]
},
{
- "name" : "animate",
+ "name" : "setVisibilityMode",
"type" : "function",
- "desc" : "Perform animation on this element.",
- "sig" : "(args, duration, onComplete, easing, animType)",
+ "desc" : "Sets the element's visibility mode. When setVisible() is called it\nwill use this to determine whether to set the visibility or the display property.",
+ "sig" : "(visMode)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "args",
- "type" : "Object",
- "desc" : "The YUI animation control args",
- "isOptional" : false
- },
- {
- "name" : "duration",
- "type" : "Float",
- "desc" : "(optional) How long the animation lasts in seconds (defaults to .35)",
- "isOptional" : false
- },
- {
- "name" : "onComplete",
- "type" : "Function",
- "desc" : "(optional) Function to call when animation completes",
- "isOptional" : false
- },
- {
- "name" : "easing",
- "type" : "String",
- "desc" : "(optional) Easing method to use (defaults to 'easeOut')",
- "isOptional" : false
- },
- {
- "name" : "animType",
- "type" : "String",
- "desc" : "(optional) 'run' is the default. Can also be 'color', 'motion', or 'scroll'",
+ "name" : "visMode",
+ "type" : "",
+ "desc" : "Element.VISIBILITY or Element.DISPLAY",
"isOptional" : false
}
],
]
},
{
- "name" : "appendChild",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Appends the passed element(s) to this element",
- "sig" : "(el)",
+ "desc" : "Sets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use\nthe display property to hide the element, otherwise it uses visibility. The default is to hide and show using the visibility property.",
+ "sig" : "(visible, animate)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Array/Element/CompositeElement",
- "desc" : "",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "Whether the element is visible",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) True for the default animation, or a standard Element animation config object",
"isOptional" : false
}
],
]
},
{
- "name" : "appendTo",
+ "name" : "setWidth",
"type" : "function",
- "desc" : "Appends this element to the passed element",
- "sig" : "(el)",
+ "desc" : "Set the width of the element",
+ "sig" : "(width, animate)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The new parent element",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The new width",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
"isOptional" : false
}
],
]
},
{
- "name" : "applyStyles",
+ "name" : "setX",
"type" : "function",
- "desc" : "More flexible version of {@link #setStyle} for setting style properties.",
- "sig" : "(styles)",
+ "desc" : "Sets the X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
+ "sig" : "(The, animate)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "styles",
- "type" : "String/Object/Function",
- "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
+ "name" : "The",
+ "type" : "Number",
+ "desc" : "X position of the element",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) True for the default animation, or a standard Element animation config object",
"isOptional" : false
}
],
]
},
{
- "name" : "attr",
+ "name" : "setXY",
"type" : "function",
- "desc" : "Sets or Returns the value the dom attribute value",
- "sig" : "(name, value)",
+ "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
+ "sig" : "(pos, animate)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "name",
- "type" : "String|Object",
- "desc" : "The attribute name (or object to set multiple attributes)",
+ "name" : "pos",
+ "type" : "Array",
+ "desc" : "Contains X & Y [x, y] values for new position (coordinates are page-based)",
"isOptional" : false
},
{
- "name" : "value",
- "type" : "String",
- "desc" : "(optional) The value to set the attribute to",
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) True for the default animation, or a standard Element animation config object",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "The attribute value"
+ "type" : "Roo.Element",
+ "desc" : "this"
}
]
},
{
- "name" : "autoHeight",
+ "name" : "setY",
"type" : "function",
- "desc" : "Measures the element's content height and updates height to match. Note: this function uses setTimeout so\nthe new height may not be available immediately.",
- "sig" : "(animate, duration, onComplete, easing)",
+ "desc" : "Sets the Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
+ "sig" : "(The, animate)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "animate",
- "type" : "Boolean",
- "desc" : "(optional) Animate the transition (defaults to false)",
- "isOptional" : false
- },
- {
- "name" : "duration",
- "type" : "Float",
- "desc" : "(optional) Length of the animation in seconds (defaults to .35)",
- "isOptional" : false
- },
- {
- "name" : "onComplete",
- "type" : "Function",
- "desc" : "(optional) Function to call when animation completes",
+ "name" : "The",
+ "type" : "Number",
+ "desc" : "Y position of the element",
"isOptional" : false
},
{
- "name" : "easing",
- "type" : "String",
- "desc" : "(optional) Easing method to use (defaults to easeOut)",
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) True for the default animation, or a standard Element animation config object",
"isOptional" : false
}
],
]
},
{
- "name" : "beginMeasure",
+ "name" : "show",
"type" : "function",
- "desc" : "Temporarily enables offsets (width,height,x,y) for an element with display:none, use endMeasure() when done.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Show this element - Uses display mode to determine whether to use \"display\" or \"visibility\". See {@link #setVisible}.",
+ "sig" : "(animate)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
]
},
{
- "name" : "blur",
+ "name" : "swallowEvent",
"type" : "function",
- "desc" : "Tries to blur the element. Any exceptions are caught and ignored.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Stops the specified event from bubbling and optionally prevents the default action",
+ "sig" : "(eventName, preventDefault)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "(optional) true to prevent the default action too",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
]
},
{
- "name" : "boxWrap",
+ "name" : "toggle",
"type" : "function",
- "desc" : "Wraps the specified element with a special markup/CSS block that renders by default as a gray container with a\ngradient background, rounded corners and a 4-way shadow.",
- "sig" : "(class)",
+ "desc" : "Toggles the element's visibility or display, depending on visibility mode.",
+ "sig" : "(animate)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "class",
- "type" : "String",
- "desc" : "(optional) A base CSS class to apply to the containing wrapper element (defaults to 'x-box').\nNote that there are a number of CSS rules that are dependent on this name to make the overall effect work,\nso if you supply an alternate base class, make sure you also supply all of the necessary rules.",
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) True for the default animation, or a standard Element animation config object",
"isOptional" : false
}
],
]
},
{
- "name" : "center",
+ "name" : "toggleClass",
"type" : "function",
- "desc" : "Centers the Element in either the viewport, or another Element.",
- "sig" : "(centerIn)",
+ "desc" : "Toggles the specified CSS class on this element (removes it if it already exists, otherwise adds it).",
+ "sig" : "(className)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "centerIn",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "(optional) The element in which to center the element.",
+ "name" : "className",
+ "type" : "String",
+ "desc" : "The CSS class to toggle",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "child",
+ "name" : "translatePoints",
"type" : "function",
- "desc" : "Selects a single child at any depth below this element based on the passed CSS selector (the selector should not contain an id).",
- "sig" : "(selector, returnDom)",
+ "desc" : "Translates the passed page coordinates into left/top css values for this element",
+ "sig" : "(x, y)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "selector",
- "type" : "String",
- "desc" : "The CSS selector",
+ "name" : "x",
+ "type" : "Number/Array",
+ "desc" : "The page x or an array containing [x, y]",
"isOptional" : false
},
{
- "name" : "returnDom",
- "type" : "Boolean",
- "desc" : "(optional) True to return the DOM node instead of Roo.Element (defaults to false)",
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The page y",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The child Roo.Element (or DOM node if returnDom = true)"
+ "type" : "Object",
+ "desc" : "An object with left and top properties. e.g. {left: (value), top: (value)}"
}
]
},
{
- "name" : "clean",
+ "name" : "un",
"type" : "function",
- "desc" : "Removes worthless text nodes",
- "sig" : "(forceReclean)",
+ "desc" : "Removes an event handler from this element (shorthand for removeListener)",
+ "sig" : "(eventName, fn)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "forceReclean",
- "type" : "Boolean",
- "desc" : "(optional) By default the element\nkeeps track if it has been cleaned already so\nyou can call this over and over. However, if you update the element and\nneed to force a reclean, you can pass true.",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "the type of event to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "the method the event invokes",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "clearOpacity",
+ "name" : "unclip",
"type" : "function",
- "desc" : "Clears any opacity settings from this element. Required in some cases for IE.",
+ "desc" : "Return clipping (overflow) to original clipping before clip() was called",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
]
},
{
- "name" : "clearPositioning",
+ "name" : "unmask",
"type" : "function",
- "desc" : "Clear positioning back to the default when the document was loaded",
- "sig" : "(value)",
+ "desc" : "Removes a previously applied mask. If removeEl is true the mask overlay is destroyed, otherwise\nit is cached for reuse.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "String",
- "desc" : "(optional) The value to use for the left,right,top,bottom, defaults to '' (empty string). You could use 'auto'.",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "clip",
+ "name" : "unselectable",
"type" : "function",
- "desc" : "Store the current overflow setting and clip overflow on the element - use {@link #unclip} to remove",
+ "desc" : "Disables text selection for this element (normalized across browsers)",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
]
},
{
- "name" : "contains",
+ "name" : "up",
"type" : "function",
- "desc" : "Returns true if this element is an ancestor of the passed element",
- "sig" : "(el)",
+ "desc" : "Walks up the dom looking for a parent node that matches the passed simple selector (e.g. div.some-class or span:first-child).\nThis is a shortcut for findParentNode() that always returns an Roo.Element.",
+ "sig" : "(selector, maxDepth)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "HTMLElement/String",
- "desc" : "The element to check",
+ "name" : "selector",
+ "type" : "String",
+ "desc" : "The simple selector to test",
+ "isOptional" : false
+ },
+ {
+ "name" : "maxDepth",
+ "type" : "Number/String/HTMLElement/Element",
+ "desc" : "(optional) The max depth to\n search as a number or element (defaults to 10 || document.body)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if this element is an ancestor of el, else false"
+ "type" : "Roo.Element",
+ "desc" : "The matching DOM node (or null if no match was found)"
}
]
},
{
- "name" : "createChild",
+ "name" : "update",
"type" : "function",
- "desc" : "Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child element.",
- "sig" : "(config, insertBefore, returnDom)",
+ "desc" : "Update the innerHTML of this element, optionally searching for and processing scripts",
+ "sig" : "(html, loadScripts, callback)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "config",
- "type" : "Object",
- "desc" : "DomHelper element config object. If no tag is specified (e.g., {tag:'input'}) then a div will be\nautomatically generated with the specified attributes.",
+ "name" : "html",
+ "type" : "String",
+ "desc" : "The new HTML",
"isOptional" : false
},
{
- "name" : "insertBefore",
- "type" : "HTMLElement",
- "desc" : "(optional) a child element of this element",
+ "name" : "loadScripts",
+ "type" : "Boolean",
+ "desc" : "(optional) true to look for and process scripts",
"isOptional" : false
},
{
- "name" : "returnDom",
- "type" : "Boolean",
- "desc" : "(optional) true to return the dom node instead of creating an Element",
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "For async script loading you can be noticed when the update completes",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "The new child element"
+ "desc" : "this"
}
]
},
{
- "name" : "createProxy",
+ "name" : "wrap",
"type" : "function",
- "desc" : "Creates a proxy element of this element",
- "sig" : "(config, renderTo, matchBox)",
+ "desc" : "Creates and wraps this element with another element",
+ "sig" : "(config, returnDom)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"params" : [
{
"name" : "config",
- "type" : "String/Object",
- "desc" : "The class name of the proxy element or a DomHelper config object",
- "isOptional" : false
- },
- {
- "name" : "renderTo",
- "type" : "String/HTMLElement",
- "desc" : "(optional) The element or element id to render the proxy to (defaults to document.body)",
+ "type" : "Object",
+ "desc" : "(optional) DomHelper element config object for the wrapper element or null for an empty div",
"isOptional" : false
},
{
- "name" : "matchBox",
+ "name" : "returnDom",
"type" : "Boolean",
- "desc" : "(optional) True to align and size the proxy to this element now (defaults to false)",
+ "desc" : "(optional) True to return the raw DOM element instead of Roo.Element",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The new proxy element"
+ "type" : "HTMLElement/Element",
+ "desc" : "The newly created wrapper element"
}
]
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.Layer"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.EventManager" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "createShim",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Creates an iframe shim for this element to keep selects and other windowed objects from\nshowing through.",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "desc" : "Appends an event handler to an element (shorthand for addListener)",
+ "sig" : "(element, eventName, handler, scope, options)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The new shim element"
+ "name" : "element",
+ "type" : "String/HTMLElement",
+ "desc" : "The html element or id to assign the",
+ "isOptional" : false
+ },
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delegate {String} A simple selector to filter the target or look for a descendant of the target</li>\n<li>stopEvent {Boolean} True to stop the event. That is stop propagation, and prevent the default action.</li>\n<li>preventDefault {Boolean} True to prevent the default action</li>\n<li>stopPropagation {Boolean} True to prevent event propagation</li>\n<li>normalized {Boolean} False to pass a browser event to the handler function instead of an Roo.EventObject</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<div style=\"margin: 5px 20px 20px;\">\nCode:<pre><code>\nel.on('click', this.onClick, this, {\n single: true,\n delay: 100,\n stopEvent : true,\n forumId: 4\n});</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<p>\nCode:<pre><code>\nel.on({\n 'click' : {\n fn: this.onClick\n scope: this,\n delay: 100\n },\n 'mouseover' : {\n fn: this.onMouseOver\n scope: this\n },\n 'mouseout' : {\n fn: this.onMouseOut\n scope: this\n }\n});</code></pre>\n<p>\nOr a shorthand syntax:<br>\nCode:<pre><code>\nel.on({\n 'click' : this.onClick,\n 'mouseover' : this.onMouseOver,\n 'mouseout' : this.onMouseOut\n scope: this\n});</code></pre>",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "down",
+ "name" : "on",
"type" : "function",
- "desc" : "Selects a single *direct* child based on the passed CSS selector (the selector should not contain an id).",
- "sig" : "(selector, returnDom)",
- "static" : false,
+ "desc" : "Appends an event handler to an element (shorthand for addListener)",
+ "sig" : "(element, eventName, handler, scope, options)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "selector",
+ "name" : "element",
+ "type" : "String/HTMLElement",
+ "desc" : "The html element or id to assign the",
+ "isOptional" : false
+ },
+ {
+ "name" : "eventName",
"type" : "String",
- "desc" : "The CSS selector",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "returnDom",
- "type" : "Boolean",
- "desc" : "(optional) True to return the DOM node instead of Roo.Element (defaults to false)",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The child Roo.Element (or DOM node if returnDom = true)"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delegate {String} A simple selector to filter the target or look for a descendant of the target</li>\n<li>stopEvent {Boolean} True to stop the event. That is stop propagation, and prevent the default action.</li>\n<li>preventDefault {Boolean} True to prevent the default action</li>\n<li>stopPropagation {Boolean} True to prevent event propagation</li>\n<li>normalized {Boolean} False to pass a browser event to the handler function instead of an Roo.EventObject</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<div style=\"margin: 5px 20px 20px;\">\nCode:<pre><code>\nel.on('click', this.onClick, this, {\n single: true,\n delay: 100,\n stopEvent : true,\n forumId: 4\n});</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<p>\nCode:<pre><code>\nel.on({\n 'click' : {\n fn: this.onClick\n scope: this,\n delay: 100\n },\n 'mouseover' : {\n fn: this.onMouseOver\n scope: this\n },\n 'mouseout' : {\n fn: this.onMouseOut\n scope: this\n }\n});</code></pre>\n<p>\nOr a shorthand syntax:<br>\nCode:<pre><code>\nel.on({\n 'click' : this.onClick,\n 'mouseover' : this.onMouseOver,\n 'mouseout' : this.onMouseOut\n scope: this\n});</code></pre>",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "enableDisplayMode",
+ "name" : "onDocumentReady",
"type" : "function",
- "desc" : "Convenience method for setVisibilityMode(Element.DISPLAY)",
- "sig" : "(display)",
- "static" : false,
+ "desc" : "Fires when the document is ready (before onload and before images are loaded). Can be \naccessed shorthanded Roo.onReady().",
+ "sig" : "(fn, scope, options)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "display",
- "type" : "String",
- "desc" : "(optional) What to set display to when visible",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "An object that becomes the scope of the handler",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "boolean",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "endMeasure",
+ "name" : "onTextResize",
"type" : "function",
- "desc" : "Restores displays to before beginMeasure was called",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "desc" : "Fires when the user changes the active text size. Handler gets called with 2 params, the old size and the new size.",
+ "sig" : "(fn, scope, options)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "An object that becomes the scope of the handler",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "boolean",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "findParent",
+ "name" : "onWindowResize",
"type" : "function",
- "desc" : "Looks at this node and then at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)",
- "sig" : "(selector, maxDepth, returnEl)",
- "static" : false,
+ "desc" : "Fires when the window is resized and provides resize event buffering (50 milliseconds), passes new viewport width and height to handlers.",
+ "sig" : "(fn, scope, options)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "selector",
- "type" : "String",
- "desc" : "The simple selector to test",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "maxDepth",
- "type" : "Number/String/HTMLElement/Element",
- "desc" : "(optional) The max depth to\n search as a number or element (defaults to 10 || document.body)",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "An object that becomes the scope of the handler",
"isOptional" : false
},
{
- "name" : "returnEl",
- "type" : "Boolean",
- "desc" : "(optional) True to return a Roo.Element object instead of DOM node",
+ "name" : "options",
+ "type" : "boolean",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "HTMLElement",
- "desc" : "The matching DOM node (or null if no match was found)"
- }
- ]
+ "returns" : []
},
{
- "name" : "findParentNode",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)",
- "sig" : "(selector, maxDepth, returnEl)",
- "static" : false,
+ "desc" : "Removes an event handler",
+ "sig" : "(element, eventName, fn)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "selector",
- "type" : "String",
- "desc" : "The simple selector to test",
+ "name" : "element",
+ "type" : "String/HTMLElement",
+ "desc" : "The id or html element to remove the \n event from",
"isOptional" : false
},
{
- "name" : "maxDepth",
- "type" : "Number/String/HTMLElement/Element",
- "desc" : "(optional) The max depth to\n search as a number or element (defaults to 10 || document.body)",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event",
"isOptional" : false
},
{
- "name" : "returnEl",
- "type" : "Boolean",
- "desc" : "(optional) True to return a Roo.Element object instead of DOM node",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "HTMLElement",
- "desc" : "The matching DOM node (or null if no match was found)"
+ "type" : "Boolean",
+ "desc" : "True if a listener was actually removed"
}
]
},
{
- "name" : "findScrollableParent",
+ "name" : "removeResizeListener",
"type" : "function",
- "desc" : "Looks at the scrollable parent element",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "desc" : "Removes the passed window resize listener.",
+ "sig" : "(fn, scope)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "The scope of handler",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "fitToParent",
+ "name" : "wrap",
"type" : "function",
- "desc" : "Sizes this element to its parent element's dimensions performing\nneccessary box adjustments.",
- "sig" : "(monitorResize, targetParent)",
- "static" : false,
+ "desc" : "This is no longer needed and is deprecated. Places a simple wrapper around an event handler to override the browser event\nobject with a Roo.EventObject",
+ "sig" : "(fn, scope, override)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
- "deprecated" : "",
+ "deprecated" : "This has been deprecated: ",
"since" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
"params" : [
{
- "name" : "monitorResize",
- "type" : "Boolean",
- "desc" : "(optional) If true maintains the fit when the browser window is resized.",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "targetParent",
- "type" : "String/HTMLElment/Element",
- "desc" : "(optional) The target parent, default to the parentNode.",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "An object that becomes the scope of the handler",
+ "isOptional" : false
+ },
+ {
+ "name" : "override",
+ "type" : "boolean",
+ "desc" : "If true, the obj passed in becomes\n the execution scope of the listener",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "type" : "Function",
+ "desc" : "The wrapped function"
}
]
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.EventObject" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "fly",
+ "name" : "getCharCode",
"type" : "function",
- "desc" : "Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element -\nthe dom node can be overwritten by other code.",
- "sig" : "(el, named)",
- "static" : true,
+ "desc" : "Gets the key code for the event.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement",
- "desc" : "The dom node or id",
- "isOptional" : false
- },
- {
- "name" : "named",
- "type" : "String",
- "desc" : "(optional) Allows for creation of named reusable flyweights to\n prevent conflicts (e.g. internally Roo uses \"_internal\")",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Element",
- "desc" : "The shared Element object"
+ "type" : "Number",
+ "desc" : ""
}
]
},
{
- "name" : "focus",
+ "name" : "getKey",
"type" : "function",
- "desc" : "Tries to focus the element. Any exceptions are caught and ignored.",
+ "desc" : "Returns a normalized keyCode for the event.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "type" : "Number",
+ "desc" : "The key code"
}
]
},
{
- "name" : "get",
+ "name" : "getPageX",
"type" : "function",
- "desc" : "Static method to retrieve Element objects. Uses simple caching to consistently return the same object.\nAutomatically fixes if an object was recreated with the same id via AJAX or DOM.",
- "sig" : "(el)",
- "static" : true,
+ "desc" : "Gets the x coordinate of the event.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id of the node, a DOM Node or an existing Element.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Element",
- "desc" : "The Element object"
+ "type" : "Number",
+ "desc" : ""
}
]
},
{
- "name" : "getAlignToXY",
+ "name" : "getPageY",
"type" : "function",
- "desc" : "Gets the x,y coordinates to align this element with another element. See {@link #alignTo} for more info on the\nsupported position values.",
- "sig" : "(element, position, offsets)",
+ "desc" : "Gets the y coordinate of the event.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "element",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The element to align to.",
- "isOptional" : false
- },
- {
- "name" : "position",
- "type" : "String",
- "desc" : "The position to align to.",
- "isOptional" : false
- },
- {
- "name" : "offsets",
- "type" : "Array",
- "desc" : "(optional) Offset the positioning by [x, y]",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Array",
- "desc" : "[x, y]"
+ "type" : "Number",
+ "desc" : ""
}
]
},
{
- "name" : "getAnchorXY",
+ "name" : "getRelatedTarget",
"type" : "function",
- "desc" : "Gets the x,y coordinates specified by the anchor position on the element.",
- "sig" : "(anchor, size, local)",
+ "desc" : "Gets the related target.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "anchor",
- "type" : "String",
- "desc" : "(optional) The specified anchor position (defaults to \"c\"). See {@link #alignTo} for details on supported anchor positions.",
- "isOptional" : false
- },
- {
- "name" : "size",
- "type" : "Object",
- "desc" : "(optional) An object containing the size to use for calculating anchor position\n {width: (target width), height: (target height)} (defaults to the element's current size)",
- "isOptional" : false
- },
- {
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) True to get the local (element top/left-relative) anchor position instead of page coordinates",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Array",
- "desc" : "[x, y] An array containing the element's x and y coordinates"
+ "type" : "HTMLElement",
+ "desc" : ""
}
]
},
{
- "name" : "getAttributeNS",
+ "name" : "getTarget",
"type" : "function",
- "desc" : "Returns the value of a namespaced attribute from the element's underlying DOM node.",
- "sig" : "(namespace, name)",
+ "desc" : "Gets the target for the event.",
+ "sig" : "(selector, maxDepth, returnEl)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "namespace",
+ "name" : "selector",
"type" : "String",
- "desc" : "The namespace in which to look for the attribute",
+ "desc" : "(optional) A simple selector to filter the target or look for an ancestor of the target",
"isOptional" : false
},
{
- "name" : "name",
- "type" : "String",
- "desc" : "The attribute name",
+ "name" : "maxDepth",
+ "type" : "Number/String/HTMLElement/Element",
+ "desc" : "(optional) The max depth to\n search as a number or element (defaults to 10 || document.body)",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnEl",
+ "type" : "Boolean",
+ "desc" : "(optional) True to return a Roo.Element object instead of DOM node",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "The attribute value"
+ "type" : "HTMLelement",
+ "desc" : ""
}
]
},
{
- "name" : "getBorderWidth",
+ "name" : "getTime",
"type" : "function",
- "desc" : "Gets the width of the border(s) for the specified side(s)",
- "sig" : "(side)",
+ "desc" : "Gets the time of the event.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "side",
- "type" : "String",
- "desc" : "Can be t, l, r, b or any combination of those to add multiple values. For example,\npassing lr would get the border (l)eft width + the border (r)ight width.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
"type" : "Number",
- "desc" : "The width of the sides passed added together"
+ "desc" : ""
}
]
},
{
- "name" : "getBottom",
+ "name" : "getWheelDelta",
"type" : "function",
- "desc" : "Gets the bottom Y coordinate of the element (element Y position + element height)",
- "sig" : "(local)",
+ "desc" : "Normalizes mouse wheel delta across browsers",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "local",
- "type" : "Boolean",
- "desc" : "True to get the local css position instead of page coordinate",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
"type" : "Number",
- "desc" : ""
+ "desc" : "The delta"
}
]
},
{
- "name" : "getBox",
+ "name" : "getXY",
"type" : "function",
- "desc" : "Return a box {x, y, width, height} that can be used to set another elements\nsize/location to match this element.",
- "sig" : "(contentBox, local)",
+ "desc" : "Gets the page coordinates of the event.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "contentBox",
- "type" : "Boolean",
- "desc" : "(optional) If true a box for the content of the element is returned.",
- "isOptional" : false
- },
- {
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page x/y.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "box An object in the format {x, y, width, height}"
+ "type" : "Array",
+ "desc" : "The xy values like [x, y]"
}
]
},
{
- "name" : "getCenterXY",
+ "name" : "hasModifier",
"type" : "function",
- "desc" : "Calculates the x, y to center this element on the screen",
+ "desc" : "Returns true if the control, meta, shift or alt key was pressed during this event.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : [
{
"name" : "",
- "type" : "Array",
- "desc" : "The x, y values [x, y]"
+ "type" : "Boolean",
+ "desc" : ""
}
]
},
{
- "name" : "getColor",
+ "name" : "preventDefault",
"type" : "function",
- "desc" : "Return the CSS color for the specified CSS attribute. rgb, 3 digit (like #fff) and valid values\nare convert to standard 6 digit hex color.",
- "sig" : "(attr, defaultValue, prefix)",
+ "desc" : "Prevents the browsers default handling of the event.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "attr",
- "type" : "String",
- "desc" : "The css attribute",
- "isOptional" : false
- },
- {
- "name" : "defaultValue",
- "type" : "String",
- "desc" : "The default value to use when a valid color isn't found",
- "isOptional" : false
- },
- {
- "name" : "prefix",
- "type" : "String",
- "desc" : "(optional) defaults to #. Use an empty string when working with\nYUI color anims.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "getComputedHeight",
+ "name" : "stopEvent",
"type" : "function",
- "desc" : "Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders\nwhen needed to simulate offsetHeight when offsets aren't available. This may not work on display:none elements\nif a height has not been set using CSS.",
+ "desc" : "Stop the event (preventDefault and stopPropagation)",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getComputedWidth",
+ "name" : "stopPropagation",
"type" : "function",
- "desc" : "Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders\nwhen needed to simulate offsetWidth when offsets aren't available. This may not work on display:none elements\nif a width has not been set using CSS.",
+ "desc" : "Cancels bubbling of the event.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getFrameWidth",
+ "name" : "within",
"type" : "function",
- "desc" : "Returns the sum width of the padding and borders for the passed \"sides\". See getBorderWidth()\n for more information about the sides.",
- "sig" : "(sides)",
+ "desc" : "Returns true if the target of this event equals el or is a child of el",
+ "sig" : "(el, related)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "sides",
- "type" : "String",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "related",
+ "type" : "Boolean",
+ "desc" : "(optional) true to test if the related target is within el instead of the target",
+ "isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
+ "type" : "Boolean",
"desc" : ""
}
]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.Fx" : {
+ "props" : [
+ {
+ "name" : "afterCls",
+ "type" : "String",
+ "desc" : "A css class to apply after the effect",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "getHeight",
+ "name" : "afterStyle",
+ "type" : "String/Object/Function",
+ "desc" : "A style specification string, e.g. \"width:100px\", or an object in the form {width:\"100px\"}, or\na function which returns such a specification that will be applied to the Element after the effect finishes",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "block",
+ "type" : "Boolean",
+ "desc" : "Whether the effect should block other effects from queueing while it runs",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "A function called when the effect is finished",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "concurrent",
+ "type" : "Boolean",
+ "desc" : "Whether to allow subsequently-queued effects to run at the same time as the current effect, or to ensure that they run in sequence",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "duration",
+ "type" : "Number",
+ "desc" : "The length of time (in seconds) that the effect should last",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "easing",
+ "type" : "String",
+ "desc" : "A valid Easing value for the effect",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "remove",
+ "type" : "Boolean",
+ "desc" : "Whether the Element should be removed from the DOM and destroyed after the effect finishes",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "The scope of the effect function",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "stopFx",
+ "type" : "Boolean",
+ "desc" : "Whether subsequent effects should be stopped and removed after the current effect finishes",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "useDisplay",
+ "type" : "Boolean",
+ "desc" : "Whether to use the <i>display</i> CSS property instead of <i>visibility</i> when hiding Elements (only applies to \neffects that end with the element being visually hidden, ignored otherwise)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "fadeIn",
"type" : "function",
- "desc" : "Returns the offset height of the element",
- "sig" : "(contentHeight)",
- "static" : false,
+ "desc" : "Fade an element in (from transparent to opaque). The ending opacity can be specified\nusing the \"endOpacity\" config option.\nUsage:\n<pre><code>\n// default: fade in from opacity 0 to 100%\nel.fadeIn();\n\n// custom: fade in from opacity 0 to 75% over 2 seconds\nel.fadeIn({ endOpacity: .75, duration: 2});\n\n// common config options shown with default values\nel.fadeIn({\n endOpacity: 1, //can be any value between 0 and 1 (e.g. .5)\n easing: 'easeOut',\n duration: .5\n});\n</code></pre>",
+ "sig" : "(options)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "contentHeight",
- "type" : "Boolean",
- "desc" : "(optional) true to get the height minus borders and padding",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) Object literal with any of the Fx config options",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "The element's height"
+ "type" : "Roo.Element",
+ "desc" : "The Element"
}
]
},
{
- "name" : "getLeft",
+ "name" : "fadeOut",
"type" : "function",
- "desc" : "Gets the left X coordinate",
- "sig" : "(local)",
- "static" : false,
+ "desc" : "Fade an element out (from opaque to transparent). The ending opacity can be specified\nusing the \"endOpacity\" config option.\nUsage:\n<pre><code>\n// default: fade out from the element's current opacity to 0\nel.fadeOut();\n\n// custom: fade out from the element's current opacity to 25% over 2 seconds\nel.fadeOut({ endOpacity: .25, duration: 2});\n\n// common config options shown with default values\nel.fadeOut({\n endOpacity: 0, //can be any value between 0 and 1 (e.g. .5)\n easing: 'easeOut',\n duration: .5\n remove: false,\n useDisplay: false\n});\n</code></pre>",
+ "sig" : "(options)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "local",
- "type" : "Boolean",
- "desc" : "True to get the local css position instead of page coordinate",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) Object literal with any of the Fx config options",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "The Element"
}
]
},
{
- "name" : "getMargins",
+ "name" : "frame",
"type" : "function",
- "desc" : "Returns an object with properties top, left, right and bottom representing the margins of this element unless sides is passed,\nthen it returns the calculated width of the sides (see getPadding)",
- "sig" : "(sides)",
- "static" : false,
+ "desc" : "Shows a ripple of exploding, attenuating borders to draw attention to an Element.\nUsage:\n<pre><code>\n// default: a single light blue ripple\nel.frame();\n\n// custom: 3 red ripples lasting 3 seconds total\nel.frame(\"ff0000\", 3, { duration: 3 });\n\n// common config options shown with default values\nel.frame(\"C3DAF9\", 1, {\n duration: 1 //duration of entire animation (not each individual ripple)\n // Note: Easing is not configurable and will be ignored if included\n});\n</code></pre>",
+ "sig" : "(color, count, options)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "sides",
+ "name" : "color",
"type" : "String",
- "desc" : "(optional) Any combination of l, r, t, b to get the sum of those sides",
+ "desc" : "(optional) The color of the border. Should be a 6 char hex color without the leading # (defaults to light blue: 'C3DAF9').",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Object/Number",
- "desc" : ""
+ "name" : "count",
+ "type" : "Number",
+ "desc" : "(optional) The number of ripples to display (defaults to 1)",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) Object literal with any of the Fx config options",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "getNextSibling",
- "type" : "function",
- "desc" : "Gets the next sibling, skipping text nodes",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ ],
"returns" : [
{
"name" : "",
- "type" : "HTMLElement",
- "desc" : "The next sibling or null"
+ "type" : "Roo.Element",
+ "desc" : "The Element"
}
]
},
{
- "name" : "getPadding",
+ "name" : "ghost",
"type" : "function",
- "desc" : "Gets the width of the padding(s) for the specified side(s)",
- "sig" : "(side)",
- "static" : false,
+ "desc" : "Slides the element while fading it out of view. An anchor point can be optionally passed to set the \nending point of the effect.\nUsage:\n<pre><code>\n// default: slide the element downward while fading out\nel.ghost();\n\n// custom: slide the element out to the right with a 2-second duration\nel.ghost('r', { duration: 2 });\n\n// common config options shown with default values\nel.ghost('b', {\n easing: 'easeOut',\n duration: .5\n remove: false,\n useDisplay: false\n});\n</code></pre>",
+ "sig" : "(anchor, options)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "side",
+ "name" : "anchor",
"type" : "String",
- "desc" : "Can be t, l, r, b or any combination of those to add multiple values. For example,\npassing lr would get the padding (l)eft + the padding (r)ight.",
+ "desc" : "(optional) One of the valid Fx anchor positions (defaults to bottom: 'b')",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) Object literal with any of the Fx config options",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "The padding of the sides passed added together"
+ "type" : "Roo.Element",
+ "desc" : "The Element"
}
]
},
{
- "name" : "getPositioning",
+ "name" : "hasActiveFx",
"type" : "function",
- "desc" : "Gets an object with all CSS positioning properties. Useful along with setPostioning to get\nsnapshot before performing an update and then restoring the element.",
+ "desc" : "Returns true if the element has any effects actively running or queued, else returns false.",
"sig" : "()\n{\n\n}",
- "static" : false,
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : ""
+ "type" : "Boolean",
+ "desc" : "True if element has active effects, else false"
}
]
},
{
- "name" : "getPrevSibling",
+ "name" : "hasFxBlock",
"type" : "function",
- "desc" : "Gets the previous sibling, skipping text nodes",
+ "desc" : "Returns true if the element is currently blocking so that no other effect can be queued\nuntil this effect is finished, else returns false if blocking is not set. This is commonly\nused to ensure that an effect initiated by a user action runs to completion prior to the\nsame effect being restarted (e.g., firing only one effect even if the user clicks several times).",
"sig" : "()\n{\n\n}",
- "static" : false,
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"returns" : [
{
"name" : "",
- "type" : "HTMLElement",
- "desc" : "The previous sibling or null"
+ "type" : "Boolean",
+ "desc" : "True if blocking, else false"
}
]
},
{
- "name" : "getRegion",
+ "name" : "highlight",
"type" : "function",
- "desc" : "Returns the region of the given element.\nThe element must be part of the DOM tree to have a region (display:none or elements not appended return false).",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "desc" : "Highlights the Element by setting a color (applies to the background-color by default, but can be\nchanged using the \"attr\" config option) and then fading back to the original color. If no original\ncolor is available, you should provide the \"endColor\" config option which will be cleared after the animation.\nUsage:\n<pre><code>\n// default: highlight background to yellow\nel.highlight();\n\n// custom: highlight foreground text to blue for 2 seconds\nel.highlight(\"0000ff\", { attr: 'color', duration: 2 });\n\n// common config options shown with default values\nel.highlight(\"ffff9c\", {\n attr: \"background-color\", //can be any valid CSS property (attribute) that supports a color value\n endColor: (current color) or \"ffffff\",\n easing: 'easeIn',\n duration: 1\n});\n</code></pre>",
+ "sig" : "(color, options)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "color",
+ "type" : "String",
+ "desc" : "(optional) The highlight color. Should be a 6 char hex color without the leading # (defaults to yellow: 'ffff9c')",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) Object literal with any of the Fx config options",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Region",
- "desc" : "A Roo.lib.Region containing \"top, left, bottom, right\" member data."
+ "type" : "Roo.Element",
+ "desc" : "The Element"
}
]
},
{
- "name" : "getRight",
+ "name" : "pause",
"type" : "function",
- "desc" : "Gets the right X coordinate of the element (element X position + element width)",
- "sig" : "(local)",
- "static" : false,
+ "desc" : "Creates a pause before any subsequent queued effects begin. If there are\nno effects queued after the pause it will have no effect.\nUsage:\n<pre><code>\nel.pause(1);\n</code></pre>",
+ "sig" : "(seconds)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "local",
- "type" : "Boolean",
- "desc" : "True to get the local css position instead of page coordinate",
+ "name" : "seconds",
+ "type" : "Number",
+ "desc" : "The length of time to pause (in seconds)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "The Element"
}
]
},
{
- "name" : "getScroll",
+ "name" : "puff",
"type" : "function",
- "desc" : "Returns the current scroll position of the element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "desc" : "Fades the element out while slowly expanding it in all directions. When the effect is completed, the \nelement will be hidden (visibility = 'hidden') but block elements will still take up space in the document. \nThe element must be removed from the DOM using the 'remove' config option if desired.\nUsage:\n<pre><code>\n// default\nel.puff();\n\n// common config options shown with default values\nel.puff({\n easing: 'easeOut',\n duration: .5,\n remove: false,\n useDisplay: false\n});\n</code></pre>",
+ "sig" : "(options)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) Object literal with any of the Fx config options",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "An object containing the scroll position in the format {left: (scrollLeft), top: (scrollTop)}"
+ "type" : "Roo.Element",
+ "desc" : "The Element"
}
]
},
{
- "name" : "getSize",
+ "name" : "scale",
"type" : "function",
- "desc" : "Returns the size of the element.",
- "sig" : "(contentSize)",
- "static" : false,
+ "desc" : "Animates the transition of an element's dimensions from a starting height/width\nto an ending height/width.\nUsage:\n<pre><code>\n// change height and width to 100x100 pixels\nel.scale(100, 100);\n\n// common config options shown with default values. The height and width will default to\n// the element's existing values if passed as null.\nel.scale(\n [element's width],\n [element's height], {\n easing: 'easeOut',\n duration: .35\n});\n</code></pre>",
+ "sig" : "(width, height, options)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "contentSize",
- "type" : "Boolean",
- "desc" : "(optional) true to get the width/size minus borders and padding",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The new width (pass undefined to keep the original width)",
+ "isOptional" : false
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height (pass undefined to keep the original height)",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) Object literal with any of the Fx config options",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
+ "type" : "Roo.Element",
+ "desc" : "The Element"
}
]
},
{
- "name" : "getStyle",
+ "name" : "sequenceFx",
"type" : "function",
- "desc" : "Normalizes currentStyle and computedStyle. This is not YUI getStyle, it is an optimised version.",
- "sig" : "(property)",
- "static" : false,
+ "desc" : "Ensures that all effects queued after sequenceFx is called on the element are\nrun in sequence. This is the opposite of {@link #syncFx}.",
+ "sig" : "()\n{\n\n}",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "property",
- "type" : "String",
- "desc" : "The style property whose value is returned.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "The current value of the style property for this element."
+ "type" : "Roo.Element",
+ "desc" : "The Element"
}
]
},
{
- "name" : "getStyles",
+ "name" : "shift",
"type" : "function",
- "desc" : "Returns an object with properties matching the styles requested.\nFor example, el.getStyles('color', 'font-size', 'width') might return\n{'color': '#FFFFFF', 'font-size': '13px', 'width': '100px'}.",
- "sig" : "(style1, style2)",
- "static" : false,
+ "desc" : "Animates the transition of any combination of an element's dimensions, xy position and/or opacity.\nAny of these properties not specified in the config object will not be changed. This effect \nrequires that at least one new dimension, position or opacity setting must be passed in on\nthe config object in order for the function to have any effect.\nUsage:\n<pre><code>\n// slide the element horizontally to x position 200 while changing the height and opacity\nel.shift({ x: 200, height: 50, opacity: .8 });\n\n// common config options shown with default values.\nel.shift({\n width: [element's width],\n height: [element's height],\n x: [element's x position],\n y: [element's y position],\n opacity: [element's opacity],\n easing: 'easeOut',\n duration: .35\n});\n</code></pre>",
+ "sig" : "(options)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "style1",
- "type" : "String",
- "desc" : "A style name",
- "isOptional" : false
- },
- {
- "name" : "style2",
- "type" : "String",
- "desc" : "A style name",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "Object literal with any of the Fx config options",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "The style object"
+ "type" : "Roo.Element",
+ "desc" : "The Element"
}
]
},
{
- "name" : "getTop",
+ "name" : "slideIn",
"type" : "function",
- "desc" : "Gets the top Y coordinate",
- "sig" : "(local)",
- "static" : false,
+ "desc" : "Slides the element into view. An anchor point can be optionally passed to set the point of\norigin for the slide effect. This function automatically handles wrapping the element with\na fixed-size container if needed. See the Fx class overview for valid anchor point options.\nUsage:\n<pre><code>\n// default: slide the element in from the top\nel.slideIn();\n\n// custom: slide the element in from the right with a 2-second duration\nel.slideIn('r', { duration: 2 });\n\n// common config options shown with default values\nel.slideIn('t', {\n easing: 'easeOut',\n duration: .5\n});\n</code></pre>",
+ "sig" : "(anchor, options)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "local",
- "type" : "Boolean",
- "desc" : "True to get the local css position instead of page coordinate",
+ "name" : "anchor",
+ "type" : "String",
+ "desc" : "(optional) One of the valid Fx anchor positions (defaults to top: 't')",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Number",
- "desc" : ""
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) Object literal with any of the Fx config options",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "getUpdateManager",
- "type" : "function",
- "desc" : "Gets this element's UpdateManager",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.UpdateManager",
- "desc" : "The UpdateManager"
+ "type" : "Roo.Element",
+ "desc" : "The Element"
}
]
},
{
- "name" : "getValue",
+ "name" : "slideOut",
"type" : "function",
- "desc" : "Returns the value of the \"value\" attribute",
- "sig" : "(asNumber)",
- "static" : false,
+ "desc" : "Slides the element out of view. An anchor point can be optionally passed to set the end point\nfor the slide effect. When the effect is completed, the element will be hidden (visibility = \n'hidden') but block elements will still take up space in the document. The element must be removed\nfrom the DOM using the 'remove' config option if desired. This function automatically handles \nwrapping the element with a fixed-size container if needed. See the Fx class overview for valid anchor point options.\nUsage:\n<pre><code>\n// default: slide the element out to the top\nel.slideOut();\n\n// custom: slide the element out to the right with a 2-second duration\nel.slideOut('r', { duration: 2 });\n\n// common config options shown with default values\nel.slideOut('t', {\n easing: 'easeOut',\n duration: .5,\n remove: false,\n useDisplay: false\n});\n</code></pre>",
+ "sig" : "(anchor, options)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "asNumber",
- "type" : "Boolean",
- "desc" : "true to parse the value as a number",
+ "name" : "anchor",
+ "type" : "String",
+ "desc" : "(optional) One of the valid Fx anchor positions (defaults to top: 't')",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) Object literal with any of the Fx config options",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "String/Number",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "The Element"
}
]
},
{
- "name" : "getViewSize",
+ "name" : "stopFx",
"type" : "function",
- "desc" : "Returns the width and height of the viewport.",
+ "desc" : "Stops any running effects and clears the element's internal effects queue if it contains\nany additional effects that haven't started yet.",
"sig" : "()\n{\n\n}",
- "static" : false,
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "An object containing the viewport's size {width: (viewport width), height: (viewport height)}"
+ "type" : "Roo.Element",
+ "desc" : "The Element"
}
]
},
{
- "name" : "getWidth",
+ "name" : "switchOff",
"type" : "function",
- "desc" : "Returns the offset width of the element",
- "sig" : "(contentWidth)",
- "static" : false,
+ "desc" : "Blinks the element as if it was clicked and then collapses on its center (similar to switching off a television).\nWhen the effect is completed, the element will be hidden (visibility = 'hidden') but block elements will still \ntake up space in the document. The element must be removed from the DOM using the 'remove' config option if desired.\nUsage:\n<pre><code>\n// default\nel.switchOff();\n\n// all config options shown with default values\nel.switchOff({\n easing: 'easeIn',\n duration: .3,\n remove: false,\n useDisplay: false\n});\n</code></pre>",
+ "sig" : "(options)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "contentWidth",
- "type" : "Boolean",
- "desc" : "(optional) true to get the width minus borders and padding",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) Object literal with any of the Fx config options",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "The element's width"
+ "type" : "Roo.Element",
+ "desc" : "The Element"
}
]
},
{
- "name" : "getX",
+ "name" : "syncFx",
"type" : "function",
- "desc" : "Gets the current X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
+ "desc" : "Ensures that all effects queued after syncFx is called on the element are\nrun concurrently. This is the opposite of {@link #sequenceFx}.",
"sig" : "()\n{\n\n}",
- "static" : false,
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "The X position of the element"
+ "type" : "Roo.Element",
+ "desc" : "The Element"
}
]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.HtmlEditorCore" : {
+ "props" : [
+ {
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "getXY",
+ "name" : "allowComments",
+ "type" : "boolean",
+ "desc" : "- default false - allow comments in HTML source\n - by default they are stripped - if you are editing email you may need this.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoClean",
+ "type" : "boolean",
+ "desc" : "- default true - loading and saving will remove quite a bit of formating,\n if you are doing an email editor, this probably needs disabling, it's designed",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "css",
+ "type" : "String",
+ "desc" : "styling for resizing. (used on bootstrap only)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableBlocks",
+ "type" : "boolean",
+ "desc" : "- default true - if the block editor (table and figure should be enabled)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "(in pixels)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "language",
+ "type" : "String",
+ "desc" : "default en - language of text (usefull for rtl languages)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "stylesheets",
+ "type" : "Array",
+ "desc" : "url of stylesheets. set to [] to disable stylesheets.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "the",
+ "type" : "Roo.form.HtmlEditor|Roo.bootstrap.HtmlEditor",
+ "desc" : "owner field",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "(in pixels)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "activate",
"type" : "function",
- "desc" : "Gets the current position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "desc" : "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Array",
- "desc" : "The XY position of the element"
+ "name" : "this",
+ "type" : "Roo.HtmlEditorCore",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getY",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Gets the current Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Number",
- "desc" : "The Y position of the element"
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hasClass",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Checks if the specified CSS class exists on this element's DOM node.",
- "sig" : "(className)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "className",
- "type" : "String",
- "desc" : "The CSS class to check for",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "beforepush",
+ "type" : "function",
+ "desc" : "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push.",
+ "sig" : "function (_self, html)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the class exists, else false"
+ "name" : "this",
+ "type" : "Roo.HtmlEditorCore",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hide",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Hide this element - Uses display mode to determine whether to use \"display\" or \"visibility\". See {@link #setVisible}.",
- "sig" : "(animate)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) true for the default animation or a standard Element animation config object",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "initDD",
+ "name" : "beforesync",
"type" : "function",
- "desc" : "Initializes a {@link Roo.dd.DD} drag drop object for this element.",
- "sig" : "(group, config, overrides)",
- "static" : false,
+ "desc" : "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync.",
+ "sig" : "function (_self, html)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "group",
- "type" : "String",
- "desc" : "The group the DD object is member of",
+ "name" : "this",
+ "type" : "Roo.HtmlEditorCore",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "config",
- "type" : "Object",
- "desc" : "The DD config object",
+ "name" : "html",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "function ()\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "function ()\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "overrides",
- "type" : "Object",
- "desc" : "An object containing methods to override/implement on the DD object",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.dd.DD",
- "desc" : "The DD object"
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "initDDProxy",
+ "name" : "editorevent",
"type" : "function",
- "desc" : "Initializes a {@link Roo.dd.DDProxy} object for this element.",
- "sig" : "(group, config, overrides)",
- "static" : false,
+ "desc" : "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "group",
- "type" : "String",
- "desc" : "The group the DDProxy object is member of",
- "isOptional" : false
- },
- {
- "name" : "config",
- "type" : "Object",
- "desc" : "The DDProxy config object",
+ "name" : "this",
+ "type" : "Roo.HtmlEditorCore",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "overrides",
- "type" : "Object",
- "desc" : "An object containing methods to override/implement on the DDProxy object",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "function ()\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.dd.DDProxy",
- "desc" : "The DDProxy object"
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "initDDTarget",
+ "name" : "initialize",
"type" : "function",
- "desc" : "Initializes a {@link Roo.dd.DDTarget} object for this element.",
- "sig" : "(group, config, overrides)",
- "static" : false,
+ "desc" : "Fires when the editor is fully initialized (including the iframe)",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "group",
- "type" : "String",
- "desc" : "The group the DDTarget object is member of",
+ "name" : "this",
+ "type" : "Roo.HtmlEditorCore",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "push",
+ "type" : "function",
+ "desc" : "Fires when the iframe editor is updated with content from the textarea.",
+ "sig" : "function (_self, html)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "config",
- "type" : "Object",
- "desc" : "The DDTarget config object",
+ "name" : "this",
+ "type" : "Roo.HtmlEditorCore",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "overrides",
- "type" : "Object",
- "desc" : "An object containing methods to override/implement on the DDTarget object",
+ "name" : "html",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.dd.DDTarget",
- "desc" : "The DDTarget object"
- }
- ]
+ "returns" : []
},
{
- "name" : "insertAfter",
+ "name" : "render",
"type" : "function",
- "desc" : "Inserts this element after the passed element in the DOM",
- "sig" : "(el)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The element to insert after",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "insertBefore",
+ "name" : "specialkey",
"type" : "function",
- "desc" : "Inserts this element before the passed element in the DOM",
- "sig" : "(el)",
- "static" : false,
+ "desc" : "",
+ "sig" : "function ()\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "sync",
+ "type" : "function",
+ "desc" : "Fires when the textarea is updated with content from the editor iframe.",
+ "sig" : "function (_self, html)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The element to insert before",
+ "name" : "this",
+ "type" : "Roo.HtmlEditorCore",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "name" : "html",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
}
- ]
- },
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
{
- "name" : "insertFirst",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Inserts (or creates) an element (or DomHelper config) as the first child of the this element",
- "sig" : "(el)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element/Object",
- "desc" : "The id or element to insert or a DomHelper config to create and insert",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The new child"
- }
- ]
+ "returns" : []
},
{
- "name" : "insertHtml",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Inserts an html fragment into this element",
- "sig" : "(where, html, returnEl)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "where",
+ "name" : "eventName",
"type" : "String",
- "desc" : "Where to insert the html in relation to the this element - beforeBegin, afterBegin, beforeEnd, afterEnd.",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "html",
- "type" : "String",
- "desc" : "The HTML fragment",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "returnEl",
- "type" : "Boolean",
- "desc" : "True to return an Roo.Element",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The inserted node (or nearest related if more than 1 inserted)"
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "insertSibling",
+ "name" : "capture",
"type" : "function",
- "desc" : "Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element",
- "sig" : "(el, where, returnDom)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element/Object",
- "desc" : "The id or element to insert or a DomHelper config to create and insert",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "where",
- "type" : "String",
- "desc" : "(optional) 'before' or 'after' defaults to before",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
"isOptional" : false
},
{
- "name" : "returnDom",
- "type" : "Boolean",
- "desc" : "(optional) True to return the raw DOM element instead of Roo.Element",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "the inserted Element"
- }
- ]
+ "returns" : []
},
{
- "name" : "is",
+ "name" : "cleanHtml",
"type" : "function",
- "desc" : "Returns true if this element matches the passed simple selector (e.g. div.some-class or span:first-child)",
- "sig" : "(selector)",
+ "desc" : "Protected method that will not generally be called directly. If you need/want\ncustom HTML cleanup, this is the method you should override.",
+ "sig" : "(html)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "selector",
+ "name" : "html",
"type" : "String",
- "desc" : "The simple selector to test",
+ "desc" : "The HTML to be cleaned\nreturn {String} The cleaned HTML",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if this element matches the selector, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "isBorderBox",
+ "name" : "cleanTableWidths",
"type" : "function",
- "desc" : "Tests various css rules/browsers to determine if this element uses a border box",
+ "desc" : "",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
- "deprecated" : "",
+ "deprecated" : "This has been deprecated: - use filters",
"since" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "isDisplayed",
+ "name" : "cleanWord",
"type" : "function",
- "desc" : "Returns true if display is not \"none\"",
+ "desc" : "Clean up MS wordisms...",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
+ "deprecated" : "This has been deprecated: - use filter directly",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "isMasked",
+ "name" : "disable",
"type" : "function",
- "desc" : "Returns true if this element is masked",
+ "desc" : "Disable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "isScrollable",
+ "name" : "enable",
"type" : "function",
- "desc" : "Returns true if this element is scrollable.",
+ "desc" : "Enable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "isVisible",
+ "name" : "execCmd",
"type" : "function",
- "desc" : "Checks whether the element is currently visible using both visibility and display properties.",
- "sig" : "(deep)",
+ "desc" : "Executes a Midas editor command directly on the editor document.\nFor visual commands, you should use {@link #relayCmd} instead.\n<b>This should only be called after the editor is initialized.</b>",
+ "sig" : "(cmd, value)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "deep",
- "type" : "Boolean",
- "desc" : "(optional) True to walk the dom and see if parent elements are hidden (defaults to false)",
+ "name" : "cmd",
+ "type" : "String",
+ "desc" : "The Midas command",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the element is currently visible, else false"
+ "name" : "value",
+ "type" : "String/Boolean",
+ "desc" : "(optional) The value to pass to the command (defaults to null)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "load",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Direct access to the UpdateManager update() method (takes the same parameters).",
- "sig" : "(url, params, callback, discardUrl)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "url",
- "type" : "String/Function",
- "desc" : "The url for this request or a function to call to get the url",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The parameters to pass as either a url encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "discardUrl",
- "type" : "Boolean",
- "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used url. If true, it will not store the url.",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "mask",
+ "name" : "focus",
"type" : "function",
- "desc" : "Puts a mask over this element to disable user interaction. Requires core.css.\nThis method can only be applied to elements which accept child nodes.",
- "sig" : "(msg, msgCls)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "msg",
- "type" : "String",
- "desc" : "(optional) A message to display in the mask",
- "isOptional" : false
- },
- {
- "name" : "msgCls",
- "type" : "String",
- "desc" : "(optional) A css class to apply to the msg element - use no-spinner to hide the spinner on bootstrap",
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Element",
- "desc" : "The mask element"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "move",
+ "name" : "getDocMarkup",
"type" : "function",
- "desc" : "Move this element relative to its current position.",
- "sig" : "(direction, distance, animate)",
+ "desc" : "Protected method that will not generally be called directly. It\nis called when the editor initializes the iframe with HTML contents. Override this method if you\nwant to change the initialization markup of the iframe (e.g. to add stylesheets).",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "direction",
- "type" : "String",
- "desc" : "Possible values are: \"l\",\"left\" - \"r\",\"right\" - \"t\",\"top\",\"up\" - \"b\",\"bottom\",\"down\".",
- "isOptional" : false
- },
- {
- "name" : "distance",
- "type" : "Number",
- "desc" : "How far to move the element in pixels",
- "isOptional" : false
- },
- {
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) true for the default animation or a standard Element animation config object",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "moveTo",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
- "sig" : "(x, y, animate)",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "X value for new position (coordinates are page-based)",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "Y value for new position (coordinates are page-based)",
- "isOptional" : false
- },
- {
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) True for the default animation, or a standard Element animation config object",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "this"
+ "desc" : "The element"
}
]
},
{
- "name" : "on",
+ "name" : "getId",
"type" : "function",
- "desc" : "Appends an event handler (Shorthand for addListener)",
- "sig" : "(eventName, fn, scope, options)",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "eventName",
+ "name" : "",
"type" : "String",
- "desc" : "The type of event to append",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) of the fn",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)An object with standard {@link Roo.EventManager#addListener} options",
- "isOptional" : false
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "position",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Initializes positioning on this element. If a desired position is not passed, it will make the\nthe element positioned relative IF it is not already positioned.",
- "sig" : "(pos, zIndex, x, y)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "pos",
+ "name" : "eventName",
"type" : "String",
- "desc" : "(optional) Positioning to use \"relative\", \"absolute\" or \"fixed\"",
- "isOptional" : false
- },
- {
- "name" : "zIndex",
- "type" : "Number",
- "desc" : "(optional) The zIndex to apply",
- "isOptional" : false
- },
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "(optional) Set the page X position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "(optional) Set the page Y position",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "query",
+ "name" : "hide",
"type" : "function",
- "desc" : "Selects child nodes based on the passed CSS selector (the selector should not contain an id).",
- "sig" : "(selector)",
+ "desc" : "Hide this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "selector",
- "type" : "String",
- "desc" : "The CSS selector",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Array",
- "desc" : "An array of the matched nodes"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "radioClass",
+ "name" : "insertAtCursor",
"type" : "function",
- "desc" : "Adds one or more CSS classes to this element and removes the same class(es) from all siblings.",
- "sig" : "(className)",
+ "desc" : "Inserts the passed text at the current cursor position. Note: the editor must be initialized and activated\nto insert tRoo.",
+ "sig" : "(text)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "className",
- "type" : "String/Array",
- "desc" : "The CSS class to add, or an array of classes",
+ "name" : "text",
+ "type" : "String",
+ "desc" : "| dom node..",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "remove",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Removes this element from the DOM and deletes it from the cache",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "removeAllListeners",
+ "name" : "on",
"type" : "function",
- "desc" : "Removes all previous added listeners from this element",
- "sig" : "()\n{\n\n}",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "removeClass",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Removes one or more CSS classes from the element.",
- "sig" : "(className)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "className",
- "type" : "String/Array",
- "desc" : "The CSS class to remove, or an array of classes",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "removeListener",
+ "name" : "pushValue",
"type" : "function",
- "desc" : "Removes an event handler from this element",
- "sig" : "(eventName, fn, scope)",
+ "desc" : "TEXTAREA -> EDITABLE\nProtected method that will not generally be called directly. Pushes the value of the textarea\ninto the iframe editor.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "the type of event to remove",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "the method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Function",
- "desc" : "(needed for svg fake listeners)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "repaint",
+ "name" : "rangeIntersectsNode",
"type" : "function",
- "desc" : "Forces the browser to repaint this element",
+ "desc" : "Range intersection.. the hard stuff...\n '-1' = before\n '0' = hits..\n '1' = after.\n [ -- selected range --- ]\n [fail] [fail]\n\n basically..\n if end is before start or hits it. fail.\n if start is after end or hits it fail.\n\n if either hits (but other is outside. - then it's not",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "replace",
+ "name" : "relayCmd",
"type" : "function",
- "desc" : "Replaces the passed element with this element",
- "sig" : "(el)",
+ "desc" : "Executes a Midas editor command on the editor document and performs necessary focus and\ntoolbar updates. <b>This should only be called after the editor is initialized.</b>",
+ "sig" : "(cmd, value)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The element to replace",
+ "name" : "cmd",
+ "type" : "String",
+ "desc" : "The Midas command",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "name" : "value",
+ "type" : "String/Boolean",
+ "desc" : "(optional) The value to pass to the command (defaults to null)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "replaceClass",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Replaces a CSS class on the element with another. If the old name does not exist, the new name will simply be added.",
- "sig" : "(oldClassName, newClassName)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "oldClassName",
- "type" : "String",
- "desc" : "The CSS class to replace",
- "isOptional" : false
- },
- {
- "name" : "newClassName",
- "type" : "String",
- "desc" : "The replacement CSS class",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "scroll",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Scrolls this element the specified direction. Does bounds checking to make sure the scroll is\nwithin this element's scrollable range.",
- "sig" : "(direction, distance, animate)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "direction",
+ "name" : "eventName",
"type" : "String",
- "desc" : "Possible values are: \"l\",\"left\" - \"r\",\"right\" - \"t\",\"top\",\"up\" - \"b\",\"bottom\",\"down\".",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "distance",
- "type" : "Number",
- "desc" : "How far to scroll the element in pixels",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) true for the default animation or a standard Element animation config object",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "Returns true if a scroll was triggered or false if the element\nwas scrolled as far as it could go."
- }
- ]
+ "returns" : []
},
{
- "name" : "scrollIntoView",
+ "name" : "render",
"type" : "function",
- "desc" : "Scrolls this element into view within the passed container.",
- "sig" : "(container, hscroll)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "container",
"type" : "String/HTMLElement/Element",
- "desc" : "(optional) The container element to scroll (defaults to document.body)",
- "isOptional" : false
- },
- {
- "name" : "hscroll",
- "type" : "Boolean",
- "desc" : "(optional) False to disable horizontal scroll (defaults to true)",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "scrollTo",
+ "name" : "selectNode",
"type" : "function",
- "desc" : "Scrolls this element the specified scroll point. It does NOT do bounds checking so if you scroll to a weird value it will try to do it. For auto bounds checking, use scroll().",
- "sig" : "(side, value, animate)",
+ "desc" : "Select a dom node",
+ "sig" : "(node)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "side",
- "type" : "String",
- "desc" : "Either \"left\" for scrollLeft values or \"top\" for scrollTop values.",
- "isOptional" : false
- },
- {
- "name" : "value",
- "type" : "Number",
- "desc" : "The new scroll value",
- "isOptional" : false
- },
- {
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) true for the default animation or a standard Element animation config object",
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "the node to select",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "select",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Creates a {@link Roo.CompositeElement} for child nodes based on the passed CSS selector (the selector should not contain an id).",
- "sig" : "(selector, unique)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "selector",
- "type" : "String",
- "desc" : "The CSS selector",
- "isOptional" : false
- },
- {
- "name" : "unique",
+ "name" : "disabled",
"type" : "Boolean",
- "desc" : "(optional) True to create a unique Roo.Element for each child (defaults to false, which creates a single shared flyweight object)",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "CompositeElement/CompositeElementLite",
- "desc" : "The composite element"
- }
- ]
+ "returns" : []
},
{
- "name" : "set",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function)",
- "sig" : "(o, useSet)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Object",
- "desc" : "The object with the attributes",
- "isOptional" : false
- },
- {
- "name" : "useSet",
+ "name" : "visible",
"type" : "Boolean",
- "desc" : "(optional) false to override the default setAttribute to use expandos.",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
+ "type" : "Roo.Component",
"desc" : "this"
}
]
},
{
- "name" : "setBottom",
+ "name" : "show",
"type" : "function",
- "desc" : "Sets the element's CSS bottom style.",
- "sig" : "(bottom)",
+ "desc" : "Show this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "bottom",
- "type" : "String",
- "desc" : "The bottom CSS property value",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
+ "type" : "Roo.Component",
"desc" : "this"
}
]
},
{
- "name" : "setBounds",
+ "name" : "syncValue",
"type" : "function",
- "desc" : "Sets the element's position and size in one shot. If animation is true then width, height, x and y will be animated concurrently.",
- "sig" : "(x, y, width, height, animate)",
+ "desc" : "HTML Editor -> Textarea\nProtected method that will not generally be called directly. Syncs the contents\nof the editor iframe with the textarea.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "X value for new position (coordinates are page-based)",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "Y value for new position (coordinates are page-based)",
- "isOptional" : false
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The new width",
- "isOptional" : false
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "The new height",
- "isOptional" : false
- },
- {
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) true for the default animation or a standard Element animation config object",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "setBox",
+ "name" : "toggleSourceEdit",
"type" : "function",
- "desc" : "Sets the element's box. Use getBox() on another element to get a box obj. If animate is true then width, height, x and y will be animated concurrently.",
- "sig" : "(box, adjust, animate)",
+ "desc" : "Toggles the editor between standard and source edit mode.",
+ "sig" : "(sourceEdit)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "box",
- "type" : "Object",
- "desc" : "The box to fill {x, y, width, height}",
- "isOptional" : false
- },
- {
- "name" : "adjust",
+ "name" : "sourceEdit",
"type" : "Boolean",
- "desc" : "(optional) Whether to adjust for box-model issues automatically",
- "isOptional" : false
- },
- {
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) true for the default animation or a standard Element animation config object",
+ "desc" : "(optional) True for source edit, false for standard",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "setDisplayed",
+ "name" : "un",
"type" : "function",
- "desc" : "Sets the CSS display property. Uses originalDisplay if the specified value is a boolean true.",
- "sig" : "(value)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Boolean",
- "desc" : "Boolean value to display the element using its default display, or a string to set the display directly",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.JsonView" : {
+ "props" : [
+ {
+ "name" : "dataName",
+ "type" : "String",
+ "desc" : "the named area of the template to use as the data area\n Works with domtemplates roo-name=\"name\"",
+ "memberOf" : "Roo.View",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "setHeight",
+ "name" : "el",
+ "type" : "String|Roo.Element",
+ "desc" : "The container element.",
+ "memberOf" : "Roo.View",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "emptyText",
+ "type" : "String",
+ "desc" : "The empty text to show when nothing is loaded.",
+ "memberOf" : "Roo.View",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "multiSelect",
+ "type" : "Boolean",
+ "desc" : "Allow multiple selection",
+ "memberOf" : "Roo.View",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "selectedClass",
+ "type" : "String",
+ "desc" : "The css class to add to selected nodes",
+ "memberOf" : "Roo.View",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "singleSelect",
+ "type" : "Boolean",
+ "desc" : "Allow single selection",
+ "memberOf" : "Roo.View",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "Data store to load data from.",
+ "memberOf" : "Roo.View",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "to display on mask (default Loading)",
+ "memberOf" : "Roo.View",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tickable",
+ "type" : "Boolean",
+ "desc" : "- selecting",
+ "memberOf" : "Roo.View",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "toggleSelect",
+ "type" : "Boolean",
+ "desc" : "- selecting",
+ "memberOf" : "Roo.View",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tpl",
+ "type" : "String|Roo.Template",
+ "desc" : "The template used by this View",
+ "memberOf" : "Roo.View",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforeclick",
"type" : "function",
- "desc" : "Set the height of the element",
- "sig" : "(height, animate)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before a click is processed. Returns false to cancel the default action.",
+ "sig" : "function (_self, index, node, e)\n{\n\n}",
+ "memberOf" : "Roo.View",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "height",
+ "name" : "this",
+ "type" : "Roo.View",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
"type" : "Number",
- "desc" : "The new height",
+ "desc" : "The index of the target node",
"isOptional" : false
},
{
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) true for the default animation or a standard Element animation config object",
+ "name" : "node",
+ "type" : "HTMLElement",
+ "desc" : "The target node",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The raw event object",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "setLeft",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Sets the element's left position directly using CSS style (instead of {@link #setX}).",
- "sig" : "(left)",
- "static" : false,
+ "desc" : "Fires before rendering of the downloaded JSON data.",
+ "sig" : "function (_self, data)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "left",
- "type" : "String",
- "desc" : "The left CSS property value",
+ "name" : "this",
+ "type" : "Roo.JsonView",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "The JSON data loaded",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "setLeftTop",
+ "name" : "beforeselect",
"type" : "function",
- "desc" : "Quick set left and top adding default units",
- "sig" : "(left, top)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before a selection is made. If any handlers return false, the selection is cancelled.",
+ "sig" : "function (_self, node, selections)\n{\n\n}",
+ "memberOf" : "Roo.View",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "left",
- "type" : "String",
- "desc" : "The left CSS property value",
+ "name" : "this",
+ "type" : "Roo.View",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "top",
- "type" : "String",
- "desc" : "The top CSS property value",
+ "name" : "node",
+ "type" : "HTMLElement",
+ "desc" : "The node to be selected",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "name" : "selections",
+ "type" : "Array",
+ "desc" : "Array of currently selected nodes",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "setLocation",
+ "name" : "click",
"type" : "function",
- "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
- "sig" : "(x, y, animate)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a template node is clicked.",
+ "sig" : "function (_self, index, node, e)\n{\n\n}",
+ "memberOf" : "Roo.View",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "x",
- "type" : "Number",
- "desc" : "X value for new position (coordinates are page-based)",
+ "name" : "this",
+ "type" : "Roo.View",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "y",
+ "name" : "index",
"type" : "Number",
- "desc" : "Y value for new position (coordinates are page-based)",
+ "desc" : "The index of the target node",
"isOptional" : false
},
{
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) True for the default animation, or a standard Element animation config object",
+ "name" : "node",
+ "type" : "HTMLElement",
+ "desc" : "The target node",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The raw event object",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "setOpacity",
+ "name" : "contextmenu",
"type" : "function",
- "desc" : "Set the opacity of the element",
- "sig" : "(opacity, animate)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a template node is right clicked.",
+ "sig" : "function (_self, index, node, e)\n{\n\n}",
+ "memberOf" : "Roo.View",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "opacity",
- "type" : "Float",
- "desc" : "The new opacity. 0 = transparent, .5 = 50% visibile, 1 = fully visible, etc",
+ "name" : "this",
+ "type" : "Roo.View",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) true for the default animation or a standard Element animation config object",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the target node",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "name" : "node",
+ "type" : "HTMLElement",
+ "desc" : "The target node",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The raw event object",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "setPositioning",
+ "name" : "dblclick",
"type" : "function",
- "desc" : "Set positioning with an object returned by getPositioning().",
- "sig" : "(posCfg)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a template node is double clicked.",
+ "sig" : "function (_self, index, node, e)\n{\n\n}",
+ "memberOf" : "Roo.View",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "posCfg",
- "type" : "Object",
+ "name" : "this",
+ "type" : "Roo.View",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the target node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "HTMLElement",
+ "desc" : "The target node",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The raw event object",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "setRegion",
+ "name" : "load",
"type" : "function",
- "desc" : "Sets the element's position and size the the specified region. If animation is true then width, height, x and y will be animated concurrently.",
- "sig" : "(region, animate)",
- "static" : false,
+ "desc" : "Fires when data is loaded.",
+ "sig" : "function (_self, data, response)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "region",
- "type" : "Roo.lib.Region",
- "desc" : "The region to fill",
+ "name" : "this",
+ "type" : "Roo.JsonView",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) true for the default animation or a standard Element animation config object",
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "The JSON data loaded",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "name" : "response",
+ "type" : "Object",
+ "desc" : "The raw Connect response object",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "setRight",
+ "name" : "loadexception",
"type" : "function",
- "desc" : "Sets the element's CSS right style.",
- "sig" : "(right)",
- "static" : false,
+ "desc" : "Fires when loading fails.",
+ "sig" : "function (_self, response)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "right",
- "type" : "String",
- "desc" : "The right CSS property value",
+ "name" : "this",
+ "type" : "Roo.JsonView",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "name" : "response",
+ "type" : "Object",
+ "desc" : "The raw Connect response object",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "setSize",
+ "name" : "preparedata",
"type" : "function",
- "desc" : "Set the size of the element. If animation is true, both width an height will be animated concurrently.",
- "sig" : "(width, height, animate)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires on every row to render, to allow you to change the data.",
+ "sig" : "function (_self, data)\n{\n\n}",
+ "memberOf" : "Roo.View",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "width",
- "type" : "Number",
- "desc" : "The new width",
- "isOptional" : false
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "The new height",
+ "name" : "this",
+ "type" : "Roo.View",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) true for the default animation or a standard Element animation config object",
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "to be rendered (change this)",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "setStyle",
+ "name" : "selectionchange",
"type" : "function",
- "desc" : "Wrapper for setting style properties, also takes single object parameter of multiple styles.",
- "sig" : "(property, value)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the selected nodes change.",
+ "sig" : "function (_self, selections)\n{\n\n}",
+ "memberOf" : "Roo.View",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "property",
- "type" : "String/Object",
- "desc" : "The style property to be set, or an object of multiple styles.",
+ "name" : "this",
+ "type" : "Roo.View",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "value",
- "type" : "String",
- "desc" : "(optional) The value to apply to the given property, or null if an object was passed.",
+ "name" : "selections",
+ "type" : "Array",
+ "desc" : "Array of the selected nodes",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
- },
+ "returns" : []
+ }
+ ],
+ "methods" : [
{
- "name" : "setTop",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Sets the element's top position directly using CSS style (instead of {@link #setY}).",
- "sig" : "(top)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "top",
- "type" : "String",
- "desc" : "The top CSS property value",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "setVisibilityMode",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Sets the element's visibility mode. When setVisible() is called it\nwill use this to determine whether to set the visibility or the display property.",
- "sig" : "(visMode)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visMode",
- "type" : "",
- "desc" : "Element.VISIBILITY or Element.DISPLAY",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "setVisible",
+ "name" : "capture",
"type" : "function",
- "desc" : "Sets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use\nthe display property to hide the element, otherwise it uses visibility. The default is to hide and show using the visibility property.",
- "sig" : "(visible, animate)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "Whether the element is visible",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) True for the default animation, or a standard Element animation config object",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "setWidth",
+ "name" : "clearFilter",
"type" : "function",
- "desc" : "Set the width of the element",
- "sig" : "(width, animate)",
+ "desc" : "Clears the current filter.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The new width",
- "isOptional" : false
- },
- {
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) true for the default animation or a standard Element animation config object",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "setX",
+ "name" : "clearSelections",
"type" : "function",
- "desc" : "Sets the X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
- "sig" : "(The, animate)",
+ "desc" : "Clear all selections",
+ "sig" : "(suppressEvent)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.View",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "The",
- "type" : "Number",
- "desc" : "X position of the element",
- "isOptional" : false
- },
- {
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) True for the default animation, or a standard Element animation config object",
+ "name" : "suppressEvent",
+ "type" : "Boolean",
+ "desc" : "(optional) true to skip firing of the selectionchange event",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "setXY",
+ "name" : "filter",
"type" : "function",
- "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
- "sig" : "(pos, animate)",
+ "desc" : "Filter the data by a specific property.",
+ "sig" : "(property, value)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "pos",
- "type" : "Array",
- "desc" : "Contains X & Y [x, y] values for new position (coordinates are page-based)",
+ "name" : "property",
+ "type" : "String",
+ "desc" : "A property on your JSON objects",
"isOptional" : false
},
{
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) True for the default animation, or a standard Element animation config object",
+ "name" : "value",
+ "type" : "String/RegExp",
+ "desc" : "Either string that the property values\nshould start with, or a RegExp to test against the property",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "setY",
+ "name" : "filterBy",
"type" : "function",
- "desc" : "Sets the Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
- "sig" : "(The, animate)",
+ "desc" : "Filter by a function. The passed function will be called with each\nobject in the current dataset. If the function returns true the value is kept,\notherwise it is filtered.",
+ "sig" : "(fn, scope)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "The",
- "type" : "Number",
- "desc" : "Y position of the element",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) True for the default animation, or a standard Element animation config object",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the function (defaults to this JsonView)",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "show",
+ "name" : "findItemFromChild",
"type" : "function",
- "desc" : "Show this element - Uses display mode to determine whether to use \"display\" or \"visibility\". See {@link #setVisible}.",
- "sig" : "(animate)",
+ "desc" : "Returns the template node the passed child belongs to or null if it doesn't belong to one.",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.View",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) true for the default animation or a standard Element animation config object",
+ "name" : "node",
+ "type" : "HTMLElement",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "type" : "HTMLElement",
+ "desc" : "The template node"
}
]
},
{
- "name" : "swallowEvent",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Stops the specified event from bubbling and optionally prevents the default action",
- "sig" : "(eventName, preventDefault)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"isOptional" : false
},
{
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "(optional) true to prevent the default action too",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "toggle",
+ "name" : "getCount",
"type" : "function",
- "desc" : "Toggles the element's visibility or display, depending on visibility mode.",
- "sig" : "(animate)",
+ "desc" : "Get the number of records in the current JSON dataset",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) True for the default animation, or a standard Element animation config object",
- "isOptional" : false
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
}
- ],
+ ]
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns the element this view is bound to.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.View",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "this"
+ "desc" : ""
}
]
},
{
- "name" : "toggleClass",
+ "name" : "getNode",
"type" : "function",
- "desc" : "Toggles the specified CSS class on this element (removes it if it already exists, otherwise adds it).",
- "sig" : "(className)",
+ "desc" : "Gets a template node.",
+ "sig" : "(nodeInfo)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.View",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "className",
- "type" : "String",
- "desc" : "The CSS class to toggle",
+ "name" : "nodeInfo",
+ "type" : "HTMLElement/String/Number",
+ "desc" : "An HTMLElement template node, index of a template node or the id of a template node",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "type" : "HTMLElement",
+ "desc" : "The node or null if it wasn't found"
}
]
},
{
- "name" : "translatePoints",
+ "name" : "getNodeData",
"type" : "function",
- "desc" : "Translates the passed page coordinates into left/top css values for this element",
- "sig" : "(x, y)",
+ "desc" : "Returns the JSON object for the specified node(s)",
+ "sig" : "(node)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "x",
- "type" : "Number/Array",
- "desc" : "The page x or an array containing [x, y]",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The page y",
+ "name" : "node",
+ "type" : "HTMLElement/Array",
+ "desc" : "The node or an array of nodes",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "An object with left and top properties. e.g. {left: (value), top: (value)}"
+ "type" : "Object/Array",
+ "desc" : "If you pass in an array, you get an array back, otherwise\nyou get the JSON object for the node"
}
]
},
{
- "name" : "un",
+ "name" : "getNodes",
"type" : "function",
- "desc" : "Removes an event handler from this element (shorthand for removeListener)",
- "sig" : "(eventName, fn)",
+ "desc" : "Gets a range template nodes.",
+ "sig" : "(startIndex, endIndex)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.View",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "the type of event to remove",
+ "name" : "startIndex",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "the method the event invokes",
+ "name" : "endIndex",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "type" : "Array",
+ "desc" : "An array of nodes"
}
]
},
{
- "name" : "unclip",
+ "name" : "getSelectedIndexes",
"type" : "function",
- "desc" : "Return clipping (overflow) to original clipping before clip() was called",
+ "desc" : "Get the indexes of the selected nodes.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.View",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "type" : "Array",
+ "desc" : ""
}
]
},
{
- "name" : "unmask",
+ "name" : "getSelectedNodes",
"type" : "function",
- "desc" : "Removes a previously applied mask. If removeEl is true the mask overlay is destroyed, otherwise\nit is cached for reuse.",
+ "desc" : "Get the currently selected nodes.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.View",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "An array of HTMLElements"
+ }
+ ]
},
{
- "name" : "unselectable",
+ "name" : "getSelectionCount",
"type" : "function",
- "desc" : "Disables text selection for this element (normalized across browsers)",
+ "desc" : "Get the number of selected nodes.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.View",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "type" : "Number",
+ "desc" : ""
}
]
},
{
- "name" : "up",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Walks up the dom looking for a parent node that matches the passed simple selector (e.g. div.some-class or span:first-child).\nThis is a shortcut for findParentNode() that always returns an Roo.Element.",
- "sig" : "(selector, maxDepth)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "selector",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The simple selector to test",
- "isOptional" : false
- },
- {
- "name" : "maxDepth",
- "type" : "Number/String/HTMLElement/Element",
- "desc" : "(optional) The max depth to\n search as a number or element (defaults to 10 || document.body)",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The matching DOM node (or null if no match was found)"
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "update",
+ "name" : "indexOf",
"type" : "function",
- "desc" : "Update the innerHTML of this element, optionally searching for and processing scripts",
- "sig" : "(html, loadScripts, callback)",
+ "desc" : "Finds the index of the passed node",
+ "sig" : "(nodeInfo)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.View",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "html",
- "type" : "String",
- "desc" : "The new HTML",
- "isOptional" : false
- },
- {
- "name" : "loadScripts",
- "type" : "Boolean",
- "desc" : "(optional) true to look for and process scripts",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "For async script loading you can be noticed when the update completes",
+ "name" : "nodeInfo",
+ "type" : "HTMLElement/String/Number",
+ "desc" : "An HTMLElement template node, index of a template node or the id of a template node",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "type" : "Number",
+ "desc" : "The index of the node or -1"
}
]
},
{
- "name" : "wrap",
+ "name" : "isSelected",
"type" : "function",
- "desc" : "Creates and wraps this element with another element",
- "sig" : "(config, returnDom)",
+ "desc" : "Returns true if the passed node is selected",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.View",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "config",
- "type" : "Object",
- "desc" : "(optional) DomHelper element config object for the wrapper element or null for an empty div",
- "isOptional" : false
- },
- {
- "name" : "returnDom",
- "type" : "Boolean",
- "desc" : "(optional) True to return the raw DOM element instead of Roo.Element",
+ "name" : "node",
+ "type" : "HTMLElement/Number",
+ "desc" : "The node or node index",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "HTMLElement/Element",
- "desc" : "The newly created wrapper element"
+ "type" : "Boolean",
+ "desc" : ""
}
]
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.Layer"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.EventManager" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "addListener",
+ "name" : "load",
"type" : "function",
- "desc" : "Appends an event handler to an element (shorthand for addListener)",
- "sig" : "(element, eventName, handler, scope, options)",
- "static" : true,
+ "desc" : "Performs an async HTTP request, and loads the JSON from the response. If <i>params</i> are specified it uses POST, otherwise it uses GET.",
+ "sig" : "(url, params, callback, discardUrl)",
+ "static" : false,
"memberOf" : "",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "element",
- "type" : "String/HTMLElement",
- "desc" : "The html element or id to assign the",
+ "name" : "url",
+ "type" : "Object/String/Function",
+ "desc" : "The URL for this request, or a function to call to get the URL, or a config object containing any of the following options:\n <pre><code>\n view.load({\n url: \"your-url.php\",\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n callback: yourFunction,\n scope: yourObject, //(optional scope)\n discardUrl: false,\n nocache: false,\n text: \"Loading...\",\n timeout: 30,\n scripts: false\n });\n </code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare respectively shorthand for <i>disableCaching</i>, <i>indicatorText</i>, and <i>loadScripts</i> and are used to set their associated property on this UpdateManager instance.",
"isOptional" : false
},
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The parameters to pass, as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
"isOptional" : false
},
{
- "name" : "handler",
+ "name" : "callback",
"type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delegate {String} A simple selector to filter the target or look for a descendant of the target</li>\n<li>stopEvent {Boolean} True to stop the event. That is stop propagation, and prevent the default action.</li>\n<li>preventDefault {Boolean} True to prevent the default action</li>\n<li>stopPropagation {Boolean} True to prevent event propagation</li>\n<li>normalized {Boolean} False to pass a browser event to the handler function instead of an Roo.EventObject</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<div style=\"margin: 5px 20px 20px;\">\nCode:<pre><code>\nel.on('click', this.onClick, this, {\n single: true,\n delay: 100,\n stopEvent : true,\n forumId: 4\n});</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<p>\nCode:<pre><code>\nel.on({\n 'click' : {\n fn: this.onClick\n scope: this,\n delay: 100\n },\n 'mouseover' : {\n fn: this.onMouseOver\n scope: this\n },\n 'mouseout' : {\n fn: this.onMouseOut\n scope: this\n }\n});</code></pre>\n<p>\nOr a shorthand syntax:<br>\nCode:<pre><code>\nel.on({\n 'click' : this.onClick,\n 'mouseover' : this.onMouseOver,\n 'mouseout' : this.onMouseOut\n scope: this\n});</code></pre>",
+ "name" : "discardUrl",
+ "type" : "Boolean",
+ "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
"isOptional" : false
}
],
{
"name" : "on",
"type" : "function",
- "desc" : "Appends an event handler to an element (shorthand for addListener)",
- "sig" : "(element, eventName, handler, scope, options)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"exceptions" : "",
"requires" : "",
"params" : [
- {
- "name" : "element",
- "type" : "String/HTMLElement",
- "desc" : "The html element or id to assign the",
- "isOptional" : false
- },
{
"name" : "eventName",
"type" : "String",
{
"name" : "options",
"type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delegate {String} A simple selector to filter the target or look for a descendant of the target</li>\n<li>stopEvent {Boolean} True to stop the event. That is stop propagation, and prevent the default action.</li>\n<li>preventDefault {Boolean} True to prevent the default action</li>\n<li>stopPropagation {Boolean} True to prevent event propagation</li>\n<li>normalized {Boolean} False to pass a browser event to the handler function instead of an Roo.EventObject</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<div style=\"margin: 5px 20px 20px;\">\nCode:<pre><code>\nel.on('click', this.onClick, this, {\n single: true,\n delay: 100,\n stopEvent : true,\n forumId: 4\n});</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<p>\nCode:<pre><code>\nel.on({\n 'click' : {\n fn: this.onClick\n scope: this,\n delay: 100\n },\n 'mouseover' : {\n fn: this.onMouseOver\n scope: this\n },\n 'mouseout' : {\n fn: this.onMouseOut\n scope: this\n }\n});</code></pre>\n<p>\nOr a shorthand syntax:<br>\nCode:<pre><code>\nel.on({\n 'click' : this.onClick,\n 'mouseover' : this.onMouseOver,\n 'mouseout' : this.onMouseOut\n scope: this\n});</code></pre>",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onDocumentReady",
+ "name" : "onBeforeLoad",
"type" : "function",
- "desc" : "Fires when the document is ready (before onload and before images are loaded). Can be \naccessed shorthanded Roo.onReady().",
- "sig" : "(fn, scope, options)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "onbeforeLoad - masks the loading area.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.View",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "prepareData",
+ "type" : "function",
+ "desc" : "Function to override to reformat the data that is sent to\nthe template for each node.\nDEPRICATED - use the preparedata event handler.",
+ "sig" : "(data)",
+ "static" : false,
+ "memberOf" : "Roo.View",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "An object that becomes the scope of the handler",
+ "name" : "data",
+ "type" : "Array/Object",
+ "desc" : "The raw data (array of colData for a data model bound view or\na JSON object for an UpdateManager bound view).",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "refresh",
+ "type" : "function",
+ "desc" : "Refreshes the view.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "refreshNode",
+ "type" : "function",
+ "desc" : "Refresh an individual node.",
+ "sig" : "(index)",
+ "static" : false,
+ "memberOf" : "Roo.View",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "options",
- "type" : "boolean",
+ "name" : "index",
+ "type" : "Number",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "onTextResize",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Fires when the user changes the active text size. Handler gets called with 2 params, the old size and the new size.",
- "sig" : "(fn, scope, options)",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
"static" : true,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "An object that becomes the scope of the handler",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "boolean",
- "desc" : "",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onWindowResize",
+ "name" : "select",
"type" : "function",
- "desc" : "Fires when the window is resized and provides resize event buffering (50 milliseconds), passes new viewport width and height to handlers.",
- "sig" : "(fn, scope, options)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Selects nodes.",
+ "sig" : "(nodeInfo, keepExisting, suppressEvent)",
+ "static" : false,
+ "memberOf" : "Roo.View",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "nodeInfo",
+ "type" : "Array/HTMLElement/String/Number",
+ "desc" : "An HTMLElement template node, index of a template node, id of a template node or an array of any of those to select",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "An object that becomes the scope of the handler",
+ "name" : "keepExisting",
+ "type" : "Boolean",
+ "desc" : "(optional) true to keep existing selections",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "boolean",
+ "name" : "suppressEvent",
+ "type" : "Boolean",
+ "desc" : "(optional) true to skip firing of the selectionchange vent",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setStore",
+ "type" : "function",
+ "desc" : "Changes the data store this view uses and refresh the view.",
+ "sig" : "(store)",
+ "static" : false,
+ "memberOf" : "Roo.View",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "store",
+ "type" : "Store",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "sort",
"type" : "function",
- "desc" : "Removes an event handler",
- "sig" : "(element, eventName, fn)",
- "static" : true,
+ "desc" : "Sorts the data for this view and refreshes it.",
+ "sig" : "(property, direction, sortType)",
+ "static" : false,
"memberOf" : "",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "element",
- "type" : "String/HTMLElement",
- "desc" : "The id or html element to remove the \n event from",
+ "name" : "property",
+ "type" : "String",
+ "desc" : "A property on your JSON objects to sort on",
"isOptional" : false
},
{
- "name" : "eventName",
+ "name" : "direction",
"type" : "String",
- "desc" : "The type of event",
+ "desc" : "(optional) \"desc\" or \"asc\" (defaults to \"asc\")",
"isOptional" : false
},
{
- "name" : "fn",
+ "name" : "sortType",
"type" : "Function",
- "desc" : "",
+ "desc" : "(optional) A function to call to convert the data to a sortable value.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if a listener was actually removed"
- }
- ]
+ "returns" : []
},
{
- "name" : "removeResizeListener",
+ "name" : "un",
"type" : "function",
- "desc" : "Removes the passed window resize listener.",
- "sig" : "(fn, scope)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "fn",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "The scope of handler",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "wrap",
+ "name" : "unselect",
"type" : "function",
- "desc" : "This is no longer needed and is deprecated. Places a simple wrapper around an event handler to override the browser event\nobject with a Roo.EventObject",
- "sig" : "(fn, scope, override)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Unselects nodes.",
+ "sig" : "(nodeInfo, keepExisting, suppressEvent)",
+ "static" : false,
+ "memberOf" : "Roo.View",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
- "deprecated" : "This has been deprecated: ",
+ "deprecated" : "",
"since" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "nodeInfo",
+ "type" : "Array/HTMLElement/String/Number",
+ "desc" : "An HTMLElement template node, index of a template node, id of a template node or an array of any of those to select",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "An object that becomes the scope of the handler",
+ "name" : "keepExisting",
+ "type" : "Boolean",
+ "desc" : "(optional) true IGNORED (for campatibility with select)",
"isOptional" : false
},
{
- "name" : "override",
- "type" : "boolean",
- "desc" : "If true, the obj passed in becomes\n the execution scope of the listener",
+ "name" : "suppressEvent",
+ "type" : "Boolean",
+ "desc" : "(optional) true to skip firing of the selectionchange vent",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Function",
- "desc" : "The wrapped function"
- }
- ]
+ "returns" : []
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.EventObject" : {
+ "Roo.KeyMap" : {
"props" : [],
"events" : [],
"methods" : [
{
- "name" : "getCharCode",
- "type" : "function",
- "desc" : "Gets the key code for the event.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getKey",
+ "name" : "addBinding",
"type" : "function",
- "desc" : "Returns a normalized keyCode for the event.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Add a new binding to this KeyMap. The following config object properties are supported:\n<pre>\nProperty Type Description\n---------- --------------- ----------------------------------------------------------------------\nkey String/Array A single keycode or an array of keycodes to handle\nshift Boolean True to handle key only when shift is pressed (defaults to false)\nctrl Boolean True to handle key only when ctrl is pressed (defaults to false)\nalt Boolean True to handle key only when alt is pressed (defaults to false)\nfn Function The function to call when KeyMap finds the expected key combination\nscope Object The scope of the callback function\n</pre>\n\nUsage:\n<pre><code>\n// Create a KeyMap\nvar map = new Roo.KeyMap(document, {\n key: Roo.EventObject.ENTER,\n fn: handleKey,\n scope: this\n});\n\n//Add a new binding to the existing KeyMap later\nmap.addBinding({\n key: 'abc',\n shift: true,\n fn: handleKey,\n scope: this\n});\n</code></pre>",
+ "sig" : "(config)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Number",
- "desc" : "The key code"
+ "name" : "config",
+ "type" : "Object/Array",
+ "desc" : "A single KeyMap config or an array of configs",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getPageX",
+ "name" : "disable",
"type" : "function",
- "desc" : "Gets the x coordinate of the event.",
+ "desc" : "Disable this KeyMap",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getPageY",
+ "name" : "enable",
"type" : "function",
- "desc" : "Gets the y coordinate of the event.",
+ "desc" : "Enables this KeyMap",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getRelatedTarget",
+ "name" : "isEnabled",
"type" : "function",
- "desc" : "Gets the related target.",
+ "desc" : "Returns true if this KeyMap is enabled",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : [
{
"name" : "",
- "type" : "HTMLElement",
+ "type" : "Boolean",
"desc" : ""
}
]
},
{
- "name" : "getTarget",
+ "name" : "on",
"type" : "function",
- "desc" : "Gets the target for the event.",
- "sig" : "(selector, maxDepth, returnEl)",
+ "desc" : "Shorthand for adding a single key listener",
+ "sig" : "(key, fn, scope)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "selector",
- "type" : "String",
- "desc" : "(optional) A simple selector to filter the target or look for an ancestor of the target",
+ "name" : "key",
+ "type" : "Number/Array/Object",
+ "desc" : "Either the numeric key code, array of key codes or an object with the\nfollowing options:\n{key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}",
"isOptional" : false
},
{
- "name" : "maxDepth",
- "type" : "Number/String/HTMLElement/Element",
- "desc" : "(optional) The max depth to\n search as a number or element (defaults to 10 || document.body)",
- "isOptional" : false
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
},
{
- "name" : "returnEl",
- "type" : "Boolean",
- "desc" : "(optional) True to return a Roo.Element object instead of DOM node",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the function",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "HTMLelement",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getTime",
- "type" : "function",
- "desc" : "Gets the time of the event.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getWheelDelta",
- "type" : "function",
- "desc" : "Normalizes mouse wheel delta across browsers",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "The delta"
- }
- ]
- },
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.KeyNav" : {
+ "props" : [
{
- "name" : "getXY",
- "type" : "function",
- "desc" : "Gets the page coordinates of the event.",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "name" : "defaultEventAction",
+ "type" : "String",
+ "desc" : "The method to call on the {@link Roo.EventObject} after this KeyNav intercepts a key. Valid values are\n{@link Roo.EventObject#stopEvent}, {@link Roo.EventObject#preventDefault} and\n{@link Roo.EventObject#stopPropagation} (defaults to 'stopEvent')",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Array",
- "desc" : "The xy values like [x, y]"
- }
- ]
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "hasModifier",
- "type" : "function",
- "desc" : "Returns true if the control, meta, shift or alt key was pressed during this event.",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "True to disable this KeyNav instance (defaults to false)",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "preventDefault",
- "type" : "function",
- "desc" : "Prevents the browsers default handling of the event.",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "name" : "forceKeyDown",
+ "type" : "Boolean",
+ "desc" : "Handle the keydown event instead of keypress (defaults to false). KeyNav automatically does this for IE since\nIE does not propagate special keys on keypress, but setting this to true will force other browsers to also\nhandle keydown instead of keypress.",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
{
- "name" : "stopEvent",
+ "name" : "disable",
"type" : "function",
- "desc" : "Stop the event (preventDefault and stopPropagation)",
+ "desc" : "Disable this KeyNav",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : []
},
{
- "name" : "stopPropagation",
+ "name" : "enable",
"type" : "function",
- "desc" : "Cancels bubbling of the event.",
+ "desc" : "Enable this KeyNav",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"requires" : "",
"params" : [],
"returns" : []
- },
- {
- "name" : "within",
- "type" : "function",
- "desc" : "Returns true if the target of this event equals el or is a child of el",
- "sig" : "(el, related)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "related",
- "type" : "Boolean",
- "desc" : "(optional) true to test if the related target is within el instead of the target",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.Fx" : {
+ "Roo.Layer" : {
"props" : [
{
- "name" : "afterCls",
+ "name" : "cls",
"type" : "String",
- "desc" : "A css class to apply after the effect",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "afterStyle",
- "type" : "String/Object/Function",
- "desc" : "A style specification string, e.g. \"width:100px\", or an object in the form {width:\"100px\"}, or\na function which returns such a specification that will be applied to the Element after the effect finishes",
+ "desc" : "CSS class to add to the element",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "block",
+ "name" : "constrain",
"type" : "Boolean",
- "desc" : "Whether the effect should block other effects from queueing while it runs",
+ "desc" : "False to disable constrain to viewport (defaults to true)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "callback",
- "type" : "Function",
- "desc" : "A function called when the effect is finished",
+ "name" : "dh",
+ "type" : "Object",
+ "desc" : "DomHelper object config to create element with (defaults to {tag: \"div\", cls: \"x-layer\"}).",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "concurrent",
- "type" : "Boolean",
- "desc" : "Whether to allow subsequently-queued effects to run at the same time as the current effect, or to ensure that they run in sequence",
+ "name" : "shadow",
+ "type" : "String/Boolean",
+ "desc" : "True to create a shadow element with default class \"x-layer-shadow\", or\nyou can pass a string with a CSS class name. False turns off the shadow.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "duration",
+ "name" : "shadowOffset",
"type" : "Number",
- "desc" : "The length of time (in seconds) that the effect should last",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "easing",
- "type" : "String",
- "desc" : "A valid Easing value for the effect",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "remove",
- "type" : "Boolean",
- "desc" : "Whether the Element should be removed from the DOM and destroyed after the effect finishes",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "The scope of the effect function",
+ "desc" : "Number of pixels to offset the shadow (defaults to 3)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "stopFx",
+ "name" : "shim",
"type" : "Boolean",
- "desc" : "Whether subsequent effects should be stopped and removed after the current effect finishes",
+ "desc" : "False to disable the iframe shim in browsers which need one (defaults to true)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "useDisplay",
- "type" : "Boolean",
- "desc" : "Whether to use the <i>display</i> CSS property instead of <i>visibility</i> when hiding Elements (only applies to \neffects that end with the element being visually hidden, ignored otherwise)",
+ "name" : "zindex",
+ "type" : "Number",
+ "desc" : "Starting z-index (defaults to 11000)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"events" : [],
"methods" : [
{
- "name" : "fadeIn",
+ "name" : "addClass",
"type" : "function",
- "desc" : "Fade an element in (from transparent to opaque). The ending opacity can be specified\nusing the \"endOpacity\" config option.\nUsage:\n<pre><code>\n// default: fade in from opacity 0 to 100%\nel.fadeIn();\n\n// custom: fade in from opacity 0 to 75% over 2 seconds\nel.fadeIn({ endOpacity: .75, duration: 2});\n\n// common config options shown with default values\nel.fadeIn({\n endOpacity: 1, //can be any value between 0 and 1 (e.g. .5)\n easing: 'easeOut',\n duration: .5\n});\n</code></pre>",
- "sig" : "(options)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out.",
+ "sig" : "(className)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) Object literal with any of the Fx config options",
+ "name" : "className",
+ "type" : "String/Array",
+ "desc" : "The CSS class to add, or an array of classes",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "The Element"
+ "desc" : "this"
}
]
},
{
- "name" : "fadeOut",
+ "name" : "addClassOnClick",
"type" : "function",
- "desc" : "Fade an element out (from opaque to transparent). The ending opacity can be specified\nusing the \"endOpacity\" config option.\nUsage:\n<pre><code>\n// default: fade out from the element's current opacity to 0\nel.fadeOut();\n\n// custom: fade out from the element's current opacity to 25% over 2 seconds\nel.fadeOut({ endOpacity: .25, duration: 2});\n\n// common config options shown with default values\nel.fadeOut({\n endOpacity: 0, //can be any value between 0 and 1 (e.g. .5)\n easing: 'easeOut',\n duration: .5\n remove: false,\n useDisplay: false\n});\n</code></pre>",
- "sig" : "(options)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Sets up event handlers to add and remove a css class when the mouse is down and then up on this element (a click effect)",
+ "sig" : "(className)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) Object literal with any of the Fx config options",
+ "name" : "className",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "The Element"
+ "desc" : "this"
}
]
},
{
- "name" : "frame",
+ "name" : "addClassOnFocus",
"type" : "function",
- "desc" : "Shows a ripple of exploding, attenuating borders to draw attention to an Element.\nUsage:\n<pre><code>\n// default: a single light blue ripple\nel.frame();\n\n// custom: 3 red ripples lasting 3 seconds total\nel.frame(\"ff0000\", 3, { duration: 3 });\n\n// common config options shown with default values\nel.frame(\"C3DAF9\", 1, {\n duration: 1 //duration of entire animation (not each individual ripple)\n // Note: Easing is not configurable and will be ignored if included\n});\n</code></pre>",
- "sig" : "(color, count, options)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Sets up event handlers to add and remove a css class when this element has the focus",
+ "sig" : "(className)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "color",
+ "name" : "className",
"type" : "String",
- "desc" : "(optional) The color of the border. Should be a 6 char hex color without the leading # (defaults to light blue: 'C3DAF9').",
- "isOptional" : false
- },
- {
- "name" : "count",
- "type" : "Number",
- "desc" : "(optional) The number of ripples to display (defaults to 1)",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) Object literal with any of the Fx config options",
+ "desc" : "",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "The Element"
+ "desc" : "this"
}
]
},
{
- "name" : "ghost",
+ "name" : "addClassOnOver",
"type" : "function",
- "desc" : "Slides the element while fading it out of view. An anchor point can be optionally passed to set the \nending point of the effect.\nUsage:\n<pre><code>\n// default: slide the element downward while fading out\nel.ghost();\n\n// custom: slide the element out to the right with a 2-second duration\nel.ghost('r', { duration: 2 });\n\n// common config options shown with default values\nel.ghost('b', {\n easing: 'easeOut',\n duration: .5\n remove: false,\n useDisplay: false\n});\n</code></pre>",
- "sig" : "(anchor, options)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Sets up event handlers to add and remove a css class when the mouse is over this element",
+ "sig" : "(className, preventFlicker)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "anchor",
+ "name" : "className",
"type" : "String",
- "desc" : "(optional) One of the valid Fx anchor positions (defaults to bottom: 'b')",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) Object literal with any of the Fx config options",
+ "name" : "preventFlicker",
+ "type" : "Boolean",
+ "desc" : "(optional) If set to true, it prevents flickering by filtering\nmouseout events for children elements",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "The Element"
+ "desc" : "this"
}
]
},
{
- "name" : "hasActiveFx",
+ "name" : "addKeyListener",
"type" : "function",
- "desc" : "Returns true if the element has any effects actively running or queued, else returns false.",
- "sig" : "()\n{\n\n}",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Convenience method for constructing a KeyMap",
+ "sig" : "(key, fn, scope)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "key",
+ "type" : "Number/Array/Object/String",
+ "desc" : "Either a string with the keys to listen for, the numeric key code, array of key codes or an object with the following options:\n {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the function",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if element has active effects, else false"
+ "type" : "Roo.KeyMap",
+ "desc" : "The KeyMap created"
}
]
},
{
- "name" : "hasFxBlock",
+ "name" : "addKeyMap",
"type" : "function",
- "desc" : "Returns true if the element is currently blocking so that no other effect can be queued\nuntil this effect is finished, else returns false if blocking is not set. This is commonly\nused to ensure that an effect initiated by a user action runs to completion prior to the\nsame effect being restarted (e.g., firing only one effect even if the user clicks several times).",
- "sig" : "()\n{\n\n}",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Creates a KeyMap for this element",
+ "sig" : "(config)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The KeyMap config. See {@link Roo.KeyMap} for more details",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if blocking, else false"
+ "type" : "Roo.KeyMap",
+ "desc" : "The KeyMap created"
}
]
},
{
- "name" : "highlight",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Highlights the Element by setting a color (applies to the background-color by default, but can be\nchanged using the \"attr\" config option) and then fading back to the original color. If no original\ncolor is available, you should provide the \"endColor\" config option which will be cleared after the animation.\nUsage:\n<pre><code>\n// default: highlight background to yellow\nel.highlight();\n\n// custom: highlight foreground text to blue for 2 seconds\nel.highlight(\"0000ff\", { attr: 'color', duration: 2 });\n\n// common config options shown with default values\nel.highlight(\"ffff9c\", {\n attr: \"background-color\", //can be any valid CSS property (attribute) that supports a color value\n endColor: (current color) or \"ffffff\",\n easing: 'easeIn',\n duration: 1\n});\n</code></pre>",
- "sig" : "(color, options)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Appends an event handler",
+ "sig" : "(eventName, fn, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "color",
+ "name" : "eventName",
"type" : "String",
- "desc" : "(optional) The highlight color. Should be a 6 char hex color without the leading # (defaults to yellow: 'ffff9c')",
+ "desc" : "The type of event to append",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) of the fn",
"isOptional" : false
},
{
"name" : "options",
"type" : "Object",
- "desc" : "(optional) Object literal with any of the Fx config options",
+ "desc" : "(optional)An object with standard {@link Roo.EventManager#addListener} options",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The Element"
- }
- ]
+ "returns" : []
},
{
- "name" : "pause",
+ "name" : "alignTo",
"type" : "function",
- "desc" : "Creates a pause before any subsequent queued effects begin. If there are\nno effects queued after the pause it will have no effect.\nUsage:\n<pre><code>\nel.pause(1);\n</code></pre>",
- "sig" : "(seconds)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Aligns this element with another element relative to the specified anchor points. If the other element is the\ndocument it aligns it to the viewport.\nThe position parameter is optional, and can be specified in any one of the following formats:\n<ul>\n <li><b>Blank</b>: Defaults to aligning the element's top-left corner to the target's bottom-left corner (\"tl-bl\").</li>\n <li><b>One anchor (deprecated)</b>: The passed anchor position is used as the target element's anchor point.\n The element being aligned will position its top-left corner (tl) to that point. <i>This method has been\n deprecated in favor of the newer two anchor syntax below</i>.</li>\n <li><b>Two anchors</b>: If two values from the table below are passed separated by a dash, the first value is used as the\n element's anchor point, and the second value is used as the target's anchor point.</li>\n</ul>\nIn addition to the anchor points, the position parameter also supports the \"?\" character. If \"?\" is passed at the end of\nthe position string, the element will attempt to align as specified, but the position will be adjusted to constrain to\nthe viewport if necessary. Note that the element being aligned might be swapped to align to a different position than\nthat specified in order to enforce the viewport constraints.\nFollowing are all of the supported anchor positions:\n <pre>\n Value Description\n ----- -----------------------------\n tl The top left corner (default)\n t The center of the top edge\n tr The top right corner\n l The center of the left edge\n c In the center of the element\n r The center of the right edge\n bl The bottom left corner\n b The center of the bottom edge\n br The bottom right corner\n </pre>\n Example Usage:\n <pre><code>\n // align el to other-el using the default positioning (\"tl-bl\", non-constrained)\n el.alignTo(\"other-el\");\n\n // align the top left corner of el with the top right corner of other-el (constrained to viewport)\n el.alignTo(\"other-el\", \"tr?\");\n\n // align the bottom right corner of el with the center left edge of other-el\n el.alignTo(\"other-el\", \"br-l?\");\n\n // align the center of el with the bottom left corner of other-el and\n // adjust the x position by -6 pixels (and the y position by 0)\n el.alignTo(\"other-el\", \"c-bl\", [-6, 0]);\n </code></pre>",
+ "sig" : "(element, position, offsets, animate)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "seconds",
- "type" : "Number",
- "desc" : "The length of time to pause (in seconds)",
+ "name" : "element",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element to align to.",
+ "isOptional" : false
+ },
+ {
+ "name" : "position",
+ "type" : "String",
+ "desc" : "The position to align to.",
+ "isOptional" : false
+ },
+ {
+ "name" : "offsets",
+ "type" : "Array",
+ "desc" : "(optional) Offset the positioning by [x, y]",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "The Element"
+ "desc" : "this"
}
]
},
{
- "name" : "puff",
+ "name" : "anchorTo",
"type" : "function",
- "desc" : "Fades the element out while slowly expanding it in all directions. When the effect is completed, the \nelement will be hidden (visibility = 'hidden') but block elements will still take up space in the document. \nThe element must be removed from the DOM using the 'remove' config option if desired.\nUsage:\n<pre><code>\n// default\nel.puff();\n\n// common config options shown with default values\nel.puff({\n easing: 'easeOut',\n duration: .5,\n remove: false,\n useDisplay: false\n});\n</code></pre>",
- "sig" : "(options)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Anchors an element to another element and realigns it when the window is resized.",
+ "sig" : "(element, position, offsets, animate, monitorScroll, callback)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) Object literal with any of the Fx config options",
+ "name" : "element",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element to align to.",
+ "isOptional" : false
+ },
+ {
+ "name" : "position",
+ "type" : "String",
+ "desc" : "The position to align to.",
+ "isOptional" : false
+ },
+ {
+ "name" : "offsets",
+ "type" : "Array",
+ "desc" : "(optional) Offset the positioning by [x, y]",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) True for the default animation or a standard Element animation config object",
+ "isOptional" : false
+ },
+ {
+ "name" : "monitorScroll",
+ "type" : "Boolean/Number",
+ "desc" : "(optional) True to monitor body scroll and reposition. If this parameter\nis a number, it is used as the buffer delay (defaults to 50ms).",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "The function to call after the animation finishes",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "The Element"
+ "desc" : "this"
}
]
},
{
- "name" : "scale",
+ "name" : "animate",
"type" : "function",
- "desc" : "Animates the transition of an element's dimensions from a starting height/width\nto an ending height/width.\nUsage:\n<pre><code>\n// change height and width to 100x100 pixels\nel.scale(100, 100);\n\n// common config options shown with default values. The height and width will default to\n// the element's existing values if passed as null.\nel.scale(\n [element's width],\n [element's height], {\n easing: 'easeOut',\n duration: .35\n});\n</code></pre>",
- "sig" : "(width, height, options)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Perform animation on this element.",
+ "sig" : "(args, duration, onComplete, easing, animType)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "width",
- "type" : "Number",
- "desc" : "The new width (pass undefined to keep the original width)",
+ "name" : "args",
+ "type" : "Object",
+ "desc" : "The YUI animation control args",
"isOptional" : false
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "The new height (pass undefined to keep the original height)",
+ "name" : "duration",
+ "type" : "Float",
+ "desc" : "(optional) How long the animation lasts in seconds (defaults to .35)",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) Object literal with any of the Fx config options",
+ "name" : "onComplete",
+ "type" : "Function",
+ "desc" : "(optional) Function to call when animation completes",
+ "isOptional" : false
+ },
+ {
+ "name" : "easing",
+ "type" : "String",
+ "desc" : "(optional) Easing method to use (defaults to 'easeOut')",
+ "isOptional" : false
+ },
+ {
+ "name" : "animType",
+ "type" : "String",
+ "desc" : "(optional) 'run' is the default. Can also be 'color', 'motion', or 'scroll'",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "The Element"
+ "desc" : "this"
}
]
},
{
- "name" : "sequenceFx",
+ "name" : "appendChild",
"type" : "function",
- "desc" : "Ensures that all effects queued after sequenceFx is called on the element are\nrun in sequence. This is the opposite of {@link #syncFx}.",
- "sig" : "()\n{\n\n}",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Appends the passed element(s) to this element",
+ "sig" : "(el)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Array/Element/CompositeElement",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "The Element"
+ "desc" : "this"
}
]
},
{
- "name" : "shift",
+ "name" : "appendTo",
"type" : "function",
- "desc" : "Animates the transition of any combination of an element's dimensions, xy position and/or opacity.\nAny of these properties not specified in the config object will not be changed. This effect \nrequires that at least one new dimension, position or opacity setting must be passed in on\nthe config object in order for the function to have any effect.\nUsage:\n<pre><code>\n// slide the element horizontally to x position 200 while changing the height and opacity\nel.shift({ x: 200, height: 50, opacity: .8 });\n\n// common config options shown with default values.\nel.shift({\n width: [element's width],\n height: [element's height],\n x: [element's x position],\n y: [element's y position],\n opacity: [element's opacity],\n easing: 'easeOut',\n duration: .35\n});\n</code></pre>",
- "sig" : "(options)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Appends this element to the passed element",
+ "sig" : "(el)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "Object literal with any of the Fx config options",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The new parent element",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "The Element"
+ "desc" : "this"
}
]
},
{
- "name" : "slideIn",
+ "name" : "applyStyles",
"type" : "function",
- "desc" : "Slides the element into view. An anchor point can be optionally passed to set the point of\norigin for the slide effect. This function automatically handles wrapping the element with\na fixed-size container if needed. See the Fx class overview for valid anchor point options.\nUsage:\n<pre><code>\n// default: slide the element in from the top\nel.slideIn();\n\n// custom: slide the element in from the right with a 2-second duration\nel.slideIn('r', { duration: 2 });\n\n// common config options shown with default values\nel.slideIn('t', {\n easing: 'easeOut',\n duration: .5\n});\n</code></pre>",
- "sig" : "(anchor, options)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "More flexible version of {@link #setStyle} for setting style properties.",
+ "sig" : "(styles)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "anchor",
- "type" : "String",
- "desc" : "(optional) One of the valid Fx anchor positions (defaults to top: 't')",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) Object literal with any of the Fx config options",
+ "name" : "styles",
+ "type" : "String/Object/Function",
+ "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "The Element"
+ "desc" : "this"
}
]
},
{
- "name" : "slideOut",
+ "name" : "attr",
"type" : "function",
- "desc" : "Slides the element out of view. An anchor point can be optionally passed to set the end point\nfor the slide effect. When the effect is completed, the element will be hidden (visibility = \n'hidden') but block elements will still take up space in the document. The element must be removed\nfrom the DOM using the 'remove' config option if desired. This function automatically handles \nwrapping the element with a fixed-size container if needed. See the Fx class overview for valid anchor point options.\nUsage:\n<pre><code>\n// default: slide the element out to the top\nel.slideOut();\n\n// custom: slide the element out to the right with a 2-second duration\nel.slideOut('r', { duration: 2 });\n\n// common config options shown with default values\nel.slideOut('t', {\n easing: 'easeOut',\n duration: .5,\n remove: false,\n useDisplay: false\n});\n</code></pre>",
- "sig" : "(anchor, options)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Sets or Returns the value the dom attribute value",
+ "sig" : "(name, value)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "anchor",
- "type" : "String",
- "desc" : "(optional) One of the valid Fx anchor positions (defaults to top: 't')",
+ "name" : "name",
+ "type" : "String|Object",
+ "desc" : "The attribute name (or object to set multiple attributes)",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) Object literal with any of the Fx config options",
+ "name" : "value",
+ "type" : "String",
+ "desc" : "(optional) The value to set the attribute to",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The Element"
+ "type" : "String",
+ "desc" : "The attribute value"
}
]
},
{
- "name" : "stopFx",
+ "name" : "autoHeight",
"type" : "function",
- "desc" : "Stops any running effects and clears the element's internal effects queue if it contains\nany additional effects that haven't started yet.",
- "sig" : "()\n{\n\n}",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Measures the element's content height and updates height to match. Note: this function uses setTimeout so\nthe new height may not be available immediately.",
+ "sig" : "(animate, duration, onComplete, easing)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "animate",
+ "type" : "Boolean",
+ "desc" : "(optional) Animate the transition (defaults to false)",
+ "isOptional" : false
+ },
+ {
+ "name" : "duration",
+ "type" : "Float",
+ "desc" : "(optional) Length of the animation in seconds (defaults to .35)",
+ "isOptional" : false
+ },
+ {
+ "name" : "onComplete",
+ "type" : "Function",
+ "desc" : "(optional) Function to call when animation completes",
+ "isOptional" : false
+ },
+ {
+ "name" : "easing",
+ "type" : "String",
+ "desc" : "(optional) Easing method to use (defaults to easeOut)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "The Element"
+ "desc" : "this"
}
]
},
{
- "name" : "switchOff",
+ "name" : "beginMeasure",
"type" : "function",
- "desc" : "Blinks the element as if it was clicked and then collapses on its center (similar to switching off a television).\nWhen the effect is completed, the element will be hidden (visibility = 'hidden') but block elements will still \ntake up space in the document. The element must be removed from the DOM using the 'remove' config option if desired.\nUsage:\n<pre><code>\n// default\nel.switchOff();\n\n// all config options shown with default values\nel.switchOff({\n easing: 'easeIn',\n duration: .3,\n remove: false,\n useDisplay: false\n});\n</code></pre>",
- "sig" : "(options)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Temporarily enables offsets (width,height,x,y) for an element with display:none, use endMeasure() when done.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) Object literal with any of the Fx config options",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "The Element"
+ "desc" : "this"
}
]
},
{
- "name" : "syncFx",
+ "name" : "blur",
"type" : "function",
- "desc" : "Ensures that all effects queued after syncFx is called on the element are\nrun concurrently. This is the opposite of {@link #sequenceFx}.",
+ "desc" : "Tries to blur the element. Any exceptions are caught and ignored.",
"sig" : "()\n{\n\n}",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "The Element"
+ "desc" : "this"
}
]
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.GridPanel" : {
- "props" : [
- {
- "name" : "adjustments",
- "type" : "Array",
- "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
- "memberOf" : "Roo.ContentPanel",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoCreate",
- "type" : "Boolean|Object",
- "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
- "memberOf" : "Roo.ContentPanel",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoScroll",
- "type" : "Boolean",
- "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
- "memberOf" : "Roo.ContentPanel",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "background",
- "type" : "Boolean",
- "desc" : "True if the panel should not be activated when it is added (defaults to false)",
- "memberOf" : "Roo.ContentPanel",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "closable",
- "type" : "Boolean",
- "desc" : "True if the panel can be closed/removed",
- "memberOf" : "Roo.ContentPanel",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "content",
- "type" : "String",
- "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
- "memberOf" : "Roo.ContentPanel",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fitContainer",
- "type" : "Boolean",
- "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
- "memberOf" : "Roo.ContentPanel",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fitToFrame",
- "type" : "Boolean",
- "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
- "memberOf" : "Roo.ContentPanel",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "grid",
- "type" : "Roo.grid.Grid",
- "desc" : "The grid for this panel",
- "memberOf" : "Roo",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "loadOnce",
- "type" : "Boolean",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.ContentPanel",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "menu",
- "type" : "Roo.menu.Menu",
- "desc" : "popup menu",
- "memberOf" : "Roo.ContentPanel",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "params",
- "type" : "String|Object",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.ContentPanel",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "region",
- "type" : "String",
- "desc" : "t) which region to put this panel on (when used with xtype constructor",
- "memberOf" : "Roo.ContentPanel",
- "isOptional" : false,
- "optvals" : [
- "center",
- "north",
- "south",
- "east",
- "west"
- ]
- },
- {
- "name" : "resizeEl",
- "type" : "String|HTMLElement|Element",
- "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
- "memberOf" : "Roo.ContentPanel",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "Extra style to add to the content panel",
- "memberOf" : "Roo.ContentPanel",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "title",
- "type" : "String",
- "desc" : "The title for this panel",
- "memberOf" : "Roo.ContentPanel",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "toolbar",
- "type" : "Roo.Toolbar",
- "desc" : "A toolbar for this panel",
- "memberOf" : "Roo.ContentPanel",
- "isOptional" : false,
- "optvals" : []
},
{
- "name" : "url",
- "type" : "String",
- "desc" : "Calls {@link #setUrl} with this value",
- "memberOf" : "Roo.ContentPanel",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "activate",
+ "name" : "boxWrap",
"type" : "function",
- "desc" : "Fires when this panel is activated.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.ContentPanel",
+ "desc" : "Wraps the specified element with a special markup/CSS block that renders by default as a gray container with a\ngradient background, rounded corners and a 4-way shadow.",
+ "sig" : "(class)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
+ "name" : "class",
+ "type" : "String",
+ "desc" : "(optional) A base CSS class to apply to the containing wrapper element (defaults to 'x-box').\nNote that there are a number of CSS rules that are dependent on this name to make the overall effect work,\nso if you supply an alternate base class, make sure you also supply all of the necessary rules.",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "deactivate",
+ "name" : "center",
"type" : "function",
- "desc" : "Fires when this panel is activated.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.ContentPanel",
+ "desc" : "Centers the Element in either the viewport, or another Element.",
+ "sig" : "(centerIn)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
+ "name" : "centerIn",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "(optional) The element in which to center the element.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "child",
"type" : "function",
- "desc" : "Fires when this tab is created",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.ContentPanel",
+ "desc" : "Selects a single child at any depth below this element based on the passed CSS selector (the selector should not contain an id).",
+ "sig" : "(selector, returnDom)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
+ "name" : "selector",
+ "type" : "String",
+ "desc" : "The CSS selector",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnDom",
+ "type" : "Boolean",
+ "desc" : "(optional) True to return the DOM node instead of Roo.Element (defaults to false)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The child Roo.Element (or DOM node if returnDom = true)"
+ }
+ ]
},
{
- "name" : "resize",
+ "name" : "clean",
"type" : "function",
- "desc" : "Fires when this panel is resized if fitToFrame is true.",
- "sig" : "function (_self, width, height)\n{\n\n}",
- "memberOf" : "Roo.ContentPanel",
+ "desc" : "Removes worthless text nodes",
+ "sig" : "(forceReclean)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The width after any component adjustments",
- "isOptional" : false
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "The height after any component adjustments",
+ "name" : "forceReclean",
+ "type" : "Boolean",
+ "desc" : "(optional) By default the element\nkeeps track if it has been cleaned already so\nyou can call this over and over. However, if you update the element and\nneed to force a reclean, you can pass true.",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "addEvents",
+ "name" : "clearOpacity",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Clears any opacity settings from this element. Required in some cases for IE.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "addListener",
+ "name" : "clearPositioning",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Clear positioning back to the default when the document was loaded",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "value",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "desc" : "(optional) The value to use for the left,right,top,bottom, defaults to '' (empty string). You could use 'auto'.",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "addxtype",
+ "name" : "clip",
"type" : "function",
- "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'Form',\n items: [ .... ]\n }\n);\n\n</code></pre>",
- "sig" : "(cfg)",
+ "desc" : "Store the current overflow setting and clip overflow on the element - use {@link #unclip} to remove",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "cfg",
- "type" : "Object",
- "desc" : "Xtype definition of item to add.",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "capture",
+ "name" : "contains",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Returns true if this element is an ancestor of the passed element",
+ "sig" : "(el)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "el",
+ "type" : "HTMLElement/String",
+ "desc" : "The element to check",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this panel",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.ContentPanel",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if this element is an ancestor of el, else false"
+ }
+ ]
},
{
- "name" : "fireEvent",
+ "name" : "createChild",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child element.",
+ "sig" : "(config, insertBefore, returnDom)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "DomHelper element config object. If no tag is specified (e.g., {tag:'input'}) then a div will be\nautomatically generated with the specified attributes.",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "insertBefore",
+ "type" : "HTMLElement",
+ "desc" : "(optional) a child element of this element",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnDom",
+ "type" : "Boolean",
+ "desc" : "(optional) true to return the dom node instead of creating an Element",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "Roo.Element",
+ "desc" : "The new child element"
}
]
},
{
- "name" : "getEl",
+ "name" : "createProxy",
"type" : "function",
- "desc" : "Returns this panel's element - used by regiosn to add.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Creates a proxy element of this element",
+ "sig" : "(config, renderTo, matchBox)",
"static" : false,
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "String/Object",
+ "desc" : "The class name of the proxy element or a DomHelper config object",
+ "isOptional" : false
+ },
+ {
+ "name" : "renderTo",
+ "type" : "String/HTMLElement",
+ "desc" : "(optional) The element or element id to render the proxy to (defaults to document.body)",
+ "isOptional" : false
+ },
+ {
+ "name" : "matchBox",
+ "type" : "Boolean",
+ "desc" : "(optional) True to align and size the proxy to this element now (defaults to false)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
"type" : "Roo.Element",
- "desc" : ""
+ "desc" : "The new proxy element"
}
]
},
{
- "name" : "getGrid",
+ "name" : "createShim",
"type" : "function",
- "desc" : "Returns the grid for this panel",
+ "desc" : "Creates an iframe shim for this element to keep selects and other windowed objects from\nshowing through.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.grid.Grid",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "The new shim element"
}
]
},
{
- "name" : "getId",
+ "name" : "down",
"type" : "function",
- "desc" : "Returns this panel's id",
- "sig" : "()\n{\n\n}",
+ "desc" : "Selects a single *direct* child based on the passed CSS selector (the selector should not contain an id).",
+ "sig" : "(selector, returnDom)",
"static" : false,
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "selector",
+ "type" : "String",
+ "desc" : "The CSS selector",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnDom",
+ "type" : "Boolean",
+ "desc" : "(optional) True to return the DOM node instead of Roo.Element (defaults to false)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The child Roo.Element (or DOM node if returnDom = true)"
}
]
},
{
- "name" : "getTitle",
+ "name" : "enableDisplayMode",
"type" : "function",
- "desc" : "Returns this panel's title",
- "sig" : "()\n{\n\n}",
+ "desc" : "Convenience method for setVisibilityMode(Element.DISPLAY)",
+ "sig" : "(display)",
"static" : false,
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "display",
+ "type" : "String",
+ "desc" : "(optional) What to set display to when visible",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "this"
}
]
},
{
- "name" : "getToolbar",
+ "name" : "endMeasure",
"type" : "function",
- "desc" : "Returns the toolbar for this Panel if one was configured.",
+ "desc" : "Restores displays to before beginMeasure was called",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Toolbar",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "this"
}
]
},
{
- "name" : "getUpdateManager",
+ "name" : "findParent",
"type" : "function",
- "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Looks at this node and then at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)",
+ "sig" : "(selector, maxDepth, returnEl)",
"static" : false,
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "selector",
+ "type" : "String",
+ "desc" : "The simple selector to test",
+ "isOptional" : false
+ },
+ {
+ "name" : "maxDepth",
+ "type" : "Number/String/HTMLElement/Element",
+ "desc" : "(optional) The max depth to\n search as a number or element (defaults to 10 || document.body)",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnEl",
+ "type" : "Boolean",
+ "desc" : "(optional) True to return a Roo.Element object instead of DOM node",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.UpdateManager",
- "desc" : "The UpdateManager"
+ "type" : "HTMLElement",
+ "desc" : "The matching DOM node (or null if no match was found)"
}
]
},
{
- "name" : "hasListener",
+ "name" : "findParentNode",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)",
+ "sig" : "(selector, maxDepth, returnEl)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "selector",
"type" : "String",
- "desc" : "The name of the event to check for",
+ "desc" : "The simple selector to test",
+ "isOptional" : false
+ },
+ {
+ "name" : "maxDepth",
+ "type" : "Number/String/HTMLElement/Element",
+ "desc" : "(optional) The max depth to\n search as a number or element (defaults to 10 || document.body)",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnEl",
+ "type" : "Boolean",
+ "desc" : "(optional) True to return a Roo.Element object instead of DOM node",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "HTMLElement",
+ "desc" : "The matching DOM node (or null if no match was found)"
}
]
},
{
- "name" : "isClosable",
+ "name" : "findScrollableParent",
"type" : "function",
- "desc" : "Returns true is this panel was configured to be closable",
+ "desc" : "Looks at the scrollable parent element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "load",
+ "name" : "fitToParent",
"type" : "function",
- "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.",
- "sig" : "(url, params, callback, discardUrl)",
+ "desc" : "Sizes this element to its parent element's dimensions performing\nneccessary box adjustments.",
+ "sig" : "(monitorResize, targetParent)",
"static" : false,
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "url",
- "type" : "Object/String/Function",
- "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\npanel.load({\n url: \"your-url.php\",\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n callback: yourFunction,\n scope: yourObject, //(optional scope)\n discardUrl: false,\n nocache: false,\n text: \"Loading...\",\n timeout: 30,\n scripts: false\n});\n</code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
+ "name" : "monitorResize",
+ "type" : "Boolean",
+ "desc" : "(optional) If true maintains the fit when the browser window is resized.",
"isOptional" : false
},
{
- "name" : "discardUrl",
- "type" : "Boolean",
- "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
+ "name" : "targetParent",
+ "type" : "String/HTMLElment/Element",
+ "desc" : "(optional) The target parent, default to the parentNode.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
+ "type" : "Roo.Element",
"desc" : "this"
}
]
},
{
- "name" : "on",
+ "name" : "fly",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
+ "desc" : "Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element -\nthe dom node can be overwritten by other code.",
+ "sig" : "(el, named)",
+ "static" : true,
+ "memberOf" : "Roo.Element",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "el",
+ "type" : "String/HTMLElement",
+ "desc" : "The dom node or id",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "named",
+ "type" : "String",
+ "desc" : "(optional) Allows for creation of named reusable flyweights to\n prevent conflicts (e.g. internally Roo uses \"_internal\")",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Element",
+ "desc" : "The shared Element object"
+ }
+ ]
},
{
- "name" : "purgeListeners",
+ "name" : "focus",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Tries to focus the element. Any exceptions are caught and ignored.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "refresh",
+ "name" : "get",
"type" : "function",
- "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.ContentPanel",
- "isStatic" : false,
+ "desc" : "Static method to retrieve Element objects. Uses simple caching to consistently return the same object.\nAutomatically fixes if an object was recreated with the same id via AJAX or DOM.",
+ "sig" : "(el)",
+ "static" : true,
+ "memberOf" : "Roo.Element",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id of the node, a DOM Node or an existing Element.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Element",
+ "desc" : "The Element object"
+ }
+ ]
},
{
- "name" : "releaseCapture",
+ "name" : "getAlignToXY",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Gets the x,y coordinates to align this element with another element. See {@link #alignTo} for more info on the\nsupported position values.",
+ "sig" : "(element, position, offsets)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "element",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element to align to.",
+ "isOptional" : false
+ },
+ {
+ "name" : "position",
+ "type" : "String",
+ "desc" : "The position to align to.",
+ "isOptional" : false
+ },
+ {
+ "name" : "offsets",
+ "type" : "Array",
+ "desc" : "(optional) Offset the positioning by [x, y]",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "[x, y]"
+ }
+ ]
},
{
- "name" : "removeListener",
+ "name" : "getAnchorXY",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Gets the x,y coordinates specified by the anchor position on the element.",
+ "sig" : "(anchor, size, local)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "anchor",
"type" : "String",
- "desc" : "The type of event to listen for",
+ "desc" : "(optional) The specified anchor position (defaults to \"c\"). See {@link #alignTo} for details on supported anchor positions.",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "size",
+ "type" : "Object",
+ "desc" : "(optional) An object containing the size to use for calculating anchor position\n {width: (target width), height: (target height)} (defaults to the element's current size)",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) True to get the local (element top/left-relative) anchor position instead of page coordinates",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "[x, y] An array containing the element's x and y coordinates"
+ }
+ ]
},
{
- "name" : "setContent",
+ "name" : "getAttributeNS",
"type" : "function",
- "desc" : "Updates this panel's element",
- "sig" : "(content, loadScripts)",
+ "desc" : "Returns the value of a namespaced attribute from the element's underlying DOM node.",
+ "sig" : "(namespace, name)",
"static" : false,
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "content",
+ "name" : "namespace",
"type" : "String",
- "desc" : "The new content",
+ "desc" : "The namespace in which to look for the attribute",
"isOptional" : false
},
{
- "name" : "loadScripts",
- "type" : "Boolean",
- "desc" : "(optional) true to look for and process scripts",
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The attribute name",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "The attribute value"
+ }
+ ]
},
{
- "name" : "setTitle",
+ "name" : "getBorderWidth",
"type" : "function",
- "desc" : "Set this panel's title",
- "sig" : "(title)",
+ "desc" : "Gets the width of the border(s) for the specified side(s)",
+ "sig" : "(side)",
"static" : false,
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "title",
+ "name" : "side",
"type" : "String",
- "desc" : "",
+ "desc" : "Can be t, l, r, b or any combination of those to add multiple values. For example,\npassing lr would get the border (l)eft width + the border (r)ight width.",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The width of the sides passed added together"
+ }
+ ]
},
{
- "name" : "setUrl",
+ "name" : "getBottom",
"type" : "function",
- "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
- "sig" : "(url, params, loadOnce)",
+ "desc" : "Gets the bottom Y coordinate of the element (element Y position + element height)",
+ "sig" : "(local)",
"static" : false,
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "url",
- "type" : "String/Function",
- "desc" : "The URL to load the content from or a function to call to get the URL",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
- "isOptional" : false
- },
- {
- "name" : "loadOnce",
+ "name" : "local",
"type" : "Boolean",
- "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)",
+ "desc" : "True to get the local css position instead of page coordinate",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.UpdateManager",
- "desc" : "The UpdateManager"
+ "type" : "Number",
+ "desc" : ""
}
]
},
{
- "name" : "un",
+ "name" : "getBox",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Return a box {x, y, width, height} that can be used to set another elements\nsize/location to match this element.",
+ "sig" : "(contentBox, local)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "contentBox",
+ "type" : "Boolean",
+ "desc" : "(optional) If true a box for the content of the element is returned.",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page x/y.",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
- "name" : "scope",
+ "name" : "",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
+ "desc" : "box An object in the format {x, y, width, height}"
}
- ],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : [
- "Roo.BorderLayout",
- "Roo.LayoutDialog",
- "builder"
- ]
- },
- "Roo.HtmlEditorCore" : {
- "props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowComments",
- "type" : "boolean",
- "desc" : "- default false - allow comments in HTML source\n - by default they are stripped - if you are editing email you may need this.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoClean",
- "type" : "boolean",
- "desc" : "- default true - loading and saving will remove quite a bit of formating,\n if you are doing an email editor, this probably needs disabling, it's designed",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "css",
- "type" : "String",
- "desc" : "styling for resizing. (used on bootstrap only)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "enableBlocks",
- "type" : "boolean",
- "desc" : "- default true - if the block editor (table and figure should be enabled)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "(in pixels)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
]
},
{
- "name" : "language",
- "type" : "String",
- "desc" : "default en - language of text (usefull for rtl languages)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "css styles to add to component\neg. text-align:right;",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "stylesheets",
- "type" : "Array",
- "desc" : "url of stylesheets. set to [] to disable stylesheets.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "the",
- "type" : "Roo.form.HtmlEditor|Roo.bootstrap.HtmlEditor",
- "desc" : "owner field",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "name" : "getCenterXY",
+ "type" : "function",
+ "desc" : "Calculates the x, y to center this element on the screen",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "The x, y values [x, y]"
+ }
+ ]
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "(in pixels)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "activate",
+ "name" : "getColor",
"type" : "function",
- "desc" : "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Return the CSS color for the specified CSS attribute. rgb, 3 digit (like #fff) and valid values\nare convert to standard 6 digit hex color.",
+ "sig" : "(attr, defaultValue, prefix)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.HtmlEditorCore",
- "desc" : "",
+ "name" : "attr",
+ "type" : "String",
+ "desc" : "The css attribute",
+ "isOptional" : false
+ },
+ {
+ "name" : "defaultValue",
+ "type" : "String",
+ "desc" : "The default value to use when a valid color isn't found",
+ "isOptional" : false
+ },
+ {
+ "name" : "prefix",
+ "type" : "String",
+ "desc" : "(optional) defaults to #. Use an empty string when working with\nYUI color anims.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforedestroy",
+ "name" : "getComputedHeight",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders\nwhen needed to simulate offsetHeight when offsets aren't available. This may not work on display:none elements\nif a height has not been set using CSS.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "beforehide",
+ "name" : "getComputedWidth",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders\nwhen needed to simulate offsetWidth when offsets aren't available. This may not work on display:none elements\nif a width has not been set using CSS.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "beforepush",
+ "name" : "getFrameWidth",
"type" : "function",
- "desc" : "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push.",
- "sig" : "function (_self, html)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Returns the sum width of the padding and borders for the passed \"sides\". See getBorderWidth()\n for more information about the sides.",
+ "sig" : "(sides)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.HtmlEditorCore",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "html",
+ "name" : "sides",
"type" : "String",
"desc" : "",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "beforerender",
+ "name" : "getHeight",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Returns the offset height of the element",
+ "sig" : "(contentHeight)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "contentHeight",
+ "type" : "Boolean",
+ "desc" : "(optional) true to get the height minus borders and padding",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The element's height"
+ }
+ ]
},
{
- "name" : "beforeshow",
+ "name" : "getLeft",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Gets the left X coordinate",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "True to get the local css position instead of page coordinate",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "beforesync",
+ "name" : "getMargins",
"type" : "function",
- "desc" : "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync.",
- "sig" : "function (_self, html)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Returns an object with properties top, left, right and bottom representing the margins of this element unless sides is passed,\nthen it returns the calculated width of the sides (see getPadding)",
+ "sig" : "(sides)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.HtmlEditorCore",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "html",
+ "name" : "sides",
"type" : "String",
- "desc" : "",
+ "desc" : "(optional) Any combination of l, r, t, b to get the sum of those sides",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object/Number",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "blur",
+ "name" : "getNextSibling",
"type" : "function",
- "desc" : "",
- "sig" : "function ()\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Gets the next sibling, skipping text nodes",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "The next sibling or null"
+ }
+ ]
},
{
- "name" : "change",
+ "name" : "getPadding",
"type" : "function",
- "desc" : "",
- "sig" : "function ()\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Gets the width of the padding(s) for the specified side(s)",
+ "sig" : "(side)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [],
- "returns" : []
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "side",
+ "type" : "String",
+ "desc" : "Can be t, l, r, b or any combination of those to add multiple values. For example,\npassing lr would get the padding (l)eft + the padding (r)ight.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The padding of the sides passed added together"
+ }
+ ]
},
{
- "name" : "destroy",
+ "name" : "getPositioning",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Gets an object with all CSS positioning properties. Useful along with setPostioning to get\nsnapshot before performing an update and then restoring the element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "disable",
+ "name" : "getPrevSibling",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Gets the previous sibling, skipping text nodes",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "The previous sibling or null"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "editorevent",
+ "name" : "getRegion",
"type" : "function",
- "desc" : "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Returns the region of the given element.\nThe element must be part of the DOM tree to have a region (display:none or elements not appended return false).",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.HtmlEditorCore",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Region",
+ "desc" : "A Roo.lib.Region containing \"top, left, bottom, right\" member data."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "enable",
+ "name" : "getRight",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Gets the right X coordinate of the element (element X position + element width)",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "True to get the local css position instead of page coordinate",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "focus",
+ "name" : "getScroll",
"type" : "function",
- "desc" : "",
- "sig" : "function ()\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Returns the current scroll position of the element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "An object containing the scroll position in the format {left: (scrollLeft), top: (scrollTop)}"
+ }
+ ]
},
{
- "name" : "hide",
+ "name" : "getSize",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Returns the size of the element.",
+ "sig" : "(contentSize)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "contentSize",
+ "type" : "Boolean",
+ "desc" : "(optional) true to get the width/size minus borders and padding",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
+ }
+ ]
},
{
- "name" : "initialize",
+ "name" : "getStyle",
"type" : "function",
- "desc" : "Fires when the editor is fully initialized (including the iframe)",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Normalizes currentStyle and computedStyle. This is not YUI getStyle, it is an optimised version.",
+ "sig" : "(property)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.HtmlEditorCore",
- "desc" : "",
+ "name" : "property",
+ "type" : "String",
+ "desc" : "The style property whose value is returned.",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "The current value of the style property for this element."
+ }
+ ]
},
{
- "name" : "push",
+ "name" : "getStyles",
"type" : "function",
- "desc" : "Fires when the iframe editor is updated with content from the textarea.",
- "sig" : "function (_self, html)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Returns an object with properties matching the styles requested.\nFor example, el.getStyles('color', 'font-size', 'width') might return\n{'color': '#FFFFFF', 'font-size': '13px', 'width': '100px'}.",
+ "sig" : "(style1, style2)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.HtmlEditorCore",
- "desc" : "",
+ "name" : "style1",
+ "type" : "String",
+ "desc" : "A style name",
"isOptional" : false
},
{
- "name" : "html",
+ "name" : "style2",
"type" : "String",
- "desc" : "",
+ "desc" : "A style name",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "The style object"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "show",
+ "name" : "getTop",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Gets the top Y coordinate",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "True to get the local css position instead of page coordinate",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "",
- "sig" : "function ()\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "sync",
- "type" : "function",
- "desc" : "Fires when the textarea is updated with content from the editor iframe.",
- "sig" : "function (_self, html)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.HtmlEditorCore",
- "desc" : "",
- "isOptional" : false
- },
+ "returns" : [
{
- "name" : "html",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
}
- ],
- "returns" : []
- }
- ],
- "methods" : [
+ ]
+ },
{
- "name" : "addEvents",
+ "name" : "getUpdateManager",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Gets this element's UpdateManager",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.UpdateManager",
+ "desc" : "The UpdateManager"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "addListener",
+ "name" : "getValue",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Returns the value of the \"value\" attribute",
+ "sig" : "(asNumber)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "asNumber",
+ "type" : "Boolean",
+ "desc" : "true to parse the value as a number",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String/Number",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "capture",
+ "name" : "getViewSize",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Returns the width and height of the viewport.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "scope",
+ "name" : "",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
+ "desc" : "An object containing the viewport's size {width: (viewport width), height: (viewport height)}"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "cleanHtml",
+ "name" : "getWidth",
"type" : "function",
- "desc" : "Protected method that will not generally be called directly. If you need/want\ncustom HTML cleanup, this is the method you should override.",
- "sig" : "(html)",
+ "desc" : "Returns the offset width of the element",
+ "sig" : "(contentWidth)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "html",
- "type" : "String",
- "desc" : "The HTML to be cleaned\nreturn {String} The cleaned HTML",
+ "name" : "contentWidth",
+ "type" : "Boolean",
+ "desc" : "(optional) true to get the width minus borders and padding",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The element's width"
+ }
+ ]
},
{
- "name" : "cleanTableWidths",
+ "name" : "getX",
"type" : "function",
- "desc" : "",
+ "desc" : "Gets the current X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
- "deprecated" : "This has been deprecated: - use filters",
+ "deprecated" : "",
"since" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The X position of the element"
+ }
+ ]
},
{
- "name" : "cleanWord",
+ "name" : "getXY",
"type" : "function",
- "desc" : "Clean up MS wordisms...",
+ "desc" : "Gets the current position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
- "deprecated" : "This has been deprecated: - use filter directly",
+ "deprecated" : "",
"since" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "The XY position of the element"
+ }
+ ]
},
{
- "name" : "destroy",
+ "name" : "getY",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "desc" : "Gets the current Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The Y position of the element"
+ }
+ ]
},
{
- "name" : "disable",
+ "name" : "hasClass",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Checks if the specified CSS class exists on this element's DOM node.",
+ "sig" : "(className)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "className",
+ "type" : "String",
+ "desc" : "The CSS class to check for",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "True if the class exists, else false"
}
]
},
{
- "name" : "enable",
+ "name" : "hide",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Hide this element - Uses display mode to determine whether to use \"display\" or \"visibility\". See {@link #setVisible}.",
+ "sig" : "(animate)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
+ "type" : "Roo.Element",
"desc" : "this"
}
]
},
{
- "name" : "execCmd",
+ "name" : "initDD",
"type" : "function",
- "desc" : "Executes a Midas editor command directly on the editor document.\nFor visual commands, you should use {@link #relayCmd} instead.\n<b>This should only be called after the editor is initialized.</b>",
- "sig" : "(cmd, value)",
+ "desc" : "Initializes a {@link Roo.dd.DD} drag drop object for this element.",
+ "sig" : "(group, config, overrides)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "cmd",
+ "name" : "group",
"type" : "String",
- "desc" : "The Midas command",
+ "desc" : "The group the DD object is member of",
"isOptional" : false
},
{
- "name" : "value",
- "type" : "String/Boolean",
- "desc" : "(optional) The value to pass to the command (defaults to null)",
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The DD config object",
+ "isOptional" : false
+ },
+ {
+ "name" : "overrides",
+ "type" : "Object",
+ "desc" : "An object containing methods to override/implement on the DD object",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.dd.DD",
+ "desc" : "The DD object"
+ }
+ ]
},
{
- "name" : "fireEvent",
+ "name" : "initDDProxy",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Initializes a {@link Roo.dd.DDProxy} object for this element.",
+ "sig" : "(group, config, overrides)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "group",
"type" : "String",
- "desc" : "",
+ "desc" : "The group the DDProxy object is member of",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The DDProxy config object",
+ "isOptional" : false
+ },
+ {
+ "name" : "overrides",
+ "type" : "Object",
+ "desc" : "An object containing methods to override/implement on the DDProxy object",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "Roo.dd.DDProxy",
+ "desc" : "The DDProxy object"
}
]
},
{
- "name" : "focus",
+ "name" : "initDDTarget",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Initializes a {@link Roo.dd.DDTarget} object for this element.",
+ "sig" : "(group, config, overrides)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "name" : "group",
+ "type" : "String",
+ "desc" : "The group the DDTarget object is member of",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The DDTarget config object",
+ "isOptional" : false
+ },
+ {
+ "name" : "overrides",
+ "type" : "Object",
+ "desc" : "An object containing methods to override/implement on the DDTarget object",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.dd.DDTarget",
+ "desc" : "The DDTarget object"
}
]
},
{
- "name" : "getDocMarkup",
+ "name" : "insertAfter",
"type" : "function",
- "desc" : "Protected method that will not generally be called directly. It\nis called when the editor initializes the iframe with HTML contents. Override this method if you\nwant to change the initialization markup of the iframe (e.g. to add stylesheets).",
- "sig" : "()\n{\n\n}",
+ "desc" : "Inserts this element after the passed element in the DOM",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The element to insert after",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "getEl",
+ "name" : "insertBefore",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Inserts this element before the passed element in the DOM",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The element to insert before",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "The element"
+ "desc" : "this"
}
]
},
{
- "name" : "getId",
+ "name" : "insertFirst",
"type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Inserts (or creates) an element (or DomHelper config) as the first child of the this element",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element/Object",
+ "desc" : "The id or element to insert or a DomHelper config to create and insert",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "The new child"
}
]
},
{
- "name" : "hasListener",
+ "name" : "insertHtml",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Inserts an html fragment into this element",
+ "sig" : "(where, html, returnEl)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "where",
"type" : "String",
- "desc" : "The name of the event to check for",
+ "desc" : "Where to insert the html in relation to the this element - beforeBegin, afterBegin, beforeEnd, afterEnd.",
+ "isOptional" : false
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "The HTML fragment",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnEl",
+ "type" : "Boolean",
+ "desc" : "True to return an Roo.Element",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The inserted node (or nearest related if more than 1 inserted)"
}
]
},
{
- "name" : "hide",
+ "name" : "insertSibling",
"type" : "function",
- "desc" : "Hide this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element",
+ "sig" : "(el, where, returnDom)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element/Object",
+ "desc" : "The id or element to insert or a DomHelper config to create and insert",
+ "isOptional" : false
+ },
+ {
+ "name" : "where",
+ "type" : "String",
+ "desc" : "(optional) 'before' or 'after' defaults to before",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnDom",
+ "type" : "Boolean",
+ "desc" : "(optional) True to return the raw DOM element instead of Roo.Element",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.Element",
+ "desc" : "the inserted Element"
}
]
},
{
- "name" : "insertAtCursor",
+ "name" : "is",
"type" : "function",
- "desc" : "Inserts the passed text at the current cursor position. Note: the editor must be initialized and activated\nto insert tRoo.",
- "sig" : "(text)",
+ "desc" : "Returns true if this element matches the passed simple selector (e.g. div.some-class or span:first-child)",
+ "sig" : "(selector)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "text",
+ "name" : "selector",
"type" : "String",
- "desc" : "| dom node..",
+ "desc" : "The simple selector to test",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if this element matches the selector, else false"
+ }
+ ]
},
{
- "name" : "isVisible",
+ "name" : "isBorderBox",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
+ "desc" : "Tests various css rules/browsers to determine if this element uses a border box",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "on",
+ "name" : "isDisplayed",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Returns true if display is not \"none\"",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "purgeListeners",
+ "name" : "isMasked",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Returns true if this element is masked",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "pushValue",
+ "name" : "isScrollable",
"type" : "function",
- "desc" : "TEXTAREA -> EDITABLE\nProtected method that will not generally be called directly. Pushes the value of the textarea\ninto the iframe editor.",
+ "desc" : "Returns true if this element is scrollable.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "rangeIntersectsNode",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Range intersection.. the hard stuff...\n '-1' = before\n '0' = hits..\n '1' = after.\n [ -- selected range --- ]\n [fail] [fail]\n\n basically..\n if end is before start or hits it. fail.\n if start is after end or hits it fail.\n\n if either hits (but other is outside. - then it's not",
- "sig" : "()\n{\n\n}",
+ "desc" : "Checks whether the element is currently visible using both visibility and display properties.",
+ "sig" : "(deep)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "deep",
+ "type" : "Boolean",
+ "desc" : "(optional) True to walk the dom and see if parent elements are hidden (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the element is currently visible, else false"
+ }
+ ]
},
{
- "name" : "relayCmd",
+ "name" : "load",
"type" : "function",
- "desc" : "Executes a Midas editor command on the editor document and performs necessary focus and\ntoolbar updates. <b>This should only be called after the editor is initialized.</b>",
- "sig" : "(cmd, value)",
+ "desc" : "Direct access to the UpdateManager update() method (takes the same parameters).",
+ "sig" : "(url, params, callback, discardUrl)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "cmd",
- "type" : "String",
- "desc" : "The Midas command",
+ "name" : "url",
+ "type" : "String/Function",
+ "desc" : "The url for this request or a function to call to get the url",
"isOptional" : false
},
{
- "name" : "value",
- "type" : "String/Boolean",
- "desc" : "(optional) The value to pass to the command (defaults to null)",
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The parameters to pass as either a url encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)",
+ "isOptional" : false
+ },
+ {
+ "name" : "discardUrl",
+ "type" : "Boolean",
+ "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used url. If true, it will not store the url.",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "releaseCapture",
+ "name" : "mask",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Puts a mask over this element to disable user interaction. Requires core.css.\nThis method can only be applied to elements which accept child nodes.",
+ "sig" : "(msg, msgCls)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "(optional) A message to display in the mask",
+ "isOptional" : false
+ },
+ {
+ "name" : "msgCls",
+ "type" : "String",
+ "desc" : "(optional) A css class to apply to the msg element - use no-spinner to hide the spinner on bootstrap",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Element",
+ "desc" : "The mask element"
+ }
+ ]
},
{
- "name" : "removeListener",
+ "name" : "move",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Move this element relative to its current position.",
+ "sig" : "(direction, distance, animate)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "direction",
"type" : "String",
- "desc" : "The type of event to listen for",
+ "desc" : "Possible values are: \"l\",\"left\" - \"r\",\"right\" - \"t\",\"top\",\"up\" - \"b\",\"bottom\",\"down\".",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "distance",
+ "type" : "Number",
+ "desc" : "How far to move the element in pixels",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "render",
+ "name" : "moveTo",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
+ "sig" : "(x, y, animate)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "X value for new position (coordinates are page-based)",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "Y value for new position (coordinates are page-based)",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) True for the default animation, or a standard Element animation config object",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "selectNode",
+ "name" : "on",
"type" : "function",
- "desc" : "Select a dom node",
- "sig" : "(node)",
+ "desc" : "Appends an event handler (Shorthand for addListener)",
+ "sig" : "(eventName, fn, scope, options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "DomElement",
- "desc" : "the node to select",
- "isOptional" : false
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to append",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) of the fn",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)An object with standard {@link Roo.EventManager#addListener} options",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "position",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Initializes positioning on this element. If a desired position is not passed, it will make the\nthe element positioned relative IF it is not already positioned.",
+ "sig" : "(pos, zIndex, x, y)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "pos",
+ "type" : "String",
+ "desc" : "(optional) Positioning to use \"relative\", \"absolute\" or \"fixed\"",
+ "isOptional" : false
+ },
+ {
+ "name" : "zIndex",
+ "type" : "Number",
+ "desc" : "(optional) The zIndex to apply",
+ "isOptional" : false
+ },
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "(optional) Set the page X position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "(optional) Set the page Y position",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "query",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Selects child nodes based on the passed CSS selector (the selector should not contain an id).",
+ "sig" : "(selector)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "selector",
+ "type" : "String",
+ "desc" : "The CSS selector",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Array",
+ "desc" : "An array of the matched nodes"
}
]
},
{
- "name" : "show",
+ "name" : "radioClass",
"type" : "function",
- "desc" : "Show this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Adds one or more CSS classes to this element and removes the same class(es) from all siblings.",
+ "sig" : "(className)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "className",
+ "type" : "String/Array",
+ "desc" : "The CSS class to add, or an array of classes",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
+ "type" : "Roo.Element",
"desc" : "this"
}
]
},
{
- "name" : "syncValue",
+ "name" : "remove",
"type" : "function",
- "desc" : "HTML Editor -> Textarea\nProtected method that will not generally be called directly. Syncs the contents\nof the editor iframe with the textarea.",
+ "desc" : "Removes this element from the DOM and deletes it from the cache",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "toggleSourceEdit",
+ "name" : "removeAllListeners",
"type" : "function",
- "desc" : "Toggles the editor between standard and source edit mode.",
- "sig" : "(sourceEdit)",
+ "desc" : "Removes all previous added listeners from this element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "sourceEdit",
- "type" : "Boolean",
- "desc" : "(optional) True for source edit, false for standard",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "un",
+ "name" : "removeClass",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Removes one or more CSS classes from the element.",
+ "sig" : "(className)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "className",
+ "type" : "String/Array",
+ "desc" : "The CSS class to remove, or an array of classes",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.JsonView" : {
- "props" : [
- {
- "name" : "dataName",
- "type" : "String",
- "desc" : "the named area of the template to use as the data area\n Works with domtemplates roo-name=\"name\"",
- "memberOf" : "Roo.View",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "el",
- "type" : "String|Roo.Element",
- "desc" : "The container element.",
- "memberOf" : "Roo.View",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "emptyText",
- "type" : "String",
- "desc" : "The empty text to show when nothing is loaded.",
- "memberOf" : "Roo.View",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "multiSelect",
- "type" : "Boolean",
- "desc" : "Allow multiple selection",
- "memberOf" : "Roo.View",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "selectedClass",
- "type" : "String",
- "desc" : "The css class to add to selected nodes",
- "memberOf" : "Roo.View",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "singleSelect",
- "type" : "Boolean",
- "desc" : "Allow single selection",
- "memberOf" : "Roo.View",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "Data store to load data from.",
- "memberOf" : "Roo.View",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "text",
- "type" : "String",
- "desc" : "to display on mask (default Loading)",
- "memberOf" : "Roo.View",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "tickable",
- "type" : "Boolean",
- "desc" : "- selecting",
- "memberOf" : "Roo.View",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "toggleSelect",
- "type" : "Boolean",
- "desc" : "- selecting",
- "memberOf" : "Roo.View",
- "isOptional" : false,
- "optvals" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "tpl",
- "type" : "String|Roo.Template",
- "desc" : "The template used by this View",
- "memberOf" : "Roo.View",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "beforeclick",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Fires before a click is processed. Returns false to cancel the default action.",
- "sig" : "function (_self, index, node, e)\n{\n\n}",
- "memberOf" : "Roo.View",
+ "desc" : "Removes an event handler from this element",
+ "sig" : "(eventName, fn, scope)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.View",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the target node",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "the type of event to remove",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "HTMLElement",
- "desc" : "The target node",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "the method the event invokes",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The raw event object",
+ "name" : "scope",
+ "type" : "Function",
+ "desc" : "(needed for svg fake listeners)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "beforerender",
+ "name" : "repaint",
"type" : "function",
- "desc" : "Fires before rendering of the downloaded JSON data.",
- "sig" : "function (_self, data)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Forces the browser to repaint this element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.JsonView",
- "desc" : "",
- "isOptional" : false
- },
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "data",
- "type" : "Object",
- "desc" : "The JSON data loaded",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "beforeselect",
+ "name" : "replace",
"type" : "function",
- "desc" : "Fires before a selection is made. If any handlers return false, the selection is cancelled.",
- "sig" : "function (_self, node, selections)\n{\n\n}",
- "memberOf" : "Roo.View",
+ "desc" : "Replaces the passed element with this element",
+ "sig" : "(el)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.View",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "HTMLElement",
- "desc" : "The node to be selected",
- "isOptional" : false
- },
- {
- "name" : "selections",
- "type" : "Array",
- "desc" : "Array of currently selected nodes",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The element to replace",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "click",
+ "name" : "replaceClass",
"type" : "function",
- "desc" : "Fires when a template node is clicked.",
- "sig" : "function (_self, index, node, e)\n{\n\n}",
- "memberOf" : "Roo.View",
+ "desc" : "Replaces a CSS class on the element with another. If the old name does not exist, the new name will simply be added.",
+ "sig" : "(oldClassName, newClassName)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.View",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the target node",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "HTMLElement",
- "desc" : "The target node",
+ "name" : "oldClassName",
+ "type" : "String",
+ "desc" : "The CSS class to replace",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The raw event object",
+ "name" : "newClassName",
+ "type" : "String",
+ "desc" : "The replacement CSS class",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "contextmenu",
+ "name" : "scroll",
"type" : "function",
- "desc" : "Fires when a template node is right clicked.",
- "sig" : "function (_self, index, node, e)\n{\n\n}",
- "memberOf" : "Roo.View",
+ "desc" : "Scrolls this element the specified direction. Does bounds checking to make sure the scroll is\nwithin this element's scrollable range.",
+ "sig" : "(direction, distance, animate)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.View",
- "desc" : "",
+ "name" : "direction",
+ "type" : "String",
+ "desc" : "Possible values are: \"l\",\"left\" - \"r\",\"right\" - \"t\",\"top\",\"up\" - \"b\",\"bottom\",\"down\".",
"isOptional" : false
},
{
- "name" : "index",
+ "name" : "distance",
"type" : "Number",
- "desc" : "The index of the target node",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "HTMLElement",
- "desc" : "The target node",
+ "desc" : "How far to scroll the element in pixels",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The raw event object",
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "Returns true if a scroll was triggered or false if the element\nwas scrolled as far as it could go."
+ }
+ ]
},
{
- "name" : "dblclick",
+ "name" : "scrollIntoView",
"type" : "function",
- "desc" : "Fires when a template node is double clicked.",
- "sig" : "function (_self, index, node, e)\n{\n\n}",
- "memberOf" : "Roo.View",
+ "desc" : "Scrolls this element into view within the passed container.",
+ "sig" : "(container, hscroll)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.View",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the target node",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "HTMLElement",
- "desc" : "The target node",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The container element to scroll (defaults to document.body)",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The raw event object",
+ "name" : "hscroll",
+ "type" : "Boolean",
+ "desc" : "(optional) False to disable horizontal scroll (defaults to true)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "load",
+ "name" : "scrollTo",
"type" : "function",
- "desc" : "Fires when data is loaded.",
- "sig" : "function (_self, data, response)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Scrolls this element the specified scroll point. It does NOT do bounds checking so if you scroll to a weird value it will try to do it. For auto bounds checking, use scroll().",
+ "sig" : "(side, value, animate)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.JsonView",
- "desc" : "",
+ "name" : "side",
+ "type" : "String",
+ "desc" : "Either \"left\" for scrollLeft values or \"top\" for scrollTop values.",
"isOptional" : false
},
{
- "name" : "data",
- "type" : "Object",
- "desc" : "The JSON data loaded",
+ "name" : "value",
+ "type" : "Number",
+ "desc" : "The new scroll value",
"isOptional" : false
},
{
- "name" : "response",
- "type" : "Object",
- "desc" : "The raw Connect response object",
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "loadexception",
- "type" : "function",
- "desc" : "Fires when loading fails.",
- "sig" : "function (_self, response)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.JsonView",
- "desc" : "",
- "isOptional" : false
- },
+ "returns" : [
{
- "name" : "response",
- "type" : "Object",
- "desc" : "The raw Connect response object",
- "isOptional" : false
+ "name" : "",
+ "type" : "Element",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "preparedata",
+ "name" : "select",
"type" : "function",
- "desc" : "Fires on every row to render, to allow you to change the data.",
- "sig" : "function (_self, data)\n{\n\n}",
- "memberOf" : "Roo.View",
+ "desc" : "Creates a {@link Roo.CompositeElement} for child nodes based on the passed CSS selector (the selector should not contain an id).",
+ "sig" : "(selector, unique)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.View",
- "desc" : "",
+ "name" : "selector",
+ "type" : "String",
+ "desc" : "The CSS selector",
"isOptional" : false
},
{
- "name" : "data",
- "type" : "Object",
- "desc" : "to be rendered (change this)",
+ "name" : "unique",
+ "type" : "Boolean",
+ "desc" : "(optional) True to create a unique Roo.Element for each child (defaults to false, which creates a single shared flyweight object)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "CompositeElement/CompositeElementLite",
+ "desc" : "The composite element"
+ }
+ ]
},
{
- "name" : "selectionchange",
+ "name" : "set",
"type" : "function",
- "desc" : "Fires when the selected nodes change.",
- "sig" : "function (_self, selections)\n{\n\n}",
- "memberOf" : "Roo.View",
+ "desc" : "Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function)",
+ "sig" : "(o, useSet)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.View",
- "desc" : "",
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The object with the attributes",
"isOptional" : false
},
{
- "name" : "selections",
- "type" : "Array",
- "desc" : "Array of the selected nodes",
+ "name" : "useSet",
+ "type" : "Boolean",
+ "desc" : "(optional) false to override the default setAttribute to use expandos.",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "methods" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
{
- "name" : "addEvents",
+ "name" : "setBottom",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Sets the element's CSS bottom style.",
+ "sig" : "(bottom)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "bottom",
+ "type" : "String",
+ "desc" : "The bottom CSS property value",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "addListener",
+ "name" : "setBounds",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Sets the element's position and size in one shot. If animation is true then width, height, x and y will be animated concurrently.",
+ "sig" : "(x, y, width, height, animate)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "X value for new position (coordinates are page-based)",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "Y value for new position (coordinates are page-based)",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The new width",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "capture",
+ "name" : "setBox",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Sets the element's box. Use getBox() on another element to get a box obj. If animate is true then width, height, x and y will be animated concurrently.",
+ "sig" : "(box, adjust, animate)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
+ "name" : "box",
+ "type" : "Object",
+ "desc" : "The box to fill {x, y, width, height}",
"isOptional" : false
},
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "adjust",
+ "type" : "Boolean",
+ "desc" : "(optional) Whether to adjust for box-model issues automatically",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "clearFilter",
- "type" : "function",
- "desc" : "Clears the current filter.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "clearSelections",
+ "name" : "setDisplayed",
"type" : "function",
- "desc" : "Clear all selections",
- "sig" : "(suppressEvent)",
+ "desc" : "Sets the CSS display property. Uses originalDisplay if the specified value is a boolean true.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.View",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "suppressEvent",
+ "name" : "value",
"type" : "Boolean",
- "desc" : "(optional) true to skip firing of the selectionchange event",
+ "desc" : "Boolean value to display the element using its default display, or a string to set the display directly",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "filter",
+ "name" : "setHeight",
"type" : "function",
- "desc" : "Filter the data by a specific property.",
- "sig" : "(property, value)",
+ "desc" : "Set the height of the element",
+ "sig" : "(height, animate)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "property",
- "type" : "String",
- "desc" : "A property on your JSON objects",
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height",
"isOptional" : false
},
{
- "name" : "value",
- "type" : "String/RegExp",
- "desc" : "Either string that the property values\nshould start with, or a RegExp to test against the property",
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "filterBy",
+ "name" : "setLeft",
"type" : "function",
- "desc" : "Filter by a function. The passed function will be called with each\nobject in the current dataset. If the function returns true the value is kept,\notherwise it is filtered.",
- "sig" : "(fn, scope)",
+ "desc" : "Sets the element's left position directly using CSS style (instead of {@link #setX}).",
+ "sig" : "(left)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to this JsonView)",
+ "name" : "left",
+ "type" : "String",
+ "desc" : "The left CSS property value",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "findItemFromChild",
+ "name" : "setLeftTop",
"type" : "function",
- "desc" : "Returns the template node the passed child belongs to or null if it doesn't belong to one.",
- "sig" : "(node)",
+ "desc" : "Quick set left and top adding default units",
+ "sig" : "(left, top)",
"static" : false,
- "memberOf" : "Roo.View",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "HTMLElement",
- "desc" : "",
+ "name" : "left",
+ "type" : "String",
+ "desc" : "The left CSS property value",
+ "isOptional" : false
+ },
+ {
+ "name" : "top",
+ "type" : "String",
+ "desc" : "The top CSS property value",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "HTMLElement",
- "desc" : "The template node"
+ "type" : "Roo.Element",
+ "desc" : "this"
}
]
},
{
- "name" : "fireEvent",
+ "name" : "setLocation",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
+ "sig" : "(x, y, animate)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "X value for new position (coordinates are page-based)",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "Y value for new position (coordinates are page-based)",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) True for the default animation, or a standard Element animation config object",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "Roo.Element",
+ "desc" : "this"
}
]
},
{
- "name" : "getCount",
+ "name" : "setOpacity",
"type" : "function",
- "desc" : "Get the number of records in the current JSON dataset",
- "sig" : "()\n{\n\n}",
+ "desc" : "Set the opacity of the element",
+ "sig" : "(opacity, animate)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "opacity",
+ "type" : "Float",
+ "desc" : "The new opacity. 0 = transparent, .5 = 50% visibile, 1 = fully visible, etc",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "this"
}
]
},
{
- "name" : "getEl",
+ "name" : "setPositioning",
"type" : "function",
- "desc" : "Returns the element this view is bound to.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Set positioning with an object returned by getPositioning().",
+ "sig" : "(posCfg)",
"static" : false,
- "memberOf" : "Roo.View",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "posCfg",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
"type" : "Roo.Element",
- "desc" : ""
+ "desc" : "this"
}
]
},
{
- "name" : "getNode",
+ "name" : "setRegion",
"type" : "function",
- "desc" : "Gets a template node.",
- "sig" : "(nodeInfo)",
+ "desc" : "Sets the element's position and size the the specified region. If animation is true then width, height, x and y will be animated concurrently.",
+ "sig" : "(region, animate)",
"static" : false,
- "memberOf" : "Roo.View",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "nodeInfo",
- "type" : "HTMLElement/String/Number",
- "desc" : "An HTMLElement template node, index of a template node or the id of a template node",
+ "name" : "region",
+ "type" : "Roo.lib.Region",
+ "desc" : "The region to fill",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "HTMLElement",
- "desc" : "The node or null if it wasn't found"
+ "type" : "Roo.Element",
+ "desc" : "this"
}
]
},
{
- "name" : "getNodeData",
+ "name" : "setRight",
"type" : "function",
- "desc" : "Returns the JSON object for the specified node(s)",
- "sig" : "(node)",
+ "desc" : "Sets the element's CSS right style.",
+ "sig" : "(right)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "HTMLElement/Array",
- "desc" : "The node or an array of nodes",
+ "name" : "right",
+ "type" : "String",
+ "desc" : "The right CSS property value",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Object/Array",
- "desc" : "If you pass in an array, you get an array back, otherwise\nyou get the JSON object for the node"
+ "type" : "Roo.Element",
+ "desc" : "this"
}
]
},
{
- "name" : "getNodes",
+ "name" : "setSize",
"type" : "function",
- "desc" : "Gets a range template nodes.",
- "sig" : "(startIndex, endIndex)",
+ "desc" : "Set the size of the element. If animation is true, both width an height will be animated concurrently.",
+ "sig" : "(width, height, animate)",
"static" : false,
- "memberOf" : "Roo.View",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "startIndex",
+ "name" : "width",
"type" : "Number",
- "desc" : "",
+ "desc" : "The new width",
"isOptional" : false
},
{
- "name" : "endIndex",
+ "name" : "height",
"type" : "Number",
- "desc" : "",
+ "desc" : "The new height",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Array",
- "desc" : "An array of nodes"
+ "type" : "Roo.Element",
+ "desc" : "this"
}
]
},
{
- "name" : "getSelectedIndexes",
+ "name" : "setStyle",
"type" : "function",
- "desc" : "Get the indexes of the selected nodes.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Wrapper for setting style properties, also takes single object parameter of multiple styles.",
+ "sig" : "(property, value)",
"static" : false,
- "memberOf" : "Roo.View",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Array",
- "desc" : ""
+ "name" : "property",
+ "type" : "String/Object",
+ "desc" : "The style property to be set, or an object of multiple styles.",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "(optional) The value to apply to the given property, or null if an object was passed.",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "getSelectedNodes",
- "type" : "function",
- "desc" : "Get the currently selected nodes.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.View",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ ],
"returns" : [
{
"name" : "",
- "type" : "Array",
- "desc" : "An array of HTMLElements"
+ "type" : "Roo.Element",
+ "desc" : "this"
}
]
},
{
- "name" : "getSelectionCount",
+ "name" : "setTop",
"type" : "function",
- "desc" : "Get the number of selected nodes.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the element's top position directly using CSS style (instead of {@link #setY}).",
+ "sig" : "(top)",
"static" : false,
- "memberOf" : "Roo.View",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "top",
+ "type" : "String",
+ "desc" : "The top CSS property value",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "this"
}
]
},
{
- "name" : "hasListener",
+ "name" : "setVisibilityMode",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Sets the element's visibility mode. When setVisible() is called it\nwill use this to determine whether to set the visibility or the display property.",
+ "sig" : "(visMode)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "visMode",
+ "type" : "",
+ "desc" : "Element.VISIBILITY or Element.DISPLAY",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "Roo.Element",
+ "desc" : "this"
}
]
},
{
- "name" : "indexOf",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Finds the index of the passed node",
- "sig" : "(nodeInfo)",
+ "desc" : "Sets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use\nthe display property to hide the element, otherwise it uses visibility. The default is to hide and show using the visibility property.",
+ "sig" : "(visible, animate)",
"static" : false,
- "memberOf" : "Roo.View",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "nodeInfo",
- "type" : "HTMLElement/String/Number",
- "desc" : "An HTMLElement template node, index of a template node or the id of a template node",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "Whether the element is visible",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) True for the default animation, or a standard Element animation config object",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "The index of the node or -1"
+ "type" : "Roo.Element",
+ "desc" : "this"
}
]
},
{
- "name" : "isSelected",
+ "name" : "setWidth",
"type" : "function",
- "desc" : "Returns true if the passed node is selected",
- "sig" : "(node)",
+ "desc" : "Set the width of the element",
+ "sig" : "(width, animate)",
"static" : false,
- "memberOf" : "Roo.View",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "HTMLElement/Number",
- "desc" : "The node or node index",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The new width",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "this"
}
]
},
{
- "name" : "load",
+ "name" : "setX",
"type" : "function",
- "desc" : "Performs an async HTTP request, and loads the JSON from the response. If <i>params</i> are specified it uses POST, otherwise it uses GET.",
- "sig" : "(url, params, callback, discardUrl)",
+ "desc" : "Sets the X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
+ "sig" : "(The, animate)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "url",
- "type" : "Object/String/Function",
- "desc" : "The URL for this request, or a function to call to get the URL, or a config object containing any of the following options:\n <pre><code>\n view.load({\n url: \"your-url.php\",\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n callback: yourFunction,\n scope: yourObject, //(optional scope)\n discardUrl: false,\n nocache: false,\n text: \"Loading...\",\n timeout: 30,\n scripts: false\n });\n </code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare respectively shorthand for <i>disableCaching</i>, <i>indicatorText</i>, and <i>loadScripts</i> and are used to set their associated property on this UpdateManager instance.",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The parameters to pass, as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)",
+ "name" : "The",
+ "type" : "Number",
+ "desc" : "X position of the element",
"isOptional" : false
},
{
- "name" : "discardUrl",
- "type" : "Boolean",
- "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) True for the default animation, or a standard Element animation config object",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "on",
+ "name" : "setXY",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
+ "sig" : "(pos, animate)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "pos",
+ "type" : "Array",
+ "desc" : "Contains X & Y [x, y] values for new position (coordinates are page-based)",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) True for the default animation, or a standard Element animation config object",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "onBeforeLoad",
- "type" : "function",
- "desc" : "onbeforeLoad - masks the loading area.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.View",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "prepareData",
+ "name" : "setY",
"type" : "function",
- "desc" : "Function to override to reformat the data that is sent to\nthe template for each node.\nDEPRICATED - use the preparedata event handler.",
- "sig" : "(data)",
+ "desc" : "Sets the Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
+ "sig" : "(The, animate)",
"static" : false,
- "memberOf" : "Roo.View",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "data",
- "type" : "Array/Object",
- "desc" : "The raw data (array of colData for a data model bound view or\na JSON object for an UpdateManager bound view).",
+ "name" : "The",
+ "type" : "Number",
+ "desc" : "Y position of the element",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) True for the default animation, or a standard Element animation config object",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "refresh",
+ "name" : "setZIndex",
"type" : "function",
- "desc" : "Refreshes the view.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the z-index of this layer and adjusts any shadow and shim z-indexes. The layer z-index is automatically\nincremented by two more than the value passed in so that it always shows above any shadow or shim (the shadow\nelement, if any, will be assigned z-index + 1, and the shim element, if any, will be assigned the unmodified z-index).",
+ "sig" : "(zindex)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "refreshNode",
- "type" : "function",
- "desc" : "Refresh an individual node.",
- "sig" : "(index)",
- "static" : false,
- "memberOf" : "Roo.View",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "index",
+ "name" : "zindex",
"type" : "Number",
- "desc" : "",
+ "desc" : "The new z-index to set",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "this",
+ "desc" : "The Layer"
+ }
+ ]
},
{
- "name" : "releaseCapture",
+ "name" : "show",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Show this element - Uses display mode to determine whether to use \"display\" or \"visibility\". See {@link #setVisible}.",
+ "sig" : "(animate)",
+ "static" : false,
+ "memberOf" : "Roo.Element",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "removeListener",
+ "name" : "swallowEvent",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Stops the specified event from bubbling and optionally prevents the default action",
+ "sig" : "(eventName, preventDefault)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "(optional) true to prevent the default action too",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "select",
+ "name" : "toggle",
"type" : "function",
- "desc" : "Selects nodes.",
- "sig" : "(nodeInfo, keepExisting, suppressEvent)",
+ "desc" : "Toggles the element's visibility or display, depending on visibility mode.",
+ "sig" : "(animate)",
"static" : false,
- "memberOf" : "Roo.View",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "nodeInfo",
- "type" : "Array/HTMLElement/String/Number",
- "desc" : "An HTMLElement template node, index of a template node, id of a template node or an array of any of those to select",
- "isOptional" : false
- },
- {
- "name" : "keepExisting",
- "type" : "Boolean",
- "desc" : "(optional) true to keep existing selections",
- "isOptional" : false
- },
- {
- "name" : "suppressEvent",
- "type" : "Boolean",
- "desc" : "(optional) true to skip firing of the selectionchange vent",
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) True for the default animation, or a standard Element animation config object",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "setStore",
+ "name" : "toggleClass",
"type" : "function",
- "desc" : "Changes the data store this view uses and refresh the view.",
- "sig" : "(store)",
+ "desc" : "Toggles the specified CSS class on this element (removes it if it already exists, otherwise adds it).",
+ "sig" : "(className)",
"static" : false,
- "memberOf" : "Roo.View",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "store",
- "type" : "Store",
- "desc" : "",
+ "name" : "className",
+ "type" : "String",
+ "desc" : "The CSS class to toggle",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "sort",
+ "name" : "translatePoints",
"type" : "function",
- "desc" : "Sorts the data for this view and refreshes it.",
- "sig" : "(property, direction, sortType)",
+ "desc" : "Translates the passed page coordinates into left/top css values for this element",
+ "sig" : "(x, y)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "property",
- "type" : "String",
- "desc" : "A property on your JSON objects to sort on",
- "isOptional" : false
- },
- {
- "name" : "direction",
- "type" : "String",
- "desc" : "(optional) \"desc\" or \"asc\" (defaults to \"asc\")",
+ "name" : "x",
+ "type" : "Number/Array",
+ "desc" : "The page x or an array containing [x, y]",
"isOptional" : false
},
{
- "name" : "sortType",
- "type" : "Function",
- "desc" : "(optional) A function to call to convert the data to a sortable value.",
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The page y",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "An object with left and top properties. e.g. {left: (value), top: (value)}"
+ }
+ ]
},
{
"name" : "un",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Removes an event handler from this element (shorthand for removeListener)",
+ "sig" : "(eventName, fn)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The type of event to listen for",
+ "desc" : "the type of event to remove",
"isOptional" : false
},
{
- "name" : "handler",
+ "name" : "fn",
"type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "the method the event invokes",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "unselect",
+ "name" : "unclip",
"type" : "function",
- "desc" : "Unselects nodes.",
- "sig" : "(nodeInfo, keepExisting, suppressEvent)",
+ "desc" : "Return clipping (overflow) to original clipping before clip() was called",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.View",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "nodeInfo",
- "type" : "Array/HTMLElement/String/Number",
- "desc" : "An HTMLElement template node, index of a template node, id of a template node or an array of any of those to select",
- "isOptional" : false
- },
- {
- "name" : "keepExisting",
- "type" : "Boolean",
- "desc" : "(optional) true IGNORED (for campatibility with select)",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "suppressEvent",
- "type" : "Boolean",
- "desc" : "(optional) true to skip firing of the selectionchange vent",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
}
- ],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.KeyMap" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ ]
+ },
{
- "name" : "addBinding",
+ "name" : "unmask",
"type" : "function",
- "desc" : "Add a new binding to this KeyMap. The following config object properties are supported:\n<pre>\nProperty Type Description\n---------- --------------- ----------------------------------------------------------------------\nkey String/Array A single keycode or an array of keycodes to handle\nshift Boolean True to handle key only when shift is pressed (defaults to false)\nctrl Boolean True to handle key only when ctrl is pressed (defaults to false)\nalt Boolean True to handle key only when alt is pressed (defaults to false)\nfn Function The function to call when KeyMap finds the expected key combination\nscope Object The scope of the callback function\n</pre>\n\nUsage:\n<pre><code>\n// Create a KeyMap\nvar map = new Roo.KeyMap(document, {\n key: Roo.EventObject.ENTER,\n fn: handleKey,\n scope: this\n});\n\n//Add a new binding to the existing KeyMap later\nmap.addBinding({\n key: 'abc',\n shift: true,\n fn: handleKey,\n scope: this\n});\n</code></pre>",
- "sig" : "(config)",
+ "desc" : "Removes a previously applied mask. If removeEl is true the mask overlay is destroyed, otherwise\nit is cached for reuse.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "config",
- "type" : "Object/Array",
- "desc" : "A single KeyMap config or an array of configs",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "unselectable",
"type" : "function",
- "desc" : "Disable this KeyMap",
+ "desc" : "Disables text selection for this element (normalized across browsers)",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "enable",
+ "name" : "up",
"type" : "function",
- "desc" : "Enables this KeyMap",
- "sig" : "()\n{\n\n}",
+ "desc" : "Walks up the dom looking for a parent node that matches the passed simple selector (e.g. div.some-class or span:first-child).\nThis is a shortcut for findParentNode() that always returns an Roo.Element.",
+ "sig" : "(selector, maxDepth)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "selector",
+ "type" : "String",
+ "desc" : "The simple selector to test",
+ "isOptional" : false
+ },
+ {
+ "name" : "maxDepth",
+ "type" : "Number/String/HTMLElement/Element",
+ "desc" : "(optional) The max depth to\n search as a number or element (defaults to 10 || document.body)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "The matching DOM node (or null if no match was found)"
+ }
+ ]
},
{
- "name" : "isEnabled",
+ "name" : "update",
"type" : "function",
- "desc" : "Returns true if this KeyMap is enabled",
- "sig" : "()\n{\n\n}",
+ "desc" : "Update the innerHTML of this element, optionally searching for and processing scripts",
+ "sig" : "(html, loadScripts, callback)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "The new HTML",
+ "isOptional" : false
+ },
+ {
+ "name" : "loadScripts",
+ "type" : "Boolean",
+ "desc" : "(optional) true to look for and process scripts",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "For async script loading you can be noticed when the update completes",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "this"
}
]
},
{
- "name" : "on",
+ "name" : "wrap",
"type" : "function",
- "desc" : "Shorthand for adding a single key listener",
- "sig" : "(key, fn, scope)",
+ "desc" : "Creates and wraps this element with another element",
+ "sig" : "(config, returnDom)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Element",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "key",
- "type" : "Number/Array/Object",
- "desc" : "Either the numeric key code, array of key codes or an object with the\nfollowing options:\n{key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "(optional) DomHelper element config object for the wrapper element or null for an empty div",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the function",
+ "name" : "returnDom",
+ "type" : "Boolean",
+ "desc" : "(optional) True to return the raw DOM element instead of Roo.Element",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement/Element",
+ "desc" : "The newly created wrapper element"
+ }
+ ]
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.KeyNav" : {
+ "Roo.LayoutDialog" : {
"props" : [
{
- "name" : "defaultEventAction",
- "type" : "String",
- "desc" : "The method to call on the {@link Roo.EventObject} after this KeyNav intercepts a key. Valid values are\n{@link Roo.EventObject#stopEvent}, {@link Roo.EventObject#preventDefault} and\n{@link Roo.EventObject#stopPropagation} (defaults to 'stopEvent')",
- "memberOf" : "",
+ "name" : "animateTarget",
+ "type" : "String/Element",
+ "desc" : "Id or element from which the dialog should animate while opening\n(defaults to null with no animation)",
+ "memberOf" : "Roo.BasicDialog",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disabled",
+ "name" : "autoCreate",
+ "type" : "Boolean/DomHelper",
+ "desc" : "True to auto create from scratch, or using a DomHelper Object (defaults to false)",
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoScroll",
"type" : "Boolean",
- "desc" : "True to disable this KeyNav instance (defaults to false)",
- "memberOf" : "",
+ "desc" : "True to allow the dialog body contents to overflow and display scrollbars (defaults to false)",
+ "memberOf" : "Roo.BasicDialog",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "forceKeyDown",
+ "name" : "autoTabs",
"type" : "Boolean",
- "desc" : "Handle the keydown event instead of keypress (defaults to false). KeyNav automatically does this for IE since\nIE does not propagate special keys on keypress, but setting this to true will force other browsers to also\nhandle keydown instead of keypress.",
- "memberOf" : "",
+ "desc" : "If true, all elements with class 'x-dlg-tab' will get automatically converted to tabs (defaults to false)",
+ "memberOf" : "Roo.BasicDialog",
"isOptional" : false,
"optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this KeyNav",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
+ "name" : "buttonAlign",
+ "type" : "String",
+ "desc" : "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"right\")",
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "enable",
- "type" : "function",
- "desc" : "Enable this KeyNav",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "name" : "buttons",
+ "type" : "Array",
+ "desc" : "Array of buttons",
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "buttons[]",
+ "type" : "Roo.Button",
+ "desc" : "Bottom buttons..",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.Layer" : {
- "props" : [
+ "isOptional" : false,
+ "optvals" : []
+ },
{
- "name" : "cls",
- "type" : "String",
- "desc" : "CSS class to add to the element",
+ "name" : "center",
+ "type" : "Roo.layout.Region",
+ "desc" : "",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "constrain",
+ "name" : "closable",
"type" : "Boolean",
- "desc" : "False to disable constrain to viewport (defaults to true)",
+ "desc" : "False to remove the built-in top-right corner close button (defaults to true)",
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "collapsible",
+ "type" : "Boolean",
+ "desc" : "False to remove the built-in top-right corner collapse button (defaults to true)",
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "constraintoviewport",
+ "type" : "Boolean",
+ "desc" : "True to keep the dialog constrained within the visible viewport boundaries (defaults to true)",
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "draggable",
+ "type" : "Boolean",
+ "desc" : "False to disable dragging of the dialog within the viewport (defaults to true)",
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "east",
+ "type" : "Roo.layout.Region",
+ "desc" : "",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "dh",
+ "name" : "fixedcenter",
+ "type" : "Boolean",
+ "desc" : "True to ensure that anytime the dialog is shown or resized it gets centered (defaults to false)",
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "Height of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.",
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listeners",
"type" : "Object",
- "desc" : "DomHelper object config to create element with (defaults to {tag: \"div\", cls: \"x-layer\"}).",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minButtonWidth",
+ "type" : "Number",
+ "desc" : "Minimum width of all dialog buttons (defaults to 75)",
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minHeight",
+ "type" : "Number",
+ "desc" : "The minimum allowable height for a resizable dialog (defaults to 80)",
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minWidth",
+ "type" : "Number",
+ "desc" : "The minimum allowable width for a resizable dialog (defaults to 200)",
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "modal",
+ "type" : "Boolean",
+ "desc" : "True to show the dialog modally, preventing user interaction with the rest of the page (defaults to false)",
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "north",
+ "type" : "Roo.layout.Region",
+ "desc" : "",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "proxyDrag",
+ "type" : "Boolean",
+ "desc" : "True to drag a lightweight proxy element rather than the dialog itself, used when\ndraggable = true (defaults to false)",
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "resizable",
+ "type" : "Boolean",
+ "desc" : "False to disable manual dialog resizing (defaults to true)",
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "resizeHandles",
+ "type" : "String",
+ "desc" : "Which resize handles to display - see the {@link Roo.Resizable} handles config\nproperty for valid values (defaults to 'all')",
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "shadow",
- "type" : "String/Boolean",
- "desc" : "True to create a shadow element with default class \"x-layer-shadow\", or\nyou can pass a string with a CSS class name. False turns off the shadow.",
- "memberOf" : "",
+ "type" : "Boolean/String",
+ "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right\nshadow (defaults to false)",
+ "memberOf" : "Roo.BasicDialog",
"isOptional" : false,
"optvals" : []
},
{
"name" : "shadowOffset",
"type" : "Number",
- "desc" : "Number of pixels to offset the shadow (defaults to 3)",
- "memberOf" : "",
+ "desc" : "The number of pixels to offset the shadow if displayed (defaults to 5)",
+ "memberOf" : "Roo.BasicDialog",
"isOptional" : false,
"optvals" : []
},
{
"name" : "shim",
"type" : "Boolean",
- "desc" : "False to disable the iframe shim in browsers which need one (defaults to true)",
+ "desc" : "True to create an iframe shim that prevents selects from showing through (defaults to false)",
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "south",
+ "type" : "Roo.layout.Region",
+ "desc" : "",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "zindex",
- "type" : "Number",
- "desc" : "Starting z-index (defaults to 11000)",
+ "name" : "syncHeightBeforeShow",
+ "type" : "Boolean",
+ "desc" : "True to cause the dimensions to be recalculated before the dialog is shown (defaults to false)",
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tabTag",
+ "type" : "String",
+ "desc" : "The tag name of tab elements, used when autoTabs = true (defaults to 'div')",
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "Default text to display in the title bar (defaults to null)",
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "west",
+ "type" : "Roo.layout.Region",
+ "desc" : "",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "Width of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.",
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The default left page coordinate of the dialog (defaults to center screen)",
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The default top page coordinate of the dialog (defaults to center screen)",
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
}
],
- "events" : [],
- "methods" : [
+ "events" : [
{
- "name" : "addClass",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out.",
- "sig" : "(className)",
- "static" : false,
- "memberOf" : "Roo.Element",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before this dialog is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.BasicDialog",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "className",
- "type" : "String/Array",
- "desc" : "The CSS class to add, or an array of classes",
+ "name" : "this",
+ "type" : "Roo.BasicDialog",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "addClassOnClick",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Sets up event handlers to add and remove a css class when the mouse is down and then up on this element (a click effect)",
- "sig" : "(className)",
- "static" : false,
- "memberOf" : "Roo.Element",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before this dialog is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.BasicDialog",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "className",
- "type" : "String",
+ "name" : "this",
+ "type" : "Roo.BasicDialog",
"desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "addClassOnFocus",
+ "name" : "hide",
"type" : "function",
- "desc" : "Sets up event handlers to add and remove a css class when this element has the focus",
- "sig" : "(className)",
- "static" : false,
- "memberOf" : "Roo.Element",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when this dialog is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.BasicDialog",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "className",
- "type" : "String",
+ "name" : "this",
+ "type" : "Roo.BasicDialog",
"desc" : "",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "keydown",
+ "type" : "function",
+ "desc" : "Fires when a key is pressed",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.BasicDialog",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "name" : "this",
+ "type" : "Roo.BasicDialog",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "addClassOnOver",
+ "name" : "move",
"type" : "function",
- "desc" : "Sets up event handlers to add and remove a css class when the mouse is over this element",
- "sig" : "(className, preventFlicker)",
- "static" : false,
- "memberOf" : "Roo.Element",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when this dialog is moved by the user.",
+ "sig" : "function (_self, x, y)\n{\n\n}",
+ "memberOf" : "Roo.BasicDialog",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "className",
- "type" : "String",
+ "name" : "this",
+ "type" : "Roo.BasicDialog",
"desc" : "",
"isOptional" : false
},
{
- "name" : "preventFlicker",
- "type" : "Boolean",
- "desc" : "(optional) If set to true, it prevents flickering by filtering\nmouseout events for children elements",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new page X",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new page Y",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "resize",
+ "type" : "function",
+ "desc" : "Fires when this dialog is resized by the user.",
+ "sig" : "function (_self, width, height)\n{\n\n}",
+ "memberOf" : "Roo.BasicDialog",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "name" : "this",
+ "type" : "Roo.BasicDialog",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The new width",
+ "isOptional" : false
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "addKeyListener",
+ "name" : "show",
"type" : "function",
- "desc" : "Convenience method for constructing a KeyMap",
- "sig" : "(key, fn, scope)",
+ "desc" : "Fires when this dialog is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.BasicDialog",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.BasicDialog",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addButton",
+ "type" : "function",
+ "desc" : "Adds a button to the footer section of the dialog.",
+ "sig" : "(config, handler, scope)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.BasicDialog",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "key",
- "type" : "Number/Array/Object/String",
- "desc" : "Either a string with the keys to listen for, the numeric key code, array of key codes or an object with the following options:\n {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}",
+ "name" : "config",
+ "type" : "String/Object",
+ "desc" : "A string becomes the button text, an object can either be a Button config\nobject or a valid Roo.DomHelper element config",
"isOptional" : false
},
{
- "name" : "fn",
+ "name" : "handler",
"type" : "Function",
- "desc" : "The function to call",
+ "desc" : "The function called when the button is clicked",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope of the function",
+ "desc" : "(optional) The scope of the handler function (accepts position as a property)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.KeyMap",
- "desc" : "The KeyMap created"
+ "type" : "Roo.Button",
+ "desc" : "The new button"
}
]
},
{
- "name" : "addKeyMap",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Creates a KeyMap for this element",
- "sig" : "(config)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "config",
+ "name" : "object",
"type" : "Object",
- "desc" : "The KeyMap config. See {@link Roo.KeyMap} for more details",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "addKeyListener",
+ "type" : "function",
+ "desc" : "Adds a key listener for when this dialog is displayed. This allows you to hook in a function that will be\nexecuted in response to a particular key being pressed while the dialog is active.",
+ "sig" : "(key, fn, scope)",
+ "static" : false,
+ "memberOf" : "Roo.BasicDialog",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "key",
+ "type" : "Number/Array/Object",
+ "desc" : "Either the numeric key code, array of key codes or an object with the following options:\n {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the function",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.KeyMap",
- "desc" : "The KeyMap created"
+ "type" : "Roo.BasicDialog",
+ "desc" : "this"
}
]
},
{
"name" : "addListener",
"type" : "function",
- "desc" : "Appends an event handler",
- "sig" : "(eventName, fn, scope, options)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The type of event to append",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "fn",
+ "name" : "handler",
"type" : "Function",
"desc" : "The method the event invokes",
"isOptional" : false
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) of the fn",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
},
{
"name" : "options",
"type" : "Object",
- "desc" : "(optional)An object with standard {@link Roo.EventManager#addListener} options",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "addxtype",
+ "type" : "function",
+ "desc" : "Add an xtype element (actually adds to the layout.)",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "xdata xtype object data."
+ }
+ ]
+ },
{
"name" : "alignTo",
"type" : "function",
- "desc" : "Aligns this element with another element relative to the specified anchor points. If the other element is the\ndocument it aligns it to the viewport.\nThe position parameter is optional, and can be specified in any one of the following formats:\n<ul>\n <li><b>Blank</b>: Defaults to aligning the element's top-left corner to the target's bottom-left corner (\"tl-bl\").</li>\n <li><b>One anchor (deprecated)</b>: The passed anchor position is used as the target element's anchor point.\n The element being aligned will position its top-left corner (tl) to that point. <i>This method has been\n deprecated in favor of the newer two anchor syntax below</i>.</li>\n <li><b>Two anchors</b>: If two values from the table below are passed separated by a dash, the first value is used as the\n element's anchor point, and the second value is used as the target's anchor point.</li>\n</ul>\nIn addition to the anchor points, the position parameter also supports the \"?\" character. If \"?\" is passed at the end of\nthe position string, the element will attempt to align as specified, but the position will be adjusted to constrain to\nthe viewport if necessary. Note that the element being aligned might be swapped to align to a different position than\nthat specified in order to enforce the viewport constraints.\nFollowing are all of the supported anchor positions:\n <pre>\n Value Description\n ----- -----------------------------\n tl The top left corner (default)\n t The center of the top edge\n tr The top right corner\n l The center of the left edge\n c In the center of the element\n r The center of the right edge\n bl The bottom left corner\n b The center of the bottom edge\n br The bottom right corner\n </pre>\n Example Usage:\n <pre><code>\n // align el to other-el using the default positioning (\"tl-bl\", non-constrained)\n el.alignTo(\"other-el\");\n\n // align the top left corner of el with the top right corner of other-el (constrained to viewport)\n el.alignTo(\"other-el\", \"tr?\");\n\n // align the bottom right corner of el with the center left edge of other-el\n el.alignTo(\"other-el\", \"br-l?\");\n\n // align the center of el with the bottom left corner of other-el and\n // adjust the x position by -6 pixels (and the y position by 0)\n el.alignTo(\"other-el\", \"c-bl\", [-6, 0]);\n </code></pre>",
- "sig" : "(element, position, offsets, animate)",
+ "desc" : "Aligns the dialog to the specified element",
+ "sig" : "(element, position, offsets)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.BasicDialog",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "position",
"type" : "String",
- "desc" : "The position to align to.",
+ "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details).",
"isOptional" : false
},
{
"type" : "Array",
"desc" : "(optional) Offset the positioning by [x, y]",
"isOptional" : false
- },
- {
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) true for the default animation or a standard Element animation config object",
- "isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
+ "type" : "Roo.BasicDialog",
"desc" : "this"
}
]
"name" : "anchorTo",
"type" : "function",
"desc" : "Anchors an element to another element and realigns it when the window is resized.",
- "sig" : "(element, position, offsets, animate, monitorScroll, callback)",
+ "sig" : "(element, position, offsets, monitorScroll)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.BasicDialog",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "position",
"type" : "String",
- "desc" : "The position to align to.",
+ "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details)",
"isOptional" : false
},
{
"desc" : "(optional) Offset the positioning by [x, y]",
"isOptional" : false
},
- {
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) True for the default animation or a standard Element animation config object",
- "isOptional" : false
- },
{
"name" : "monitorScroll",
"type" : "Boolean/Number",
- "desc" : "(optional) True to monitor body scroll and reposition. If this parameter\nis a number, it is used as the buffer delay (defaults to 50ms).",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "The function to call after the animation finishes",
+ "desc" : "(optional) true to monitor body scroll and reposition. If this parameter\nis a number, it is used as the buffer delay (defaults to 50ms).",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
+ "type" : "Roo.BasicDialog",
"desc" : "this"
}
]
},
{
- "name" : "animate",
+ "name" : "beginUpdate",
"type" : "function",
- "desc" : "Perform animation on this element.",
- "sig" : "(args, duration, onComplete, easing, animType)",
+ "desc" : "Begins an update of the layout <strike>and sets display to block and visibility to hidden</strike>. Use standard beginUpdate/endUpdate on the layout.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
+ "deprecated" : "This has been deprecated: ",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "capture",
+ "type" : "function",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"requires" : "",
"params" : [
{
- "name" : "args",
- "type" : "Object",
- "desc" : "The YUI animation control args",
- "isOptional" : false
- },
- {
- "name" : "duration",
- "type" : "Float",
- "desc" : "(optional) How long the animation lasts in seconds (defaults to .35)",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "onComplete",
+ "name" : "fn",
"type" : "Function",
- "desc" : "(optional) Function to call when animation completes",
- "isOptional" : false
- },
- {
- "name" : "easing",
- "type" : "String",
- "desc" : "(optional) Easing method to use (defaults to 'easeOut')",
+ "desc" : "The function to call",
"isOptional" : false
},
{
- "name" : "animType",
- "type" : "String",
- "desc" : "(optional) 'run' is the default. Can also be 'color', 'motion', or 'scroll'",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "appendChild",
+ "name" : "center",
"type" : "function",
- "desc" : "Appends the passed element(s) to this element",
- "sig" : "(el)",
+ "desc" : "Centers this dialog in the viewport",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.BasicDialog",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement/Array/Element/CompositeElement",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
+ "type" : "Roo.BasicDialog",
"desc" : "this"
}
]
},
{
- "name" : "appendTo",
+ "name" : "collapse",
"type" : "function",
- "desc" : "Appends this element to the passed element",
- "sig" : "(el)",
+ "desc" : "Collapses the dialog to its minimized state (only the title bar is visible).\nEquivalent to the user clicking the collapse dialog button.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.BasicDialog",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The new parent element",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "applyStyles",
+ "name" : "destroy",
"type" : "function",
- "desc" : "More flexible version of {@link #setStyle} for setting style properties.",
- "sig" : "(styles)",
+ "desc" : "Destroys this dialog and all its supporting elements (including any tabs, shim,\nshadow, proxy, mask, etc.) Also removes all event listeners.",
+ "sig" : "(removeEl)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.BasicDialog",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "styles",
- "type" : "String/Object/Function",
- "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
+ "name" : "removeEl",
+ "type" : "Boolean",
+ "desc" : "(optional) true to remove the element from the DOM",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "attr",
+ "name" : "endUpdate",
"type" : "function",
- "desc" : "Sets or Returns the value the dom attribute value",
- "sig" : "(name, value)",
+ "desc" : "Ends update of the layout <strike>and resets display to none</strike>. Use standard beginUpdate/endUpdate on the layout.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "This has been deprecated: ",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expands a collapsed dialog back to its normal state. Equivalent to the user\nclicking the expand dialog button.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.BasicDialog",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "name",
- "type" : "String|Object",
- "desc" : "The attribute name (or object to set multiple attributes)",
- "isOptional" : false
- },
- {
- "name" : "value",
- "type" : "String",
- "desc" : "(optional) The value to set the attribute to",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "The attribute value"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "autoHeight",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Measures the element's content height and updates height to match. Note: this function uses setTimeout so\nthe new height may not be available immediately.",
- "sig" : "(animate, duration, onComplete, easing)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "animate",
- "type" : "Boolean",
- "desc" : "(optional) Animate the transition (defaults to false)",
- "isOptional" : false
- },
- {
- "name" : "duration",
- "type" : "Float",
- "desc" : "(optional) Length of the animation in seconds (defaults to .35)",
- "isOptional" : false
- },
- {
- "name" : "onComplete",
- "type" : "Function",
- "desc" : "(optional) Function to call when animation completes",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "easing",
- "type" : "String",
- "desc" : "(optional) Easing method to use (defaults to easeOut)",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "beginMeasure",
+ "name" : "focus",
"type" : "function",
- "desc" : "Temporarily enables offsets (width,height,x,y) for an element with display:none, use endMeasure() when done.",
+ "desc" : "Focuses the dialog. If a defaultButton is set, it will receive focus, otherwise the\ndialog itself will receive focus.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.BasicDialog",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "blur",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Tries to blur the element. Any exceptions are caught and ignored.",
+ "desc" : "Returns the element for this dialog",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.BasicDialog",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "this"
+ "desc" : "The underlying dialog Element"
}
]
},
{
- "name" : "boxWrap",
+ "name" : "getLayout",
"type" : "function",
- "desc" : "Wraps the specified element with a special markup/CSS block that renders by default as a gray container with a\ngradient background, rounded corners and a 4-way shadow.",
- "sig" : "(class)",
+ "desc" : "Get the BorderLayout for this dialog",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "class",
- "type" : "String",
- "desc" : "(optional) A base CSS class to apply to the containing wrapper element (defaults to 'x-box').\nNote that there are a number of CSS rules that are dependent on this name to make the overall effect work,\nso if you supply an alternate base class, make sure you also supply all of the necessary rules.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "type" : "Roo.layout.Border",
+ "desc" : ""
}
]
},
{
- "name" : "center",
+ "name" : "getTabs",
"type" : "function",
- "desc" : "Centers the Element in either the viewport, or another Element.",
- "sig" : "(centerIn)",
+ "desc" : "Returns the panel.Tab component (creates it if it doesn't exist).\nNote: If you wish to simply check for the existence of tabs without creating them,\ncheck for a null 'tabs' property.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.BasicDialog",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "centerIn",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "(optional) The element in which to center the element.",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.panel.Tab",
+ "desc" : "The tabs component"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "child",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Selects a single child at any depth below this element based on the passed CSS selector (the selector should not contain an id).",
- "sig" : "(selector, returnDom)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "selector",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The CSS selector",
- "isOptional" : false
- },
- {
- "name" : "returnDom",
- "type" : "Boolean",
- "desc" : "(optional) True to return the DOM node instead of Roo.Element (defaults to false)",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The child Roo.Element (or DOM node if returnDom = true)"
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "clean",
+ "name" : "hide",
"type" : "function",
- "desc" : "Removes worthless text nodes",
- "sig" : "(forceReclean)",
+ "desc" : "Hides the dialog.",
+ "sig" : "(callback)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.BasicDialog",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "forceReclean",
- "type" : "Boolean",
- "desc" : "(optional) By default the element\nkeeps track if it has been cleaned already so\nyou can call this over and over. However, if you update the element and\nneed to force a reclean, you can pass true.",
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "(optional) Function to call when the dialog is hidden",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "clearOpacity",
- "type" : "function",
- "desc" : "Clears any opacity settings from this element. Required in some cases for IE.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Element",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
+ "type" : "Roo.BasicDialog",
"desc" : "this"
}
]
},
{
- "name" : "clearPositioning",
+ "name" : "initTabs",
"type" : "function",
- "desc" : "Clear positioning back to the default when the document was loaded",
- "sig" : "(value)",
+ "desc" : "Reinitializes the tabs component, clearing out old tabs and finding new ones.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.BasicDialog",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "String",
- "desc" : "(optional) The value to use for the left,right,top,bottom, defaults to '' (empty string). You could use 'auto'.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "type" : "Roo.panel.Tab",
+ "desc" : "The tabs component"
}
]
},
{
- "name" : "clip",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Store the current overflow setting and clip overflow on the element - use {@link #unclip} to remove",
+ "desc" : "Returns true if the dialog is visible",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.BasicDialog",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : ""
}
]
},
{
- "name" : "contains",
+ "name" : "moveTo",
"type" : "function",
- "desc" : "Returns true if this element is an ancestor of the passed element",
- "sig" : "(el)",
+ "desc" : "Moves the dialog's top-left corner to the specified point",
+ "sig" : "(x, y)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.BasicDialog",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "HTMLElement/String",
- "desc" : "The element to check",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if this element is an ancestor of el, else false"
+ "type" : "Roo.BasicDialog",
+ "desc" : "this"
}
]
},
{
- "name" : "createChild",
+ "name" : "on",
"type" : "function",
- "desc" : "Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child element.",
- "sig" : "(config, insertBefore, returnDom)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "config",
- "type" : "Object",
- "desc" : "DomHelper element config object. If no tag is specified (e.g., {tag:'input'}) then a div will be\nautomatically generated with the specified attributes.",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "insertBefore",
- "type" : "HTMLElement",
- "desc" : "(optional) a child element of this element",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "returnDom",
- "type" : "Boolean",
- "desc" : "(optional) true to return the dom node instead of creating an Element",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The new child element"
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "createProxy",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Creates a proxy element of this element",
- "sig" : "(config, renderTo, matchBox)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "config",
- "type" : "String/Object",
- "desc" : "The class name of the proxy element or a DomHelper config object",
- "isOptional" : false
- },
- {
- "name" : "renderTo",
- "type" : "String/HTMLElement",
- "desc" : "(optional) The element or element id to render the proxy to (defaults to document.body)",
- "isOptional" : false
- },
- {
- "name" : "matchBox",
- "type" : "Boolean",
- "desc" : "(optional) True to align and size the proxy to this element now (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The new proxy element"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "createShim",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Creates an iframe shim for this element to keep selects and other windowed objects from\nshowing through.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Element",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The new shim element"
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "down",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Selects a single *direct* child based on the passed CSS selector (the selector should not contain an id).",
- "sig" : "(selector, returnDom)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "selector",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The CSS selector",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "returnDom",
- "type" : "Boolean",
- "desc" : "(optional) True to return the DOM node instead of Roo.Element (defaults to false)",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The child Roo.Element (or DOM node if returnDom = true)"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "enableDisplayMode",
+ "name" : "resizeTo",
"type" : "function",
- "desc" : "Convenience method for setVisibilityMode(Element.DISPLAY)",
- "sig" : "(display)",
+ "desc" : "Resizes the dialog.",
+ "sig" : "(width, height)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.BasicDialog",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "display",
- "type" : "String",
- "desc" : "(optional) What to set display to when visible",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
+ "type" : "Roo.BasicDialog",
"desc" : "this"
}
]
},
{
- "name" : "endMeasure",
+ "name" : "restoreState",
"type" : "function",
- "desc" : "Restores displays to before beginMeasure was called",
+ "desc" : "Restores the previous state of the dialog if Roo.state is configured.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.BasicDialog",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
+ "type" : "Roo.BasicDialog",
"desc" : "this"
}
]
},
{
- "name" : "findParent",
+ "name" : "setContentSize",
"type" : "function",
- "desc" : "Looks at this node and then at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)",
- "sig" : "(selector, maxDepth, returnEl)",
+ "desc" : "Resizes the dialog to fit the specified content size.",
+ "sig" : "(width, height)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.BasicDialog",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "selector",
- "type" : "String",
- "desc" : "The simple selector to test",
- "isOptional" : false
- },
- {
- "name" : "maxDepth",
- "type" : "Number/String/HTMLElement/Element",
- "desc" : "(optional) The max depth to\n search as a number or element (defaults to 10 || document.body)",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "returnEl",
- "type" : "Boolean",
- "desc" : "(optional) True to return a Roo.Element object instead of DOM node",
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "HTMLElement",
- "desc" : "The matching DOM node (or null if no match was found)"
+ "type" : "Roo.BasicDialog",
+ "desc" : "this"
}
]
},
{
- "name" : "findParentNode",
+ "name" : "setDefaultButton",
"type" : "function",
- "desc" : "Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)",
- "sig" : "(selector, maxDepth, returnEl)",
+ "desc" : "Sets the default button to be focused when the dialog is displayed.",
+ "sig" : "(btn)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.BasicDialog",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "selector",
- "type" : "String",
- "desc" : "The simple selector to test",
- "isOptional" : false
- },
- {
- "name" : "maxDepth",
- "type" : "Number/String/HTMLElement/Element",
- "desc" : "(optional) The max depth to\n search as a number or element (defaults to 10 || document.body)",
- "isOptional" : false
- },
- {
- "name" : "returnEl",
- "type" : "Boolean",
- "desc" : "(optional) True to return a Roo.Element object instead of DOM node",
+ "name" : "btn",
+ "type" : "Roo.BasicDialog.Button",
+ "desc" : "The button object returned by {@link #addButton}",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "HTMLElement",
- "desc" : "The matching DOM node (or null if no match was found)"
+ "type" : "Roo.BasicDialog",
+ "desc" : "this"
}
]
},
{
- "name" : "findScrollableParent",
- "type" : "function",
- "desc" : "Looks at the scrollable parent element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Element",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "fitToParent",
+ "name" : "setTitle",
"type" : "function",
- "desc" : "Sizes this element to its parent element's dimensions performing\nneccessary box adjustments.",
- "sig" : "(monitorResize, targetParent)",
+ "desc" : "Sets the dialog title text",
+ "sig" : "(text)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.BasicDialog",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "monitorResize",
- "type" : "Boolean",
- "desc" : "(optional) If true maintains the fit when the browser window is resized.",
- "isOptional" : false
- },
- {
- "name" : "targetParent",
- "type" : "String/HTMLElment/Element",
- "desc" : "(optional) The target parent, default to the parentNode.",
+ "name" : "text",
+ "type" : "String",
+ "desc" : "The title text to display",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
+ "type" : "Roo.BasicDialog",
"desc" : "this"
}
]
},
{
- "name" : "fly",
+ "name" : "show",
"type" : "function",
- "desc" : "Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element -\nthe dom node can be overwritten by other code.",
- "sig" : "(el, named)",
- "static" : true,
- "memberOf" : "Roo.Element",
- "isStatic" : true,
+ "desc" : "Shows the dialog.",
+ "sig" : "(animateTarget)",
+ "static" : false,
+ "memberOf" : "Roo.BasicDialog",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement",
- "desc" : "The dom node or id",
- "isOptional" : false
- },
- {
- "name" : "named",
- "type" : "String",
- "desc" : "(optional) Allows for creation of named reusable flyweights to\n prevent conflicts (e.g. internally Roo uses \"_internal\")",
+ "name" : "animateTarget",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "(optional) Reset the animation target",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Element",
- "desc" : "The shared Element object"
+ "type" : "Roo.BasicDialog",
+ "desc" : "this"
}
]
},
{
- "name" : "focus",
+ "name" : "toBack",
"type" : "function",
- "desc" : "Tries to focus the element. Any exceptions are caught and ignored.",
+ "desc" : "Sends this dialog to the back (under) of any other visible dialogs",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.BasicDialog",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
+ "type" : "Roo.BasicDialog",
"desc" : "this"
}
]
},
{
- "name" : "get",
+ "name" : "toFront",
"type" : "function",
- "desc" : "Static method to retrieve Element objects. Uses simple caching to consistently return the same object.\nAutomatically fixes if an object was recreated with the same id via AJAX or DOM.",
- "sig" : "(el)",
- "static" : true,
- "memberOf" : "Roo.Element",
- "isStatic" : true,
+ "desc" : "Brings this dialog to the front of any other visible dialogs",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.BasicDialog",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id of the node, a DOM Node or an existing Element.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Element",
- "desc" : "The Element object"
+ "type" : "Roo.BasicDialog",
+ "desc" : "this"
}
]
},
{
- "name" : "getAlignToXY",
+ "name" : "un",
"type" : "function",
- "desc" : "Gets the x,y coordinates to align this element with another element. See {@link #alignTo} for more info on the\nsupported position values.",
- "sig" : "(element, position, offsets)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "element",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The element to align to.",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "position",
- "type" : "String",
- "desc" : "The position to align to.",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "offsets",
- "type" : "Array",
- "desc" : "(optional) Offset the positioning by [x, y]",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Array",
- "desc" : "[x, y]"
- }
- ]
- },
- {
- "name" : "getAnchorXY",
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [
+ "Roo.panel.Content",
+ "Roo.panel.Grid",
+ "Roo.panel.NestedLayout",
+ "Roo.panel.Tree"
+ ],
+ "tree_parent" : [
+ "builder",
+ "none"
+ ]
+ },
+ "Roo.LoadMask" : {
+ "props" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The text to display in a centered loading message box (defaults to 'Loading...')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "msgCls",
+ "type" : "String",
+ "desc" : "The CSS class to apply to the loading message element (defaults to \"x-mask-loading\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "removeMask",
+ "type" : "Boolean",
+ "desc" : "True to create a single-use mask that is automatically destroyed after loading (useful for page loads),\nFalse to persist the mask element reference for multiple uses (e.g., for paged data widgets). Defaults to false.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "disable",
"type" : "function",
- "desc" : "Gets the x,y coordinates specified by the anchor position on the element.",
- "sig" : "(anchor, size, local)",
+ "desc" : "Disables the mask to prevent it from being displayed",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "anchor",
- "type" : "String",
- "desc" : "(optional) The specified anchor position (defaults to \"c\"). See {@link #alignTo} for details on supported anchor positions.",
- "isOptional" : false
- },
- {
- "name" : "size",
- "type" : "Object",
- "desc" : "(optional) An object containing the size to use for calculating anchor position\n {width: (target width), height: (target height)} (defaults to the element's current size)",
- "isOptional" : false
- },
- {
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) True to get the local (element top/left-relative) anchor position instead of page coordinates",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Array",
- "desc" : "[x, y] An array containing the element's x and y coordinates"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "getAttributeNS",
+ "name" : "enable",
"type" : "function",
- "desc" : "Returns the value of a namespaced attribute from the element's underlying DOM node.",
- "sig" : "(namespace, name)",
+ "desc" : "Enables the mask so that it can be displayed",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.MasterTemplate" : {
+ "props" : [
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "The HTML fragment or an array of fragments to join(\"\") or multiple arguments to join(\"\")",
+ "memberOf" : "Roo.Template",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "onLoad",
+ "type" : "Function",
+ "desc" : "Called after the template has been loaded and complied (usually from a remove source)",
+ "memberOf" : "Roo.Template",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "url",
+ "type" : "String",
+ "desc" : "The Url to load the template from. beware if you are loading from a url, the data may not be ready if you use it instantly..\n it should be fixed so that template is observable...",
+ "memberOf" : "Roo.Template",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "add",
+ "type" : "function",
+ "desc" : "Applies the passed values to a child template.",
+ "sig" : "(name, values)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "namespace",
- "type" : "String",
- "desc" : "The namespace in which to look for the attribute",
+ "name" : "name",
+ "type" : "String/Number",
+ "desc" : "(optional) The name or index of the child template",
"isOptional" : false
},
{
- "name" : "name",
- "type" : "String",
- "desc" : "The attribute name",
+ "name" : "values",
+ "type" : "Array/Object",
+ "desc" : "The values to be applied to the template",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "The attribute value"
+ "type" : "MasterTemplate",
+ "desc" : "this"
}
]
},
{
- "name" : "getBorderWidth",
+ "name" : "addAll",
"type" : "function",
- "desc" : "Gets the width of the border(s) for the specified side(s)",
- "sig" : "(side)",
+ "desc" : "Alias for fill().",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "side",
- "type" : "String",
- "desc" : "Can be t, l, r, b or any combination of those to add multiple values. For example,\npassing lr would get the border (l)eft width + the border (r)ight width.",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "The width of the sides passed added together"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "getBottom",
+ "name" : "append",
"type" : "function",
- "desc" : "Gets the bottom Y coordinate of the element (element Y position + element height)",
- "sig" : "(local)",
+ "desc" : "Applies the supplied values to the template and appends the new node(s) to el.",
+ "sig" : "(el, values, returnElement)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.Template",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "local",
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The context element",
+ "isOptional" : false
+ },
+ {
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnElement",
"type" : "Boolean",
- "desc" : "True to get the local css position instead of page coordinate",
+ "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : ""
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The new node or Element"
}
]
},
{
- "name" : "getBox",
+ "name" : "apply",
"type" : "function",
- "desc" : "Return a box {x, y, width, height} that can be used to set another elements\nsize/location to match this element.",
- "sig" : "(contentBox, local)",
+ "desc" : "Alias for {@link #applyTemplate}",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.Template",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "applyTemplate",
+ "type" : "function",
+ "desc" : "Returns an HTML fragment of this template with the specified values applied.",
+ "sig" : "(values)",
+ "static" : false,
+ "memberOf" : "Roo.Template",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "contentBox",
- "type" : "Boolean",
- "desc" : "(optional) If true a box for the content of the element is returned.",
- "isOptional" : false
- },
- {
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page x/y.",
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "box An object in the format {x, y, width, height}"
+ "type" : "String",
+ "desc" : "The HTML fragment"
}
]
},
{
- "name" : "getCenterXY",
+ "name" : "compile",
"type" : "function",
- "desc" : "Calculates the x, y to center this element on the screen",
+ "desc" : "Compiles the template into an internal function, eliminating the RegEx overhead.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.Template",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Array",
- "desc" : "The x, y values [x, y]"
+ "type" : "Roo.Template",
+ "desc" : "this"
}
]
},
{
- "name" : "getColor",
+ "name" : "fill",
"type" : "function",
- "desc" : "Return the CSS color for the specified CSS attribute. rgb, 3 digit (like #fff) and valid values\nare convert to standard 6 digit hex color.",
- "sig" : "(attr, defaultValue, prefix)",
+ "desc" : "Applies all the passed values to a child template.",
+ "sig" : "(name, values, reset)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "attr",
- "type" : "String",
- "desc" : "The css attribute",
+ "name" : "name",
+ "type" : "String/Number",
+ "desc" : "(optional) The name or index of the child template",
"isOptional" : false
},
{
- "name" : "defaultValue",
- "type" : "String",
- "desc" : "The default value to use when a valid color isn't found",
+ "name" : "values",
+ "type" : "Array",
+ "desc" : "The values to be applied to the template, this should be an array of objects.",
"isOptional" : false
},
{
- "name" : "prefix",
- "type" : "String",
- "desc" : "(optional) defaults to #. Use an empty string when working with\nYUI color anims.",
+ "name" : "reset",
+ "type" : "Boolean",
+ "desc" : "(optional) True to reset the template first",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "MasterTemplate",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "getComputedHeight",
+ "name" : "from",
"type" : "function",
- "desc" : "Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders\nwhen needed to simulate offsetHeight when offsets aren't available. This may not work on display:none elements\nif a height has not been set using CSS.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Element",
- "isStatic" : false,
+ "desc" : "Creates a template from the passed element's value (display:none textarea, preferred) or innerHTML. e.g.\nvar tpl = Roo.MasterTemplate.from('element-id');",
+ "sig" : "(el, config)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Number",
- "desc" : ""
+ "name" : "el",
+ "type" : "String/HTMLElement",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getComputedWidth",
+ "name" : "insertAfter",
"type" : "function",
- "desc" : "Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders\nwhen needed to simulate offsetWidth when offsets aren't available. This may not work on display:none elements\nif a width has not been set using CSS.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Applies the supplied values to the template and inserts the new node(s) after el.",
+ "sig" : "(el, values, returnElement)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.Template",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The context element",
+ "isOptional" : false
+ },
+ {
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnElement",
+ "type" : "Boolean",
+ "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : ""
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The new node or Element"
}
]
},
{
- "name" : "getFrameWidth",
+ "name" : "insertBefore",
"type" : "function",
- "desc" : "Returns the sum width of the padding and borders for the passed \"sides\". See getBorderWidth()\n for more information about the sides.",
- "sig" : "(sides)",
+ "desc" : "Applies the supplied values to the template and inserts the new node(s) before el.",
+ "sig" : "(el, values, returnElement)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.Template",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "sides",
- "type" : "String",
- "desc" : "",
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The context element",
+ "isOptional" : false
+ },
+ {
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnElement",
+ "type" : "Boolean",
+ "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : ""
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The new node or Element"
}
]
},
{
- "name" : "getHeight",
+ "name" : "insertFirst",
"type" : "function",
- "desc" : "Returns the offset height of the element",
- "sig" : "(contentHeight)",
+ "desc" : "Applies the supplied values to the template and inserts the new node(s) as the first child of el.",
+ "sig" : "(el, values, returnElement)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.Template",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "contentHeight",
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The context element",
+ "isOptional" : false
+ },
+ {
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnElement",
"type" : "Boolean",
- "desc" : "(optional) true to get the height minus borders and padding",
+ "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "The element's height"
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The new node or Element"
}
]
},
{
- "name" : "getLeft",
+ "name" : "overwrite",
"type" : "function",
- "desc" : "Gets the left X coordinate",
- "sig" : "(local)",
+ "desc" : "Applies the supplied values to the template and overwrites the content of el with the new node(s).",
+ "sig" : "(el, values, returnElement)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.Template",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "local",
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The context element",
+ "isOptional" : false
+ },
+ {
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnElement",
"type" : "Boolean",
- "desc" : "True to get the local css position instead of page coordinate",
+ "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : ""
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The new node or Element"
}
]
},
{
- "name" : "getMargins",
+ "name" : "reset",
"type" : "function",
- "desc" : "Returns an object with properties top, left, right and bottom representing the margins of this element unless sides is passed,\nthen it returns the calculated width of the sides (see getPadding)",
- "sig" : "(sides)",
+ "desc" : "Resets the template for reuse",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "MasterTemplate",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "set",
+ "type" : "function",
+ "desc" : "Sets the HTML used as the template and optionally compiles it.",
+ "sig" : "(html, compile)",
+ "static" : false,
+ "memberOf" : "Roo.Template",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "sides",
+ "name" : "html",
"type" : "String",
- "desc" : "(optional) Any combination of l, r, t, b to get the sum of those sides",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "compile",
+ "type" : "Boolean",
+ "desc" : "(optional) True to compile the template (defaults to undefined)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Object/Number",
- "desc" : ""
+ "type" : "Roo.Template",
+ "desc" : "this"
}
]
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.MessageBox" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "getNextSibling",
+ "name" : "alert",
"type" : "function",
- "desc" : "Gets the next sibling, skipping text nodes",
- "sig" : "()\n{\n\n}",
+ "desc" : "Displays a standard read-only message box with an OK button (comparable to the basic JavaScript Window.alert).\nIf a callback function is passed it will be called after the user clicks the button, and the\nid of the button that was clicked will be passed as the only parameter to the callback\n(could also be the top-right close button).",
+ "sig" : "(title, msg, fn, scope)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title bar text",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The message box body text",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "(optional) The callback function invoked after the message box is closed",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the callback function",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "HTMLElement",
- "desc" : "The next sibling or null"
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
}
]
},
{
- "name" : "getPadding",
+ "name" : "confirm",
"type" : "function",
- "desc" : "Gets the width of the padding(s) for the specified side(s)",
- "sig" : "(side)",
+ "desc" : "Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's Window.confirm).\nIf a callback function is passed it will be called after the user clicks either button, and the id of the\nbutton that was clicked will be passed as the only parameter to the callback (could also be the top-right close button).",
+ "sig" : "(title, msg, fn, scope)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "side",
+ "name" : "title",
"type" : "String",
- "desc" : "Can be t, l, r, b or any combination of those to add multiple values. For example,\npassing lr would get the padding (l)eft + the padding (r)ight.",
+ "desc" : "The title bar text",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The message box body text",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "(optional) The callback function invoked after the message box is closed",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the callback function",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "The padding of the sides passed added together"
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
}
]
},
{
- "name" : "getPositioning",
+ "name" : "getDialog",
"type" : "function",
- "desc" : "Gets an object with all CSS positioning properties. Useful along with setPostioning to get\nsnapshot before performing an update and then restoring the element.",
+ "desc" : "Returns a reference to the underlying {@link Roo.BasicDialog} element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : ""
+ "type" : "Roo.BasicDialog",
+ "desc" : "The BasicDialog element"
}
]
},
{
- "name" : "getPrevSibling",
+ "name" : "hide",
"type" : "function",
- "desc" : "Gets the previous sibling, skipping text nodes",
+ "desc" : "Hides the message box if it is displayed",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "HTMLElement",
- "desc" : "The previous sibling or null"
- }
- ]
+ "returns" : []
},
{
- "name" : "getRegion",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Returns the region of the given element.\nThe element must be part of the DOM tree to have a region (display:none or elements not appended return false).",
+ "desc" : "Returns true if the message box is currently displayed",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Region",
- "desc" : "A Roo.lib.Region containing \"top, left, bottom, right\" member data."
+ "type" : "Boolean",
+ "desc" : "True if the message box is visible, else false"
}
]
},
{
- "name" : "getRight",
+ "name" : "progress",
"type" : "function",
- "desc" : "Gets the right X coordinate of the element (element X position + element width)",
- "sig" : "(local)",
+ "desc" : "Displays a message box with a progress bar. This message box has no buttons and is not closeable by\nthe user. You are responsible for updating the progress bar as needed via {@link Roo.MessageBox#updateProgress}\nand closing the message box when the process is complete.",
+ "sig" : "(title, msg)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "local",
- "type" : "Boolean",
- "desc" : "True to get the local css position instead of page coordinate",
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title bar text",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The message box body text",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : ""
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
}
]
},
{
- "name" : "getScroll",
+ "name" : "prompt",
"type" : "function",
- "desc" : "Returns the current scroll position of the element.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to\nJavaScript's Window.prompt). The prompt can be a single-line or multi-line textbox. If a callback function\nis passed it will be called after the user clicks either button, and the id of the button that was clicked\n(could also be the top-right close button) and the text that was entered will be passed as the two\nparameters to the callback.",
+ "sig" : "(title, msg, fn, scope, multiline)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title bar text",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The message box body text",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "(optional) The callback function invoked after the message box is closed",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the callback function",
+ "isOptional" : false
+ },
+ {
+ "name" : "multiline",
+ "type" : "Boolean/Number",
+ "desc" : "(optional) True to create a multiline textbox using the defaultTextHeight\nproperty, or the height in pixels to create the textbox (defaults to false / single-line)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "An object containing the scroll position in the format {left: (scrollLeft), top: (scrollTop)}"
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
}
]
},
{
- "name" : "getSize",
+ "name" : "show",
"type" : "function",
- "desc" : "Returns the size of the element.",
- "sig" : "(contentSize)",
+ "desc" : "Displays a new message box, or reinitializes an existing message box, based on the config options\npassed in. All functions (e.g. prompt, alert, etc) on MessageBox call this function internally.\nThe following config object properties are supported:\n<pre>\nProperty Type Description\n---------- --------------- ------------------------------------------------------------------------------------\nanimEl String/Element An id or Element from which the message box should animate as it opens and\n closes (defaults to undefined)\nbuttons Object/Boolean A button config object (e.g., Roo.MessageBox.OKCANCEL or {ok:'Foo',\n cancel:'Bar'}), or false to not show any buttons (defaults to false)\nclosable Boolean False to hide the top-right close button (defaults to true). Note that\n progress and wait dialogs will ignore this property and always hide the\n close button as they can only be closed programmatically.\ncls String A custom CSS class to apply to the message box element\ndefaultTextHeight Number The default height in pixels of the message box's multiline textarea if\n displayed (defaults to 75)\nfn Function A callback function to execute after closing the dialog. The arguments to the\n function will be btn (the name of the button that was clicked, if applicable,\n e.g. \"ok\"), and text (the value of the active text field, if applicable).\n Progress and wait dialogs will ignore this option since they do not respond to\n user actions and can only be closed programmatically, so any required function\n should be called by the same code after it closes the dialog.\nicon String A CSS class that provides a background image to be used as an icon for\n the dialog (e.g., Roo.MessageBox.WARNING or 'custom-class', defaults to '')\nmaxWidth Number The maximum width in pixels of the message box (defaults to 600)\nminWidth Number The minimum width in pixels of the message box (defaults to 100)\nmodal Boolean False to allow user interaction with the page while the message box is\n displayed (defaults to true)\nmsg String A string that will replace the existing message box body text (defaults\n to the XHTML-compliant non-breaking space character ' ')\nmultiline Boolean True to prompt the user to enter multi-line text (defaults to false)\nprogress Boolean True to display a progress bar (defaults to false)\nprogressText String The text to display inside the progress bar if progress = true (defaults to '')\nprompt Boolean True to prompt the user to enter single-line text (defaults to false)\nproxyDrag Boolean True to display a lightweight proxy while dragging (defaults to false)\ntitle String The title text\nvalue String The string value to set into the active textbox element if displayed\nwait Boolean True to display a progress bar (defaults to false)\nwidth Number The width of the dialog in pixels\n</pre>\n\nExample usage:\n<pre><code>\nRoo.Msg.show({\n title: 'Address',\n msg: 'Please enter your address:',\n width: 300,\n buttons: Roo.MessageBox.OKCANCEL,\n multiline: true,\n fn: saveAddress,\n animEl: 'addAddressBtn'\n});\n</code></pre>",
+ "sig" : "(config)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "contentSize",
- "type" : "Boolean",
- "desc" : "(optional) true to get the width/size minus borders and padding",
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
}
]
},
{
- "name" : "getStyle",
+ "name" : "updateProgress",
"type" : "function",
- "desc" : "Normalizes currentStyle and computedStyle. This is not YUI getStyle, it is an optimised version.",
- "sig" : "(property)",
+ "desc" : "Updates a progress-style message box's text and progress bar. Only relevant on message boxes\ninitiated via {@link Roo.MessageBox#progress} or by calling {@link Roo.MessageBox#show} with progress: true.",
+ "sig" : "(value, text)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "property",
+ "name" : "value",
+ "type" : "Number",
+ "desc" : "Any number between 0 and 1 (e.g., .5)",
+ "isOptional" : false
+ },
+ {
+ "name" : "text",
"type" : "String",
- "desc" : "The style property whose value is returned.",
+ "desc" : "(optional) If defined, the message box's body text is replaced with the specified string (defaults to undefined)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "The current value of the style property for this element."
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
}
]
},
{
- "name" : "getStyles",
+ "name" : "updateText",
"type" : "function",
- "desc" : "Returns an object with properties matching the styles requested.\nFor example, el.getStyles('color', 'font-size', 'width') might return\n{'color': '#FFFFFF', 'font-size': '13px', 'width': '100px'}.",
- "sig" : "(style1, style2)",
+ "desc" : "Updates the message box body text",
+ "sig" : "(text)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "style1",
- "type" : "String",
- "desc" : "A style name",
- "isOptional" : false
- },
- {
- "name" : "style2",
+ "name" : "text",
"type" : "String",
- "desc" : "A style name",
+ "desc" : "(optional) Replaces the message box element's innerHTML with the specified string (defaults to\nthe XHTML-compliant non-breaking space character '&#160;')",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "The style object"
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
}
]
},
{
- "name" : "getTop",
+ "name" : "wait",
"type" : "function",
- "desc" : "Gets the top Y coordinate",
- "sig" : "(local)",
+ "desc" : "Displays a message box with an infinitely auto-updating progress bar. This can be used to block user\ninteraction while waiting for a long-running process to complete that does not have defined intervals.\nYou are responsible for closing the message box when the process is complete.",
+ "sig" : "(msg, title)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "local",
- "type" : "Boolean",
- "desc" : "True to get the local css position instead of page coordinate",
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The message box body text",
+ "isOptional" : false
+ },
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "(optional) The title bar text",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : ""
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
}
]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.PagingToolbar" : {
+ "props" : [
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "container The id or element that will contain the toolbar",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "getUpdateManager",
+ "name" : "displayInfo",
+ "type" : "Boolean",
+ "desc" : "True to display the displayMsg (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "displayMsg",
+ "type" : "String",
+ "desc" : "The paging status message to display (defaults to \"Displaying {start} - {end} of {total}\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "emptyMsg",
+ "type" : "String",
+ "desc" : "The message to display when no records are found (defaults to \"No data to display\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "items",
+ "type" : "Array",
+ "desc" : "array of button configs or elements to add (will be converted to a MixedCollection)",
+ "memberOf" : "Roo.Toolbar",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "pageSize",
+ "type" : "Number",
+ "desc" : "The number of records to display per page (defaults to 20)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "text",
+ "type" : "string",
+ "desc" : "",
+ "memberOf" : "Roo.Toolbar",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "add",
"type" : "function",
- "desc" : "Gets this element's UpdateManager",
- "sig" : "()\n{\n\n}",
+ "desc" : "Adds element(s) to the toolbar -- this function takes a variable number of \narguments of mixed type and adds them to the toolbar.",
+ "sig" : "(arg1, arg2)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.Toolbar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.UpdateManager",
- "desc" : "The UpdateManager"
+ "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" : "getValue",
+ "name" : "addButton",
"type" : "function",
- "desc" : "Returns the value of the \"value\" attribute",
- "sig" : "(asNumber)",
+ "desc" : "Adds a button (or buttons). See {@link Roo.Toolbar.Button} for more info on the config.",
+ "sig" : "(config)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.Toolbar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "asNumber",
- "type" : "Boolean",
- "desc" : "true to parse the value as a number",
+ "name" : "config",
+ "type" : "Object/Array",
+ "desc" : "A button config or array of configs",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "String/Number",
+ "type" : "Roo.Toolbar.Button/Array",
"desc" : ""
}
]
},
{
- "name" : "getViewSize",
+ "name" : "addDom",
"type" : "function",
- "desc" : "Returns the width and height of the viewport.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Adds a new element to the toolbar from the passed {@link Roo.DomHelper} config.",
+ "sig" : "(config)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.Toolbar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "An object containing the viewport's size {width: (viewport width), height: (viewport height)}"
+ "type" : "Roo.Toolbar.Item",
+ "desc" : "The element's item"
}
]
},
{
- "name" : "getWidth",
+ "name" : "addElement",
"type" : "function",
- "desc" : "Returns the offset width of the element",
- "sig" : "(contentWidth)",
+ "desc" : "Adds any standard HTML element to the toolbar",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.Toolbar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "contentWidth",
- "type" : "Boolean",
- "desc" : "(optional) true to get the width minus borders and padding",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The element or id of the element to add",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "The element's width"
+ "type" : "Roo.Toolbar.Item",
+ "desc" : "The element's item"
}
]
},
{
- "name" : "getX",
+ "name" : "addField",
"type" : "function",
- "desc" : "Gets the current X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
- "sig" : "()\n{\n\n}",
+ "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}.",
+ "sig" : "(field)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.Toolbar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "field",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "The X position of the element"
+ "type" : "Roo.ToolbarItem",
+ "desc" : ""
}
]
},
{
- "name" : "getXY",
+ "name" : "addFill",
"type" : "function",
- "desc" : "Gets the current position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
+ "desc" : "Adds a fill element that forces subsequent additions to the right side of the toolbar",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.Toolbar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Array",
- "desc" : "The XY position of the element"
+ "type" : "Roo.Toolbar.Fill",
+ "desc" : "The fill item"
}
]
},
{
- "name" : "getY",
+ "name" : "addItem",
"type" : "function",
- "desc" : "Gets the current Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
- "sig" : "()\n{\n\n}",
+ "desc" : "Adds any Toolbar.Item or subclass",
+ "sig" : "(item)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.Toolbar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "item",
+ "type" : "Roo.Toolbar.Item",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "The Y position of the element"
+ "type" : "Roo.Toolbar.Item",
+ "desc" : "The item"
}
]
},
{
- "name" : "hasClass",
+ "name" : "addSeparator",
"type" : "function",
- "desc" : "Checks if the specified CSS class exists on this element's DOM node.",
- "sig" : "(className)",
+ "desc" : "Adds a separator",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.Toolbar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "className",
- "type" : "String",
- "desc" : "The CSS class to check for",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the class exists, else false"
+ "type" : "Roo.Toolbar.Item",
+ "desc" : "The separator item"
}
]
},
{
- "name" : "hide",
+ "name" : "addSpacer",
"type" : "function",
- "desc" : "Hide this element - Uses display mode to determine whether to use \"display\" or \"visibility\". See {@link #setVisible}.",
- "sig" : "(animate)",
+ "desc" : "Adds a spacer element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.Toolbar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) true for the default animation or a standard Element animation config object",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "type" : "Roo.Toolbar.Spacer",
+ "desc" : "The spacer item"
}
]
},
{
- "name" : "initDD",
+ "name" : "addText",
"type" : "function",
- "desc" : "Initializes a {@link Roo.dd.DD} drag drop object for this element.",
- "sig" : "(group, config, overrides)",
+ "desc" : "Adds text to the toolbar",
+ "sig" : "(text)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.Toolbar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "group",
+ "name" : "text",
"type" : "String",
- "desc" : "The group the DD object is member of",
- "isOptional" : false
- },
- {
- "name" : "config",
- "type" : "Object",
- "desc" : "The DD config object",
- "isOptional" : false
- },
- {
- "name" : "overrides",
- "type" : "Object",
- "desc" : "An object containing methods to override/implement on the DD object",
+ "desc" : "The text to add",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.dd.DD",
- "desc" : "The DD object"
+ "type" : "Roo.Toolbar.Item",
+ "desc" : "The element's item"
}
]
},
{
- "name" : "initDDProxy",
+ "name" : "addxtype",
"type" : "function",
- "desc" : "Initializes a {@link Roo.dd.DDProxy} object for this element.",
- "sig" : "(group, config, overrides)",
+ "desc" : "Add an Xtype element",
+ "sig" : "(xtype)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.Toolbar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "group",
- "type" : "String",
- "desc" : "The group the DDProxy object is member of",
- "isOptional" : false
- },
- {
- "name" : "config",
- "type" : "Object",
- "desc" : "The DDProxy config object",
- "isOptional" : false
- },
- {
- "name" : "overrides",
+ "name" : "xtype",
"type" : "Object",
- "desc" : "An object containing methods to override/implement on the DDProxy object",
+ "desc" : "Xtype Object",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.dd.DDProxy",
- "desc" : "The DDProxy object"
+ "type" : "Object",
+ "desc" : "created Object"
}
]
},
{
- "name" : "initDDTarget",
+ "name" : "bind",
"type" : "function",
- "desc" : "Initializes a {@link Roo.dd.DDTarget} object for this element.",
- "sig" : "(group, config, overrides)",
+ "desc" : "Binds the paging toolbar to the specified {@link Roo.data.Store}",
+ "sig" : "(store)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "group",
- "type" : "String",
- "desc" : "The group the DDTarget object is member of",
- "isOptional" : false
- },
- {
- "name" : "config",
- "type" : "Object",
- "desc" : "The DDTarget config object",
- "isOptional" : false
- },
- {
- "name" : "overrides",
- "type" : "Object",
- "desc" : "An object containing methods to override/implement on the DDTarget object",
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to bind",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.dd.DDTarget",
- "desc" : "The DDTarget object"
- }
- ]
+ "returns" : []
},
{
- "name" : "insertAfter",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Inserts this element after the passed element in the DOM",
- "sig" : "(el)",
+ "desc" : "Returns the Element for this toolbar.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.Toolbar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The element to insert after",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "this"
+ "desc" : ""
}
]
},
{
- "name" : "insertBefore",
+ "name" : "hide",
"type" : "function",
- "desc" : "Inserts this element before the passed element in the DOM",
- "sig" : "(el)",
+ "desc" : "Hide the toolbar",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.Toolbar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The element to insert before",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "insertFirst",
+ "name" : "insertButton",
"type" : "function",
- "desc" : "Inserts (or creates) an element (or DomHelper config) as the first child of the this element",
- "sig" : "(el)",
+ "desc" : "Inserts any {@link Roo.Toolbar.Item}/{@link Roo.Toolbar.Button} at the specified index.",
+ "sig" : "(index, item)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.Toolbar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element/Object",
- "desc" : "The id or element to insert or a DomHelper config to create and insert",
+ "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.Element",
- "desc" : "The new child"
+ "type" : "Roo.Toolbar.Button/Item",
+ "desc" : ""
}
]
},
{
- "name" : "insertHtml",
+ "name" : "onClick",
"type" : "function",
- "desc" : "Inserts an html fragment into this element",
- "sig" : "(where, html, returnEl)",
+ "desc" : "event that occurs when you click on the navigation buttons - can be used to trigger load of a grid.",
+ "sig" : "(which)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "where",
- "type" : "String",
- "desc" : "Where to insert the html in relation to the this element - beforeBegin, afterBegin, beforeEnd, afterEnd.",
- "isOptional" : false
- },
- {
- "name" : "html",
+ "name" : "which",
"type" : "String",
- "desc" : "The HTML fragment",
- "isOptional" : false
- },
- {
- "name" : "returnEl",
- "type" : "Boolean",
- "desc" : "True to return an Roo.Element",
+ "desc" : "(first|prev|next|last|refresh) which button to press.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The inserted node (or nearest related if more than 1 inserted)"
- }
- ]
+ "returns" : []
},
{
- "name" : "insertSibling",
+ "name" : "show",
"type" : "function",
- "desc" : "Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element",
- "sig" : "(el, where, returnDom)",
+ "desc" : "Show the toolbar",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.Toolbar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement/Element/Object",
- "desc" : "The id or element to insert or a DomHelper config to create and insert",
- "isOptional" : false
- },
- {
- "name" : "where",
- "type" : "String",
- "desc" : "(optional) 'before' or 'after' defaults to before",
- "isOptional" : false
- },
- {
- "name" : "returnDom",
- "type" : "Boolean",
- "desc" : "(optional) True to return the raw DOM element instead of Roo.Element",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "the inserted Element"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "is",
+ "name" : "unbind",
"type" : "function",
- "desc" : "Returns true if this element matches the passed simple selector (e.g. div.some-class or span:first-child)",
- "sig" : "(selector)",
+ "desc" : "Unbinds the paging toolbar from the specified {@link Roo.data.Store}",
+ "sig" : "(store)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "selector",
- "type" : "String",
- "desc" : "The simple selector to test",
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to unbind",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if this element matches the selector, else false"
- }
- ]
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [
+ "Roo.Toolbar.Item",
+ "Roo.Toolbar.Fill",
+ "Roo.Toolbar.Separator",
+ "Roo.Toolbar.Spacer",
+ "Roo.Toolbar.TextItem",
+ "Roo.Toolbar.Button",
+ "Roo.Toolbar.SplitButton",
+ "Roo.form.Field",
+ "Roo.form.Checkbox",
+ "Roo.form.ComboBox",
+ "Roo.form.ComboBoxArray",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.FCKeditor",
+ "Roo.form.GridField",
+ "Roo.form.Hidden",
+ "Roo.form.HtmlEditor",
+ "Roo.form.MonthField",
+ "Roo.form.NumberField",
+ "Roo.form.Radio",
+ "Roo.form.Select",
+ "Roo.form.Signature",
+ "Roo.form.TextArea",
+ "Roo.form.TextField",
+ "Roo.form.TriggerField"
+ ],
+ "tree_parent" : []
+ },
+ "Roo.QuickTips" : {
+ "props" : [
+ {
+ "name" : "Delay",
+ "type" : "Number",
+ "desc" : "in milliseconds before the quick tip hides when autoDismiss = true (defaults to 5000)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "isBorderBox",
+ "name" : "True",
+ "type" : "Boolean",
+ "desc" : "to automatically hide the quick tip after a set period of time, regardless of the user's actions\n(defaults to true). Used in conjunction with autoDismissDelay.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean",
+ "desc" : "True to turn on fade animation. Defaults to false (ClearType/scrollbar flicker issues in IE7).",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoHide",
+ "type" : "Boolean",
+ "desc" : "True to automatically hide the quick tip after the mouse exits the target element (defaults to true).\nUsed in conjunction with hideDelay.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "A CSS class to apply to the base quick tip element (defaults to '').",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideDelay",
+ "type" : "Number",
+ "desc" : "Delay in milliseconds before the quick tip hides when autoHide = true (defaults to 200)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideOnClick",
+ "type" : "Boolean",
+ "desc" : "True to hide the quick tip if the user clicks anywhere in the document (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "interceptTitles",
+ "type" : "Boolean",
+ "desc" : "True to automatically use the element's DOM title value if available (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxWidth",
+ "type" : "Number",
+ "desc" : "The maximum width of the quick tip (defaults to 300)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minWidth",
+ "type" : "Number",
+ "desc" : "The minimum width of the quick tip (defaults to 40)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "showDelay",
+ "type" : "Number",
+ "desc" : "Delay in milliseconds before the quick tip displays after the mouse enters the target element (defaults to 500)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "Body text to display (defaults to ''). This can be any valid HTML markup.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "Title text to display (defaults to ''). This can be any valid HTML markup.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "trackMouse",
+ "type" : "Boolean",
+ "desc" : "True to have the quick tip follow the mouse as it moves over the target element (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "Width in pixels of the quick tip (defaults to auto). Width will be ignored if it exceeds the bounds of\nminWidth or maxWidth.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "disable",
"type" : "function",
- "desc" : "Tests various css rules/browsers to determine if this element uses a border box",
+ "desc" : "Disable this quick tip.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "isDisplayed",
+ "name" : "enable",
"type" : "function",
- "desc" : "Returns true if display is not \"none\"",
+ "desc" : "Enable this quick tip.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "isMasked",
+ "name" : "init",
"type" : "function",
- "desc" : "Returns true if this element is masked",
+ "desc" : "Initialize and enable QuickTips for first use. This should be called once before the first attempt to access\nor display QuickTips in a page.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "isScrollable",
+ "name" : "isEnabled",
"type" : "function",
- "desc" : "Returns true if this element is scrollable.",
+ "desc" : "Returns true if the quick tip is enabled, else false.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "isVisible",
+ "name" : "register",
"type" : "function",
- "desc" : "Checks whether the element is currently visible using both visibility and display properties.",
- "sig" : "(deep)",
+ "desc" : "Configures a new quick tip instance and assigns it to a target element. The following config options\nare supported:\n<pre>\nProperty Type Description\n---------- --------------------- ------------------------------------------------------------------------\ntarget Element/String/Array An Element, id or array of ids that this quick tip should be tied to\n</ul>",
+ "sig" : "(config)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "deep",
- "type" : "Boolean",
- "desc" : "(optional) True to walk the dom and see if parent elements are hidden (defaults to false)",
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the element is currently visible, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "load",
+ "name" : "unregister",
"type" : "function",
- "desc" : "Direct access to the UpdateManager update() method (takes the same parameters).",
- "sig" : "(url, params, callback, discardUrl)",
+ "desc" : "Removes this quick tip from its element and destroys it.",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "url",
- "type" : "String/Function",
- "desc" : "The url for this request or a function to call to get the url",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The parameters to pass as either a url encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)",
- "isOptional" : false
- },
- {
- "name" : "discardUrl",
- "type" : "Boolean",
- "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used url. If true, it will not store the url.",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The element from which the quick tip is to be removed.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.Resizable" : {
+ "props" : [
+ {
+ "name" : "adjustments",
+ "type" : "Array/String",
+ "desc" : "String \"auto\" or an array [width, height] with values to be <b>added</b> to the\nresize operation's new size (defaults to [0, 0])",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "mask",
+ "name" : "animate",
+ "type" : "Boolean",
+ "desc" : "True to animate the resize (not compatible with dynamic sizing, defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "constrainTo",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "Constrain the resize to a particular element",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableTrackOver",
+ "type" : "Boolean",
+ "desc" : "True to disable mouse tracking. This is only applied at config time. (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "draggable",
+ "type" : "Boolean",
+ "desc" : "Convenience to initialize drag drop (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "duration",
+ "type" : "Number",
+ "desc" : "Animation duration if animate = true (defaults to .35)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dynamic",
+ "type" : "Boolean",
+ "desc" : "True to resize the element while dragging instead of using a proxy (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "easing",
+ "type" : "String",
+ "desc" : "Animation easing if animate = true (defaults to 'easingOutStrong')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enabled",
+ "type" : "Boolean",
+ "desc" : "False to disable resizing (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "handles",
+ "type" : "String",
+ "desc" : "String consisting of the resize handles to display (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The height of the element in pixels (defaults to null)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "heightIncrement",
+ "type" : "Number",
+ "desc" : "The increment to snap the height resize in pixels (dynamic must be true, defaults to 0)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxHeight",
+ "type" : "Number",
+ "desc" : "The maximum height for the element (defaults to 10000)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxWidth",
+ "type" : "Number",
+ "desc" : "The maximum width for the element (defaults to 10000)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minHeight",
+ "type" : "Number",
+ "desc" : "The minimum height for the element (defaults to 5)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minWidth",
+ "type" : "Number",
+ "desc" : "The minimum width for the element (defaults to 5)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minX",
+ "type" : "Number",
+ "desc" : "The minimum allowed page X for the element (only used for west resizing, defaults to 0)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minY",
+ "type" : "Number",
+ "desc" : "The minimum allowed page Y for the element (only used for north resizing, defaults to 0)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "multiDirectional",
+ "type" : "Boolean",
+ "desc" : "<b>Deprecated</b>. The old style of adding multi-direction resize handles, deprecated\nin favor of the handles config option (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "pinned",
+ "type" : "Boolean",
+ "desc" : "True to ensure that the resize handles are always visible, false to display them only when the\nuser mouses over the resizable borders. This is only applied at config time. (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "preserveRatio",
+ "type" : "Boolean",
+ "desc" : "True to preserve the original ratio between height and width during resize (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "resizeChild",
+ "type" : "Boolean/String/Element",
+ "desc" : "True to resize the first child, or id/element to resize (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "resizeRegion",
+ "type" : "Roo.lib.Region",
+ "desc" : "Constrain the resize to a particular region",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "transparent",
+ "type" : "Boolean",
+ "desc" : "True for transparent handles. This is only applied at config time. (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The width of the element in pixels (defaults to null)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "widthIncrement",
+ "type" : "Number",
+ "desc" : "The increment to snap the width resize in pixels (dynamic must be true, defaults to 0)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "wrap",
+ "type" : "Boolean",
+ "desc" : "True to wrap an element with a div if needed (required for textareas and images, defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforeresize",
"type" : "function",
- "desc" : "Puts a mask over this element to disable user interaction. Requires core.css.\nThis method can only be applied to elements which accept child nodes.",
- "sig" : "(msg, msgCls)",
- "static" : false,
- "memberOf" : "Roo.Element",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fired before resize is allowed. Set enabled to false to cancel resize.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "msg",
- "type" : "String",
- "desc" : "(optional) A message to display in the mask",
+ "name" : "this",
+ "type" : "Roo.Resizable",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "msgCls",
- "type" : "String",
- "desc" : "(optional) A css class to apply to the msg element - use no-spinner to hide the spinner on bootstrap",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The mousedown event",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Element",
- "desc" : "The mask element"
- }
- ]
+ "returns" : []
},
{
- "name" : "move",
+ "name" : "resize",
"type" : "function",
- "desc" : "Move this element relative to its current position.",
- "sig" : "(direction, distance, animate)",
- "static" : false,
- "memberOf" : "Roo.Element",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fired after a resize.",
+ "sig" : "function (_self, width, height, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "direction",
- "type" : "String",
- "desc" : "Possible values are: \"l\",\"left\" - \"r\",\"right\" - \"t\",\"top\",\"up\" - \"b\",\"bottom\",\"down\".",
+ "name" : "this",
+ "type" : "Roo.Resizable",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "distance",
+ "name" : "width",
"type" : "Number",
- "desc" : "How far to move the element in pixels",
+ "desc" : "The new width",
"isOptional" : false
},
{
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) true for the default animation or a standard Element animation config object",
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The mouseup event",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "moveTo",
+ "name" : "resizing",
"type" : "function",
- "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
- "sig" : "(x, y, animate)",
- "static" : false,
- "memberOf" : "Roo.Element",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fired a resizing.",
+ "sig" : "function (_self, x, y, w, h, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Resizable",
+ "desc" : "",
+ "isOptional" : false
+ },
{
"name" : "x",
"type" : "Number",
- "desc" : "X value for new position (coordinates are page-based)",
+ "desc" : "The new x position",
"isOptional" : false
},
{
"name" : "y",
"type" : "Number",
- "desc" : "Y value for new position (coordinates are page-based)",
+ "desc" : "The new y position",
"isOptional" : false
},
{
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) True for the default animation, or a standard Element animation config object",
+ "name" : "w",
+ "type" : "Number",
+ "desc" : "The new w width",
+ "isOptional" : false
+ },
+ {
+ "name" : "h",
+ "type" : "Number",
+ "desc" : "The new h hight",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The mouseup event",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "on",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Appends an event handler (Shorthand for addListener)",
- "sig" : "(eventName, fn, scope, options)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The type of event to append",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "fn",
+ "name" : "handler",
"type" : "Function",
"desc" : "The method the event invokes",
"isOptional" : false
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) of the fn",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
},
{
"name" : "options",
"type" : "Object",
- "desc" : "(optional)An object with standard {@link Roo.EventManager#addListener} options",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "position",
+ "name" : "capture",
"type" : "function",
- "desc" : "Initializes positioning on this element. If a desired position is not passed, it will make the\nthe element positioned relative IF it is not already positioned.",
- "sig" : "(pos, zIndex, x, y)",
- "static" : false,
- "memberOf" : "Roo.Element",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "pos",
- "type" : "String",
- "desc" : "(optional) Positioning to use \"relative\", \"absolute\" or \"fixed\"",
- "isOptional" : false
- },
- {
- "name" : "zIndex",
- "type" : "Number",
- "desc" : "(optional) The zIndex to apply",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "x",
- "type" : "Number",
- "desc" : "(optional) Set the page X position",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
"isOptional" : false
},
{
- "name" : "y",
- "type" : "Number",
- "desc" : "(optional) Set the page Y position",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "query",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Selects child nodes based on the passed CSS selector (the selector should not contain an id).",
- "sig" : "(selector)",
+ "desc" : "Destroys this resizable. If the element was wrapped and\nremoveEl is not true then the element remains.",
+ "sig" : "(removeEl)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "selector",
- "type" : "String",
- "desc" : "The CSS selector",
+ "name" : "removeEl",
+ "type" : "Boolean",
+ "desc" : "(optional) true to remove the element from the DOM",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Array",
- "desc" : "An array of the matched nodes"
- }
- ]
+ "returns" : []
},
{
- "name" : "radioClass",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Adds one or more CSS classes to this element and removes the same class(es) from all siblings.",
- "sig" : "(className)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "className",
- "type" : "String/Array",
- "desc" : "The CSS class to add, or an array of classes",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "remove",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Removes this element from the DOM and deletes it from the cache",
+ "desc" : "Returns the element this component is bound to.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "removeAllListeners",
+ "name" : "getResizeChild",
"type" : "function",
- "desc" : "Removes all previous added listeners from this element",
+ "desc" : "Returns the resizeChild element (or null).",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "this"
+ "desc" : ""
}
]
},
{
- "name" : "removeClass",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Removes one or more CSS classes from the element.",
- "sig" : "(className)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "className",
- "type" : "String/Array",
- "desc" : "The CSS class to remove, or an array of classes",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "removeListener",
+ "name" : "on",
"type" : "function",
- "desc" : "Removes an event handler from this element",
- "sig" : "(eventName, fn, scope)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "the type of event to remove",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "fn",
+ "name" : "handler",
"type" : "Function",
- "desc" : "the method the event invokes",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
"name" : "scope",
- "type" : "Function",
- "desc" : "(needed for svg fake listeners)",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "repaint",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Forces the browser to repaint this element",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "replace",
- "type" : "function",
- "desc" : "Replaces the passed element with this element",
- "sig" : "(el)",
- "static" : false,
- "memberOf" : "Roo.Element",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The element to replace",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "replaceClass",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Replaces a CSS class on the element with another. If the old name does not exist, the new name will simply be added.",
- "sig" : "(oldClassName, newClassName)",
- "static" : false,
- "memberOf" : "Roo.Element",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "oldClassName",
- "type" : "String",
- "desc" : "The CSS class to replace",
- "isOptional" : false
- },
- {
- "name" : "newClassName",
- "type" : "String",
- "desc" : "The replacement CSS class",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "scroll",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Scrolls this element the specified direction. Does bounds checking to make sure the scroll is\nwithin this element's scrollable range.",
- "sig" : "(direction, distance, animate)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "direction",
+ "name" : "eventName",
"type" : "String",
- "desc" : "Possible values are: \"l\",\"left\" - \"r\",\"right\" - \"t\",\"top\",\"up\" - \"b\",\"bottom\",\"down\".",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "distance",
- "type" : "Number",
- "desc" : "How far to scroll the element in pixels",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) true for the default animation or a standard Element animation config object",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "Returns true if a scroll was triggered or false if the element\nwas scrolled as far as it could go."
- }
- ]
+ "returns" : []
},
{
- "name" : "scrollIntoView",
+ "name" : "resizeTo",
"type" : "function",
- "desc" : "Scrolls this element into view within the passed container.",
- "sig" : "(container, hscroll)",
+ "desc" : "Perform a manual resize",
+ "sig" : "(width, height)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The container element to scroll (defaults to document.body)",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "hscroll",
- "type" : "Boolean",
- "desc" : "(optional) False to disable horizontal scroll (defaults to true)",
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "scrollTo",
+ "name" : "un",
"type" : "function",
- "desc" : "Scrolls this element the specified scroll point. It does NOT do bounds checking so if you scroll to a weird value it will try to do it. For auto bounds checking, use scroll().",
- "sig" : "(side, value, animate)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "side",
+ "name" : "eventName",
"type" : "String",
- "desc" : "Either \"left\" for scrollLeft values or \"top\" for scrollTop values.",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "value",
- "type" : "Number",
- "desc" : "The new scroll value",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) true for the default animation or a standard Element animation config object",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Element",
- "desc" : "this"
- }
- ]
- },
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.Shadow" : {
+ "props" : [
{
- "name" : "select",
- "type" : "function",
- "desc" : "Creates a {@link Roo.CompositeElement} for child nodes based on the passed CSS selector (the selector should not contain an id).",
- "sig" : "(selector, unique)",
- "static" : false,
- "memberOf" : "Roo.Element",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "selector",
- "type" : "String",
- "desc" : "The CSS selector",
- "isOptional" : false
- },
- {
- "name" : "unique",
- "type" : "Boolean",
- "desc" : "(optional) True to create a unique Roo.Element for each child (defaults to false, which creates a single shared flyweight object)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "CompositeElement/CompositeElementLite",
- "desc" : "The composite element"
- }
- ]
+ "name" : "mode",
+ "type" : "String",
+ "desc" : "The shadow display mode. Supports the following options:<br />\nsides: Shadow displays on both sides and bottom only<br />\nframe: Shadow displays equally on all four sides<br />\ndrop: Traditional bottom-right drop shadow (default)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "set",
+ "name" : "offset",
+ "type" : "String",
+ "desc" : "The number of pixels to offset the shadow from the element (defaults to 4)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "hide",
"type" : "function",
- "desc" : "Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function)",
- "sig" : "(o, useSet)",
+ "desc" : "Hides this shadow",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Object",
- "desc" : "The object with the attributes",
- "isOptional" : false
- },
- {
- "name" : "useSet",
- "type" : "Boolean",
- "desc" : "(optional) false to override the default setAttribute to use expandos.",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "setBottom",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Sets the element's CSS bottom style.",
- "sig" : "(bottom)",
+ "desc" : "Returns true if the shadow is visible, else false",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "bottom",
- "type" : "String",
- "desc" : "The bottom CSS property value",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "setBounds",
+ "name" : "realign",
"type" : "function",
- "desc" : "Sets the element's position and size in one shot. If animation is true then width, height, x and y will be animated concurrently.",
- "sig" : "(x, y, width, height, animate)",
+ "desc" : "Direct alignment when values are already available. Show must be called at least once before\ncalling this method to ensure it is initialized.",
+ "sig" : "(left, top, width, height)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "x",
+ "name" : "left",
"type" : "Number",
- "desc" : "X value for new position (coordinates are page-based)",
+ "desc" : "The target element left position",
"isOptional" : false
},
{
- "name" : "y",
+ "name" : "top",
"type" : "Number",
- "desc" : "Y value for new position (coordinates are page-based)",
+ "desc" : "The target element top position",
"isOptional" : false
},
{
"name" : "width",
"type" : "Number",
- "desc" : "The new width",
+ "desc" : "The target element width",
"isOptional" : false
},
{
"name" : "height",
"type" : "Number",
- "desc" : "The new height",
- "isOptional" : false
- },
- {
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) true for the default animation or a standard Element animation config object",
+ "desc" : "The target element height",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "setBox",
+ "name" : "setZIndex",
"type" : "function",
- "desc" : "Sets the element's box. Use getBox() on another element to get a box obj. If animate is true then width, height, x and y will be animated concurrently.",
- "sig" : "(box, adjust, animate)",
+ "desc" : "Adjust the z-index of this shadow",
+ "sig" : "(zindex)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "box",
- "type" : "Object",
- "desc" : "The box to fill {x, y, width, height}",
- "isOptional" : false
- },
- {
- "name" : "adjust",
- "type" : "Boolean",
- "desc" : "(optional) Whether to adjust for box-model issues automatically",
- "isOptional" : false
- },
- {
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) true for the default animation or a standard Element animation config object",
+ "name" : "zindex",
+ "type" : "Number",
+ "desc" : "The new z-index",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "setDisplayed",
+ "name" : "show",
"type" : "function",
- "desc" : "Sets the CSS display property. Uses originalDisplay if the specified value is a boolean true.",
- "sig" : "(value)",
+ "desc" : "Displays the shadow under the target element",
+ "sig" : "(targetEl)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Boolean",
- "desc" : "Boolean value to display the element using its default display, or a string to set the display directly",
+ "name" : "targetEl",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id or element under which the shadow should display",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.SplitBar" : {
+ "props" : [
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforeresize",
+ "type" : "function",
+ "desc" : "Fires before the splitter is dragged",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "name" : "this",
+ "type" : "Roo.SplitBar",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "setHeight",
+ "name" : "moved",
"type" : "function",
- "desc" : "Set the height of the element",
- "sig" : "(height, animate)",
- "static" : false,
- "memberOf" : "Roo.Element",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the splitter is moved",
+ "sig" : "function (_self, newSize)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "height",
- "type" : "Number",
- "desc" : "The new height",
+ "name" : "this",
+ "type" : "Roo.SplitBar",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) true for the default animation or a standard Element animation config object",
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "the new width or height",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "resize",
+ "type" : "function",
+ "desc" : "Fires when the splitter is moved (alias for {@link #event-moved})",
+ "sig" : "function (_self, newSize)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "name" : "this",
+ "type" : "Roo.SplitBar",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "the new width or height",
+ "isOptional" : false
}
- ]
- },
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
{
- "name" : "setLeft",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Sets the element's left position directly using CSS style (instead of {@link #setX}).",
- "sig" : "(left)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "left",
- "type" : "String",
- "desc" : "The left CSS property value",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "setLeftTop",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Quick set left and top adding default units",
- "sig" : "(left, top)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "left",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The left CSS property value",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "top",
- "type" : "String",
- "desc" : "The top CSS property value",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "setLocation",
+ "name" : "capture",
"type" : "function",
- "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
- "sig" : "(x, y, animate)",
- "static" : false,
- "memberOf" : "Roo.Element",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "x",
- "type" : "Number",
- "desc" : "X value for new position (coordinates are page-based)",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "y",
- "type" : "Number",
- "desc" : "Y value for new position (coordinates are page-based)",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
"isOptional" : false
},
{
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) True for the default animation, or a standard Element animation config object",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "setOpacity",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Set the opacity of the element",
- "sig" : "(opacity, animate)",
+ "desc" : "Destroy this splitbar.",
+ "sig" : "(removeEl)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "opacity",
- "type" : "Float",
- "desc" : "The new opacity. 0 = transparent, .5 = 50% visibile, 1 = fully visible, etc",
- "isOptional" : false
- },
- {
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) true for the default animation or a standard Element animation config object",
+ "name" : "removeEl",
+ "type" : "Boolean",
+ "desc" : "True to remove the element",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "setPositioning",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Set positioning with an object returned by getPositioning().",
- "sig" : "(posCfg)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "posCfg",
- "type" : "Object",
+ "name" : "eventName",
+ "type" : "String",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "setRegion",
+ "name" : "getAdapter",
"type" : "function",
- "desc" : "Sets the element's position and size the the specified region. If animation is true then width, height, x and y will be animated concurrently.",
- "sig" : "(region, animate)",
+ "desc" : "Get the adapter this SplitBar uses",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "region",
- "type" : "Roo.lib.Region",
- "desc" : "The region to fill",
- "isOptional" : false
- },
- {
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) true for the default animation or a standard Element animation config object",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "type" : "",
+ "desc" : "The adapter object"
}
]
},
{
- "name" : "setRight",
+ "name" : "getMaximumSize",
"type" : "function",
- "desc" : "Sets the element's CSS right style.",
- "sig" : "(right)",
+ "desc" : "Gets the maximum size for the resizing element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "right",
- "type" : "String",
- "desc" : "The right CSS property value",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "type" : "Number",
+ "desc" : "The maximum size"
}
]
},
{
- "name" : "setSize",
+ "name" : "getMinimumSize",
"type" : "function",
- "desc" : "Set the size of the element. If animation is true, both width an height will be animated concurrently.",
- "sig" : "(width, height, animate)",
+ "desc" : "Gets the minimum size for the resizing element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The new width",
- "isOptional" : false
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "The new height",
- "isOptional" : false
- },
- {
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) true for the default animation or a standard Element animation config object",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "type" : "Number",
+ "desc" : "The minimum size"
}
]
},
{
- "name" : "setStyle",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Wrapper for setting style properties, also takes single object parameter of multiple styles.",
- "sig" : "(property, value)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "property",
- "type" : "String/Object",
- "desc" : "The style property to be set, or an object of multiple styles.",
- "isOptional" : false
- },
- {
- "name" : "value",
+ "name" : "eventName",
"type" : "String",
- "desc" : "(optional) The value to apply to the given property, or null if an object was passed.",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "setTop",
+ "name" : "on",
"type" : "function",
- "desc" : "Sets the element's top position directly using CSS style (instead of {@link #setY}).",
- "sig" : "(top)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "top",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The top CSS property value",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "setVisibilityMode",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Sets the element's visibility mode. When setVisible() is called it\nwill use this to determine whether to set the visibility or the display property.",
- "sig" : "(visMode)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "visMode",
- "type" : "",
- "desc" : "Element.VISIBILITY or Element.DISPLAY",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "setVisible",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Sets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use\nthe display property to hide the element, otherwise it uses visibility. The default is to hide and show using the visibility property.",
- "sig" : "(visible, animate)",
- "static" : false,
- "memberOf" : "Roo.Element",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "Whether the element is visible",
- "isOptional" : false
- },
- {
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) True for the default animation, or a standard Element animation config object",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "setWidth",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Set the width of the element",
- "sig" : "(width, animate)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "width",
- "type" : "Number",
- "desc" : "The new width",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) true for the default animation or a standard Element animation config object",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "setX",
+ "name" : "setAdapter",
"type" : "function",
- "desc" : "Sets the X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
- "sig" : "(The, animate)",
+ "desc" : "Set the adapter this SplitBar uses",
+ "sig" : "(adapter)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "The",
- "type" : "Number",
- "desc" : "X position of the element",
- "isOptional" : false
- },
- {
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) True for the default animation, or a standard Element animation config object",
+ "name" : "adapter",
+ "type" : "Object",
+ "desc" : "A SplitBar adapter object",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "setXY",
+ "name" : "setCurrentSize",
"type" : "function",
- "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
- "sig" : "(pos, animate)",
+ "desc" : "Sets the initialize size for the resizing element",
+ "sig" : "(size)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "pos",
- "type" : "Array",
- "desc" : "Contains X & Y [x, y] values for new position (coordinates are page-based)",
- "isOptional" : false
- },
- {
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) True for the default animation, or a standard Element animation config object",
+ "name" : "size",
+ "type" : "Number",
+ "desc" : "The initial size",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "setY",
+ "name" : "setMaximumSize",
"type" : "function",
- "desc" : "Sets the Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
- "sig" : "(The, animate)",
+ "desc" : "Sets the maximum size for the resizing element",
+ "sig" : "(maxSize)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "The",
+ "name" : "maxSize",
"type" : "Number",
- "desc" : "Y position of the element",
- "isOptional" : false
- },
- {
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) True for the default animation, or a standard Element animation config object",
+ "desc" : "The maximum size",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "setZIndex",
+ "name" : "setMinimumSize",
"type" : "function",
- "desc" : "Sets the z-index of this layer and adjusts any shadow and shim z-indexes. The layer z-index is automatically\nincremented by two more than the value passed in so that it always shows above any shadow or shim (the shadow\nelement, if any, will be assigned z-index + 1, and the shim element, if any, will be assigned the unmodified z-index).",
- "sig" : "(zindex)",
+ "desc" : "Sets the minimum size for the resizing element",
+ "sig" : "(minSize)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "zindex",
+ "name" : "minSize",
"type" : "Number",
- "desc" : "The new z-index to set",
+ "desc" : "The minimum size",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "this",
- "desc" : "The Layer"
- }
- ]
+ "returns" : []
},
{
- "name" : "show",
+ "name" : "un",
"type" : "function",
- "desc" : "Show this element - Uses display mode to determine whether to use \"display\" or \"visibility\". See {@link #setVisible}.",
- "sig" : "(animate)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) true for the default animation or a standard Element animation config object",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "swallowEvent",
- "type" : "function",
- "desc" : "Stops the specified event from bubbling and optionally prevents the default action",
- "sig" : "(eventName, preventDefault)",
- "static" : false,
- "memberOf" : "Roo.Element",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "(optional) true to prevent the default action too",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "toggle",
- "type" : "function",
- "desc" : "Toggles the element's visibility or display, depending on visibility mode.",
- "sig" : "(animate)",
- "static" : false,
- "memberOf" : "Roo.Element",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "animate",
- "type" : "Boolean/Object",
- "desc" : "(optional) True for the default animation, or a standard Element animation config object",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
- },
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.SplitBar.AbsoluteLayoutAdapter" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "toggleClass",
+ "name" : "getElementSize",
"type" : "function",
- "desc" : "Toggles the specified CSS class on this element (removes it if it already exists, otherwise adds it).",
- "sig" : "(className)",
+ "desc" : "Called before drag operations to get the current size of the resizing element.",
+ "sig" : "(s)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.SplitBar.BasicLayoutAdapter",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "className",
- "type" : "String",
- "desc" : "The CSS class to toggle",
+ "name" : "s",
+ "type" : "Roo.SplitBar",
+ "desc" : "The SplitBar using this adapter",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "translatePoints",
+ "name" : "setElementSize",
"type" : "function",
- "desc" : "Translates the passed page coordinates into left/top css values for this element",
- "sig" : "(x, y)",
+ "desc" : "Called after drag operations to set the size of the resizing element.",
+ "sig" : "(s, newSize, onComplete)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "Roo.SplitBar.BasicLayoutAdapter",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "x",
- "type" : "Number/Array",
- "desc" : "The page x or an array containing [x, y]",
+ "name" : "s",
+ "type" : "Roo.SplitBar",
+ "desc" : "The SplitBar using this adapter",
"isOptional" : false
},
{
- "name" : "y",
+ "name" : "newSize",
"type" : "Number",
- "desc" : "The page y",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "An object with left and top properties. e.g. {left: (value), top: (value)}"
- }
- ]
- },
- {
- "name" : "un",
- "type" : "function",
- "desc" : "Removes an event handler from this element (shorthand for removeListener)",
- "sig" : "(eventName, fn)",
- "static" : false,
- "memberOf" : "Roo.Element",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "the type of event to remove",
+ "desc" : "The new size to set",
"isOptional" : false
},
{
- "name" : "fn",
+ "name" : "onComplete",
"type" : "Function",
- "desc" : "the method the event invokes",
+ "desc" : "A function to be invoked when resizing is complete",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "unclip",
- "type" : "function",
- "desc" : "Return clipping (overflow) to original clipping before clip() was called",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Element",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "unmask",
- "type" : "function",
- "desc" : "Removes a previously applied mask. If removeEl is true the mask overlay is destroyed, otherwise\nit is cached for reuse.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Element",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
"returns" : []
- },
- {
- "name" : "unselectable",
- "type" : "function",
- "desc" : "Disables text selection for this element (normalized across browsers)",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Element",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.SplitBar.BasicLayoutAdapter" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "up",
+ "name" : "getElementSize",
"type" : "function",
- "desc" : "Walks up the dom looking for a parent node that matches the passed simple selector (e.g. div.some-class or span:first-child).\nThis is a shortcut for findParentNode() that always returns an Roo.Element.",
- "sig" : "(selector, maxDepth)",
+ "desc" : "Called before drag operations to get the current size of the resizing element.",
+ "sig" : "(s)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "selector",
- "type" : "String",
- "desc" : "The simple selector to test",
- "isOptional" : false
- },
- {
- "name" : "maxDepth",
- "type" : "Number/String/HTMLElement/Element",
- "desc" : "(optional) The max depth to\n search as a number or element (defaults to 10 || document.body)",
+ "name" : "s",
+ "type" : "Roo.SplitBar",
+ "desc" : "The SplitBar using this adapter",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The matching DOM node (or null if no match was found)"
- }
- ]
+ "returns" : []
},
{
- "name" : "update",
+ "name" : "setElementSize",
"type" : "function",
- "desc" : "Update the innerHTML of this element, optionally searching for and processing scripts",
- "sig" : "(html, loadScripts, callback)",
+ "desc" : "Called after drag operations to set the size of the resizing element.",
+ "sig" : "(s, newSize, onComplete)",
"static" : false,
- "memberOf" : "Roo.Element",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "html",
- "type" : "String",
- "desc" : "The new HTML",
+ "name" : "s",
+ "type" : "Roo.SplitBar",
+ "desc" : "The SplitBar using this adapter",
"isOptional" : false
},
{
- "name" : "loadScripts",
- "type" : "Boolean",
- "desc" : "(optional) true to look for and process scripts",
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new size to set",
"isOptional" : false
},
{
- "name" : "callback",
+ "name" : "onComplete",
"type" : "Function",
- "desc" : "For async script loading you can be noticed when the update completes",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "wrap",
- "type" : "function",
- "desc" : "Creates and wraps this element with another element",
- "sig" : "(config, returnDom)",
- "static" : false,
- "memberOf" : "Roo.Element",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "config",
- "type" : "Object",
- "desc" : "(optional) DomHelper element config object for the wrapper element or null for an empty div",
- "isOptional" : false
- },
- {
- "name" : "returnDom",
- "type" : "Boolean",
- "desc" : "(optional) True to return the raw DOM element instead of Roo.Element",
+ "desc" : "A function to be invoked when resizing is complete",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "HTMLElement/Element",
- "desc" : "The newly created wrapper element"
- }
- ]
+ "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
+ "implementations" : [
+ "Roo.SplitBar.AbsoluteLayoutAdapter"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.LayoutDialog" : {
+ "Roo.SplitButton" : {
"props" : [
{
- "name" : "animateTarget",
- "type" : "String/Element",
- "desc" : "Id or element from which the dialog should animate while opening\n(defaults to null with no animation)",
- "memberOf" : "Roo.BasicDialog",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoCreate",
- "type" : "Boolean/DomHelper",
- "desc" : "True to auto create from scratch, or using a DomHelper Object (defaults to false)",
- "memberOf" : "Roo.BasicDialog",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoScroll",
- "type" : "Boolean",
- "desc" : "True to allow the dialog body contents to overflow and display scrollbars (defaults to false)",
- "memberOf" : "Roo.BasicDialog",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoTabs",
- "type" : "Boolean",
- "desc" : "If true, all elements with class 'x-dlg-tab' will get automatically converted to tabs (defaults to false)",
- "memberOf" : "Roo.BasicDialog",
+ "name" : "arrowHandler",
+ "type" : "Function",
+ "desc" : "A function called when the arrow button is clicked (can be used instead of click event)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "buttonAlign",
+ "name" : "arrowTooltip",
"type" : "String",
- "desc" : "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"right\")",
- "memberOf" : "Roo.BasicDialog",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "buttons",
- "type" : "Array",
- "desc" : "Array of buttons",
- "memberOf" : "Roo.BasicDialog",
+ "desc" : "The title attribute of the arrow",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "buttons[]",
- "type" : "Roo.Button",
- "desc" : "Bottom buttons..",
- "memberOf" : "",
+ "name" : "clickEvent",
+ "type" : "String",
+ "desc" : "The type of event to map to the button's event handler (defaults to 'click')",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "center",
- "type" : "Roo.LayoutRegion",
- "desc" : "",
- "memberOf" : "",
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "A CSS class to apply to the button's main element.",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "closable",
+ "name" : "disabled",
"type" : "Boolean",
- "desc" : "False to remove the built-in top-right corner close button (defaults to true)",
- "memberOf" : "Roo.BasicDialog",
+ "desc" : "True to start disabled (defaults to false)",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "collapsible",
+ "name" : "enableToggle",
"type" : "Boolean",
- "desc" : "False to remove the built-in top-right corner collapse button (defaults to true)",
- "memberOf" : "Roo.BasicDialog",
+ "desc" : "True to enable pressed/not pressed toggling (defaults to false)",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "constraintoviewport",
+ "name" : "handleMouseEvents",
"type" : "Boolean",
- "desc" : "True to keep the dialog constrained within the visible viewport boundaries (defaults to true)",
- "memberOf" : "Roo.BasicDialog",
+ "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "draggable",
- "type" : "Boolean",
- "desc" : "False to disable dragging of the dialog within the viewport (defaults to true)",
- "memberOf" : "Roo.BasicDialog",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "A function called when the button is clicked (can be used instead of click event)",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "east",
- "type" : "Roo.LayoutRegion",
- "desc" : "",
- "memberOf" : "",
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "True to start hidden (defaults to false)",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "fixedcenter",
- "type" : "Boolean",
- "desc" : "True to ensure that anytime the dialog is shown or resized it gets centered (defaults to false)",
- "memberOf" : "Roo.BasicDialog",
+ "name" : "icon",
+ "type" : "String",
+ "desc" : "The path to an image to display in the button (the image will be set as the background-image\nCSS property of the button by default, so if you want a mixed icon/text button, set cls:\"x-btn-text-icon\")",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "Height of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.",
- "memberOf" : "Roo.BasicDialog",
+ "name" : "iconCls",
+ "type" : "String",
+ "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "minButtonWidth",
- "type" : "Number",
- "desc" : "Minimum width of all dialog buttons (defaults to 75)",
- "memberOf" : "Roo.BasicDialog",
+ "name" : "menu",
+ "type" : "Roo.menu.Menu",
+ "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "minHeight",
- "type" : "Number",
- "desc" : "The minimum allowable height for a resizable dialog (defaults to 80)",
- "memberOf" : "Roo.BasicDialog",
+ "name" : "menuAlign",
+ "type" : "String",
+ "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
"name" : "minWidth",
"type" : "Number",
- "desc" : "The minimum allowable width for a resizable dialog (defaults to 200)",
- "memberOf" : "Roo.BasicDialog",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "modal",
- "type" : "Boolean",
- "desc" : "True to show the dialog modally, preventing user interaction with the rest of the page (defaults to false)",
- "memberOf" : "Roo.BasicDialog",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "north",
- "type" : "Roo.LayoutRegion",
- "desc" : "",
- "memberOf" : "",
+ "desc" : "The minimum width for this button (used to give a set of buttons a common width)",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "proxyDrag",
+ "name" : "pressed",
"type" : "Boolean",
- "desc" : "True to drag a lightweight proxy element rather than the dialog itself, used when\ndraggable = true (defaults to false)",
- "memberOf" : "Roo.BasicDialog",
+ "desc" : "True to start pressed (only if enableToggle = true)",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "resizable",
- "type" : "Boolean",
- "desc" : "False to disable manual dialog resizing (defaults to true)",
- "memberOf" : "Roo.BasicDialog",
+ "name" : "renderTo",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The element to append the button to",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "resizeHandles",
- "type" : "String",
- "desc" : "Which resize handles to display - see the {@link Roo.Resizable} handles config\nproperty for valid values (defaults to 'all')",
- "memberOf" : "Roo.BasicDialog",
+ "name" : "repeat",
+ "type" : "Boolean/Object",
+ "desc" : "True to repeat fire the click event while the mouse is down. This can also be\n an {@link Roo.util.ClickRepeater} config object (defaults to false).",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "shadow",
- "type" : "Boolean/String",
- "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right\nshadow (defaults to false)",
- "memberOf" : "Roo.BasicDialog",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "The scope of the handler",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "shadowOffset",
+ "name" : "tabIndex",
"type" : "Number",
- "desc" : "The number of pixels to offset the shadow if displayed (defaults to 5)",
- "memberOf" : "Roo.BasicDialog",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "shim",
- "type" : "Boolean",
- "desc" : "True to create an iframe shim that prevents selects from showing through (defaults to false)",
- "memberOf" : "Roo.BasicDialog",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "south",
- "type" : "Roo.LayoutRegion",
- "desc" : "",
- "memberOf" : "",
+ "desc" : "The DOM tabIndex for this button (defaults to undefined)",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "syncHeightBeforeShow",
- "type" : "Boolean",
- "desc" : "True to cause the dimensions to be recalculated before the dialog is shown (defaults to false)",
- "memberOf" : "Roo.BasicDialog",
+ "name" : "template",
+ "type" : "Roo.Template",
+ "desc" : "An {@link Roo.Template} with which to create the Button's main element. This Template must\ncontain numeric substitution parameter 0 if it is to display the tRoo property. Changing the template could\nrequire code modifications if required elements (e.g. a button) aren't present.",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tabTag",
+ "name" : "text",
"type" : "String",
- "desc" : "The tag name of tab elements, used when autoTabs = true (defaults to 'div')",
- "memberOf" : "Roo.BasicDialog",
+ "desc" : "The button text",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "title",
+ "name" : "toggleGroup",
"type" : "String",
- "desc" : "Default text to display in the title bar (defaults to null)",
- "memberOf" : "Roo.BasicDialog",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "west",
- "type" : "Roo.LayoutRegion",
- "desc" : "",
- "memberOf" : "",
+ "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "Width of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.",
- "memberOf" : "Roo.BasicDialog",
+ "name" : "tooltip",
+ "type" : "String/Object",
+ "desc" : "The tooltip for the button - can be a string or QuickTips config object",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "x",
- "type" : "Number",
- "desc" : "The default left page coordinate of the dialog (defaults to center screen)",
- "memberOf" : "Roo.BasicDialog",
+ "name" : "tooltipType",
+ "type" : "String",
+ "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "y",
- "type" : "Number",
- "desc" : "The default top page coordinate of the dialog (defaults to center screen)",
- "memberOf" : "Roo.BasicDialog",
+ "name" : "type",
+ "type" : "String",
+ "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
{
- "name" : "beforehide",
+ "name" : "arrowclick",
"type" : "function",
- "desc" : "Fires before this dialog is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicDialog",
+ "desc" : "Fires when this button's arrow is clicked",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.BasicDialog",
+ "type" : "SplitButton",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before this dialog is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicDialog",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.BasicDialog",
- "desc" : "",
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "The click event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "hide",
+ "name" : "click",
"type" : "function",
- "desc" : "Fires when this dialog is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicDialog",
+ "desc" : "Fires when this button is clicked",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.BasicDialog",
+ "type" : "Button",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "The click event",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "keydown",
+ "name" : "mouseout",
"type" : "function",
- "desc" : "Fires when a key is pressed",
+ "desc" : "Fires when the mouse exits the button",
"sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.BasicDialog",
+ "memberOf" : "Roo.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.BasicDialog",
+ "type" : "Button",
"desc" : "",
"isOptional" : false
},
{
"name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "type" : "Event",
+ "desc" : "The event object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "move",
+ "name" : "mouseover",
"type" : "function",
- "desc" : "Fires when this dialog is moved by the user.",
- "sig" : "function (_self, x, y)\n{\n\n}",
- "memberOf" : "Roo.BasicDialog",
+ "desc" : "Fires when the mouse hovers over the button",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.BasicDialog",
+ "type" : "Button",
"desc" : "",
"isOptional" : false
},
{
- "name" : "x",
- "type" : "Number",
- "desc" : "The new page X",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new page Y",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resize",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires when this dialog is resized by the user.",
- "sig" : "function (_self, width, height)\n{\n\n}",
- "memberOf" : "Roo.BasicDialog",
+ "desc" : "Fires when the button is rendered",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.BasicDialog",
+ "type" : "Button",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The new width",
- "isOptional" : false
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "The new height",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "toggle",
"type" : "function",
- "desc" : "Fires when this dialog is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicDialog",
+ "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)",
+ "sig" : "function (_self, pressed)\n{\n\n}",
+ "memberOf" : "Roo.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.BasicDialog",
+ "type" : "Button",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "pressed",
+ "type" : "Boolean",
"desc" : "",
"isOptional" : false
}
],
"methods" : [
{
- "name" : "addButton",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Adds a button to the footer section of the dialog.",
- "sig" : "(config, handler, scope)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.BasicDialog",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "config",
- "type" : "String/Object",
- "desc" : "A string becomes the button text, an object can either be a Button config\nobject or a valid Roo.DomHelper element config",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The function called when the button is clicked",
- "isOptional" : false
- },
- {
- "name" : "scope",
+ "name" : "object",
"type" : "Object",
- "desc" : "(optional) The scope of the handler function (accepts position as a property)",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Button",
- "desc" : "The new button"
- }
- ]
+ "returns" : []
},
{
- "name" : "addEvents",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
"type" : "Object",
- "desc" : "The object with the events defined",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addKeyListener",
+ "name" : "capture",
"type" : "function",
- "desc" : "Adds a key listener for when this dialog is displayed. This allows you to hook in a function that will be\nexecuted in response to a particular key being pressed while the dialog is active.",
- "sig" : "(key, fn, scope)",
- "static" : false,
- "memberOf" : "Roo.BasicDialog",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "key",
- "type" : "Number/Array/Object",
- "desc" : "Either the numeric key code, array of key codes or an object with the following options:\n {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope of the function",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.BasicDialog",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "addListener",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Destroys this Button and removes any listeners.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "addxtype",
+ "name" : "disable",
"type" : "function",
- "desc" : "Add an xtype element (actually adds to the layout.)",
+ "desc" : "Disable this button",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "xdata xtype object data."
- }
- ]
+ "returns" : []
},
{
- "name" : "alignTo",
+ "name" : "enable",
"type" : "function",
- "desc" : "Aligns the dialog to the specified element",
- "sig" : "(element, position, offsets)",
+ "desc" : "Enable this button",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BasicDialog",
+ "memberOf" : "Roo.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "element",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The element to align to.",
- "isOptional" : false
- },
- {
- "name" : "position",
- "type" : "String",
- "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details).",
- "isOptional" : false
- },
- {
- "name" : "offsets",
- "type" : "Array",
- "desc" : "(optional) Offset the positioning by [x, y]",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.BasicDialog",
- "desc" : "this"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "anchorTo",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Anchors an element to another element and realigns it when the window is resized.",
- "sig" : "(element, position, offsets, monitorScroll)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.BasicDialog",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "element",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The element to align to.",
- "isOptional" : false
- },
- {
- "name" : "position",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details)",
- "isOptional" : false
- },
- {
- "name" : "offsets",
- "type" : "Array",
- "desc" : "(optional) Offset the positioning by [x, y]",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "monitorScroll",
- "type" : "Boolean/Number",
- "desc" : "(optional) true to monitor body scroll and reposition. If this parameter\nis a number, it is used as the buffer delay (defaults to 50ms).",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.BasicDialog",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "beginUpdate",
+ "name" : "focus",
"type" : "function",
- "desc" : "Begins an update of the layout <strike>and sets display to block and visibility to hidden</strike>. Use standard beginUpdate/endUpdate on the layout.",
+ "desc" : "Focus the button",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
- "deprecated" : "This has been deprecated: ",
+ "deprecated" : "",
"since" : "",
"see" : "",
"exceptions" : "",
"returns" : []
},
{
- "name" : "capture",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Returns the button's underlying element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Button",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "center",
+ "name" : "getText",
"type" : "function",
- "desc" : "Centers this dialog in the viewport",
+ "desc" : "Gets the text for this button",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BasicDialog",
+ "memberOf" : "Roo.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.BasicDialog",
- "desc" : "this"
+ "type" : "String",
+ "desc" : "The button text"
}
]
},
{
- "name" : "collapse",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Collapses the dialog to its minimized state (only the title bar is visible).\nEquivalent to the user clicking the collapse dialog button.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.BasicDialog",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "destroy",
+ "name" : "hide",
"type" : "function",
- "desc" : "Destroys this dialog and all its supporting elements (including any tabs, shim,\nshadow, proxy, mask, etc.) Also removes all event listeners.",
- "sig" : "(removeEl)",
+ "desc" : "Hide this button",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BasicDialog",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "removeEl",
- "type" : "Boolean",
- "desc" : "(optional) true to remove the element from the DOM",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "endUpdate",
- "type" : "function",
- "desc" : "Ends update of the layout <strike>and resets display to none</strike>. Use standard beginUpdate/endUpdate on the layout.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "This has been deprecated: ",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expands a collapsed dialog back to its normal state. Equivalent to the user\nclicking the expand dialog button.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.BasicDialog",
+ "memberOf" : "Roo.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "on",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "focus",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Focuses the dialog. If a defaultButton is set, it will receive focus, otherwise the\ndialog itself will receive focus.",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BasicDialog",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "getEl",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Returns the element for this dialog",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.BasicDialog",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The underlying dialog Element"
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getLayout",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Get the BorderLayout for this dialog",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.BorderLayout",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getTabs",
- "type" : "function",
- "desc" : "Returns the TabPanel component (creates it if it doesn't exist).\nNote: If you wish to simply check for the existence of tabs without creating them,\ncheck for a null 'tabs' property.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.BasicDialog",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
{
- "name" : "",
- "type" : "Roo.TabPanel",
- "desc" : "The tabs component"
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "setArrowHandler",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Sets this button's arrow click handler",
+ "sig" : "(handler, scope)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The function to call when the arrow is clicked",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) Scope for the function passed above",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hide",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Hides the dialog.",
- "sig" : "(callback)",
+ "desc" : "Convenience function for boolean enable/disable",
+ "sig" : "(enabled)",
"static" : false,
- "memberOf" : "Roo.BasicDialog",
+ "memberOf" : "Roo.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "callback",
- "type" : "Function",
- "desc" : "(optional) Function to call when the dialog is hidden",
+ "name" : "enabled",
+ "type" : "Boolean",
+ "desc" : "True to enable, false to disable",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.BasicDialog",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "initTabs",
+ "name" : "setHandler",
"type" : "function",
- "desc" : "Reinitializes the tabs component, clearing out old tabs and finding new ones.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets this button's click handler",
+ "sig" : "(handler, scope)",
"static" : false,
- "memberOf" : "Roo.BasicDialog",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.TabPanel",
- "desc" : "The tabs component"
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The function to call when the button is clicked",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) Scope for the function passed above",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "isVisible",
+ "name" : "setPressed",
"type" : "function",
- "desc" : "Returns true if the dialog is visible",
- "sig" : "()\n{\n\n}",
+ "desc" : "Similar to toggle, but does not trigger event.",
+ "sig" : "(state)",
"static" : false,
- "memberOf" : "Roo.BasicDialog",
+ "memberOf" : "Roo.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
+ "name" : "state",
"type" : "Boolean",
- "desc" : ""
+ "desc" : "[required] Force a particular state",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "moveTo",
+ "name" : "setText",
"type" : "function",
- "desc" : "Moves the dialog's top-left corner to the specified point",
- "sig" : "(x, y)",
+ "desc" : "Sets this button's text",
+ "sig" : "(text)",
"static" : false,
- "memberOf" : "Roo.BasicDialog",
+ "memberOf" : "Roo.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "x",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "",
+ "name" : "text",
+ "type" : "String",
+ "desc" : "The button text",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.BasicDialog",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "on",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Convenience function for boolean show/hide",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "show",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Show this button",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "toggle",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.",
+ "sig" : "(state)",
+ "static" : false,
+ "memberOf" : "Roo.Button",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "(optional) Force a particular state",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "un",
"type" : "function",
- "desc" : "Removes a listener",
+ "desc" : "Removes a listener (shorthand for removeListener)",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
}
],
"returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.Toolbar.SplitButton"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.Template" : {
+ "props" : [
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "The HTML fragment or an array of fragments to join(\"\") or multiple arguments to join(\"\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "resizeTo",
+ "name" : "onLoad",
+ "type" : "Function",
+ "desc" : "Called after the template has been loaded and complied (usually from a remove source)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "url",
+ "type" : "String",
+ "desc" : "The Url to load the template from. beware if you are loading from a url, the data may not be ready if you use it instantly..\n it should be fixed so that template is observable...",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "append",
"type" : "function",
- "desc" : "Resizes the dialog.",
- "sig" : "(width, height)",
+ "desc" : "Applies the supplied values to the template and appends the new node(s) to el.",
+ "sig" : "(el, values, returnElement)",
"static" : false,
- "memberOf" : "Roo.BasicDialog",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "width",
- "type" : "Number",
- "desc" : "",
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The context element",
"isOptional" : false
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "",
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnElement",
+ "type" : "Boolean",
+ "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.BasicDialog",
- "desc" : "this"
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The new node or Element"
}
]
},
{
- "name" : "restoreState",
+ "name" : "apply",
"type" : "function",
- "desc" : "Restores the previous state of the dialog if Roo.state is configured.",
+ "desc" : "Alias for {@link #applyTemplate}",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BasicDialog",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.BasicDialog",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "setContentSize",
+ "name" : "applyTemplate",
"type" : "function",
- "desc" : "Resizes the dialog to fit the specified content size.",
- "sig" : "(width, height)",
+ "desc" : "Returns an HTML fragment of this template with the specified values applied.",
+ "sig" : "(values)",
"static" : false,
- "memberOf" : "Roo.BasicDialog",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "width",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "",
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.BasicDialog",
- "desc" : "this"
+ "type" : "String",
+ "desc" : "The HTML fragment"
}
]
},
{
- "name" : "setDefaultButton",
+ "name" : "compile",
"type" : "function",
- "desc" : "Sets the default button to be focused when the dialog is displayed.",
- "sig" : "(btn)",
+ "desc" : "Compiles the template into an internal function, eliminating the RegEx overhead.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BasicDialog",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "btn",
- "type" : "Roo.BasicDialog.Button",
- "desc" : "The button object returned by {@link #addButton}",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.BasicDialog",
+ "type" : "Roo.Template",
"desc" : "this"
}
]
},
{
- "name" : "setTitle",
+ "name" : "from",
"type" : "function",
- "desc" : "Sets the dialog title text",
- "sig" : "(text)",
+ "desc" : "Creates a template from the passed element's value (<i>display:none</i> textarea, preferred) or innerHTML.",
+ "sig" : "(el)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement",
+ "desc" : "A DOM element or its id",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "insertAfter",
+ "type" : "function",
+ "desc" : "Applies the supplied values to the template and inserts the new node(s) after el.",
+ "sig" : "(el, values, returnElement)",
"static" : false,
- "memberOf" : "Roo.BasicDialog",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "text",
- "type" : "String",
- "desc" : "The title text to display",
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The context element",
+ "isOptional" : false
+ },
+ {
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnElement",
+ "type" : "Boolean",
+ "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.BasicDialog",
- "desc" : "this"
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The new node or Element"
}
]
},
{
- "name" : "show",
+ "name" : "insertBefore",
"type" : "function",
- "desc" : "Shows the dialog.",
- "sig" : "(animateTarget)",
+ "desc" : "Applies the supplied values to the template and inserts the new node(s) before el.",
+ "sig" : "(el, values, returnElement)",
"static" : false,
- "memberOf" : "Roo.BasicDialog",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "animateTarget",
+ "name" : "el",
"type" : "String/HTMLElement/Roo.Element",
- "desc" : "(optional) Reset the animation target",
+ "desc" : "The context element",
+ "isOptional" : false
+ },
+ {
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnElement",
+ "type" : "Boolean",
+ "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.BasicDialog",
- "desc" : "this"
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The new node or Element"
}
]
},
{
- "name" : "toBack",
+ "name" : "insertFirst",
"type" : "function",
- "desc" : "Sends this dialog to the back (under) of any other visible dialogs",
- "sig" : "()\n{\n\n}",
+ "desc" : "Applies the supplied values to the template and inserts the new node(s) as the first child of el.",
+ "sig" : "(el, values, returnElement)",
"static" : false,
- "memberOf" : "Roo.BasicDialog",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The context element",
+ "isOptional" : false
+ },
+ {
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnElement",
+ "type" : "Boolean",
+ "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.BasicDialog",
- "desc" : "this"
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The new node or Element"
}
]
},
{
- "name" : "toFront",
+ "name" : "overwrite",
"type" : "function",
- "desc" : "Brings this dialog to the front of any other visible dialogs",
- "sig" : "()\n{\n\n}",
+ "desc" : "Applies the supplied values to the template and overwrites the content of el with the new node(s).",
+ "sig" : "(el, values, returnElement)",
"static" : false,
- "memberOf" : "Roo.BasicDialog",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The context element",
+ "isOptional" : false
+ },
+ {
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnElement",
+ "type" : "Boolean",
+ "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.BasicDialog",
- "desc" : "this"
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The new node or Element"
}
]
},
{
- "name" : "un",
+ "name" : "set",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Sets the HTML used as the template and optionally compiles it.",
+ "sig" : "(html, compile)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "html",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "compile",
+ "type" : "Boolean",
+ "desc" : "(optional) True to compile the template (defaults to undefined)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Template",
+ "desc" : "this"
+ }
+ ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [
- "Roo.ContentPanel",
- "Roo.GridPanel",
- "Roo.NestedLayoutPanel",
- "Roo.TreePanel"
+ "implementations" : [
+ "Roo.DomTemplate",
+ "Roo.MasterTemplate",
+ "Roo.XTemplate"
],
- "tree_parent" : [
- "builder",
- "none"
- ]
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.LayoutManager" : {
+ "Roo.Toolbar" : {
"props" : [
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id or element that will contain the toolbar",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "items",
+ "type" : "Array",
+ "desc" : "array of button configs or elements to add (will be converted to a MixedCollection)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "text",
+ "type" : "string",
+ "desc" : "",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
}
],
- "events" : [
+ "events" : [],
+ "methods" : [
{
- "name" : "layout",
+ "name" : "add",
"type" : "function",
- "desc" : "Fires when a layout is performed.",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Adds element(s) to the toolbar -- this function takes a variable number of \narguments of mixed type and adds them to the toolbar.",
+ "sig" : "(arg1, arg2)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.LayoutManager",
+ "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" : "regioncollapsed",
+ "name" : "addButton",
"type" : "function",
- "desc" : "Fires when a region is collapsed.",
- "sig" : "function (region)\n{\n\n}",
+ "desc" : "Adds a button (or buttons). See {@link Roo.Toolbar.Button} for more info on the config.",
+ "sig" : "(config)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The collapsed region",
+ "name" : "config",
+ "type" : "Object/Array",
+ "desc" : "A button config or array of configs",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "regionexpanded",
- "type" : "function",
- "desc" : "Fires when a region is expanded.",
- "sig" : "function (region)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "returns" : [
{
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The expanded region",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Toolbar.Button/Array",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "regionresized",
+ "name" : "addDom",
"type" : "function",
- "desc" : "Fires when the user resizes a region.",
- "sig" : "function (region, newSize)\n{\n\n}",
+ "desc" : "Adds a new element to the toolbar from the passed {@link Roo.DomHelper} config.",
+ "sig" : "(config)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The resized region",
- "isOptional" : false
- },
- {
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new size (width for east/west, height for north/south)",
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "methods" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Toolbar.Item",
+ "desc" : "The element's item"
+ }
+ ]
+ },
{
- "name" : "addEvents",
+ "name" : "addElement",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Adds any standard HTML element to the toolbar",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The element or id of the element to add",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Toolbar.Item",
+ "desc" : "The element's item"
+ }
+ ]
},
{
- "name" : "addListener",
+ "name" : "addField",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "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}.",
+ "sig" : "(field)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "field",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ToolbarItem",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "beginUpdate",
+ "name" : "addFill",
"type" : "function",
- "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls",
+ "desc" : "Adds a fill element that forces subsequent additions to the right side of the toolbar",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
- },
- {
- "name" : "capture",
- "type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
+ "returns" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Toolbar.Fill",
+ "desc" : "The fill item"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "endUpdate",
+ "name" : "addItem",
"type" : "function",
- "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
- "sig" : "(noLayout)",
+ "desc" : "Adds any Toolbar.Item or subclass",
+ "sig" : "(item)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "noLayout",
- "type" : "Boolean",
- "desc" : "true to disable a layout update",
+ "name" : "item",
+ "type" : "Roo.Toolbar.Item",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Toolbar.Item",
+ "desc" : "The item"
+ }
+ ]
},
{
- "name" : "fireEvent",
+ "name" : "addSeparator",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Adds a separator",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "Roo.Toolbar.Item",
+ "desc" : "The separator item"
}
]
},
{
- "name" : "getEl",
+ "name" : "addSpacer",
"type" : "function",
- "desc" : "Returns the Element this layout is bound to.",
+ "desc" : "Adds a spacer element",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : ""
+ "type" : "Roo.Toolbar.Spacer",
+ "desc" : "The spacer item"
}
]
},
{
- "name" : "getRegion",
+ "name" : "addText",
"type" : "function",
- "desc" : "Returns the specified region.",
- "sig" : "(target)",
+ "desc" : "Adds text to the toolbar",
+ "sig" : "(text)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "target",
+ "name" : "text",
"type" : "String",
- "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')",
+ "desc" : "The text to add",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.LayoutRegion",
- "desc" : ""
+ "type" : "Roo.Toolbar.Item",
+ "desc" : "The element's item"
}
]
},
{
- "name" : "getViewSize",
+ "name" : "addxtype",
"type" : "function",
- "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Add an Xtype element",
+ "sig" : "(xtype)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "xtype",
+ "type" : "Object",
+ "desc" : "Xtype Object",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
"type" : "Object",
- "desc" : "The size as an object {width: (the width), height: (the height)}"
+ "desc" : "created Object"
}
]
},
{
- "name" : "hasListener",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Returns the Element for this toolbar.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "Roo.Element",
+ "desc" : ""
}
]
},
{
- "name" : "isUpdating",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns true if this layout is currently being updated",
+ "desc" : "Hide the toolbar",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "on",
+ "name" : "insertButton",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Inserts any {@link Roo.Toolbar.Item}/{@link Roo.Toolbar.Button} at the specified index.",
+ "sig" : "(index, item)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index where the item is to be inserted",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "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" : "removeListener",
- "type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
+ "returns" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Toolbar.Button/Item",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "un",
+ "name" : "show",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Show the toolbar",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [
- "Roo.BorderLayout",
- "Roo.ReaderLayout"
+ "Roo.PagingToolbar"
+ ],
+ "tree_children" : [
+ "Roo.Toolbar.Item",
+ "Roo.Toolbar.Fill",
+ "Roo.Toolbar.Separator",
+ "Roo.Toolbar.Spacer",
+ "Roo.Toolbar.TextItem",
+ "Roo.Toolbar.Button",
+ "Roo.Toolbar.SplitButton",
+ "Roo.form.Field",
+ "Roo.form.Checkbox",
+ "Roo.form.ComboBox",
+ "Roo.form.ComboBoxArray",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.FCKeditor",
+ "Roo.form.GridField",
+ "Roo.form.Hidden",
+ "Roo.form.HtmlEditor",
+ "Roo.form.MonthField",
+ "Roo.form.NumberField",
+ "Roo.form.Radio",
+ "Roo.form.Select",
+ "Roo.form.Signature",
+ "Roo.form.TextArea",
+ "Roo.form.TextField",
+ "Roo.form.TriggerField"
],
- "tree_children" : [],
"tree_parent" : []
},
- "Roo.LayoutRegion" : {
+ "Roo.Toolbar.Button" : {
"props" : [
{
- "name" : "alwaysShowTabs",
- "type" : "Boolean",
- "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
- "memberOf" : "",
+ "name" : "clickEvent",
+ "type" : "String",
+ "desc" : "The type of event to map to the button's event handler (defaults to 'click')",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "animate",
- "type" : "Boolean",
- "desc" : "True to animate expand/collapse (defaults to false)",
- "memberOf" : "",
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "A CSS class to apply to the button's main element.",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "autoHide",
+ "name" : "disabled",
"type" : "Boolean",
- "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
- "memberOf" : "",
+ "desc" : "True to start disabled (defaults to false)",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "autoScroll",
+ "name" : "enableToggle",
"type" : "Boolean",
- "desc" : "True to enable overflow scrolling (defaults to false)",
- "memberOf" : "",
+ "desc" : "True to enable pressed/not pressed toggling (defaults to false)",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "closeOnTab",
+ "name" : "handleMouseEvents",
"type" : "Boolean",
- "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
- "memberOf" : "",
+ "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "cmargins",
- "type" : "Object",
- "desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})",
- "memberOf" : "",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "A function called when the button is clicked (can be used instead of click event)",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "collapsed",
+ "name" : "hidden",
"type" : "Boolean",
- "desc" : "True to set the initial display to collapsed (defaults to false)",
- "memberOf" : "",
+ "desc" : "True to start hidden (defaults to false)",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "collapsedTitle",
+ "name" : "icon",
"type" : "String",
- "desc" : "Optional string message to display in the collapsed block of a north or south region",
- "memberOf" : "",
+ "desc" : "The path to an image to display in the button (the image will be set as the background-image\nCSS property of the button by default, so if you want a mixed icon/text button, set cls:\"x-btn-text-icon\")",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "collapsible",
- "type" : "Boolean",
- "desc" : "False to disable collapsing (defaults to true)",
- "memberOf" : "",
+ "name" : "iconCls",
+ "type" : "String",
+ "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disableTabTips",
- "type" : "Boolean",
- "desc" : "True to disable tab tooltips",
- "memberOf" : "",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "floatable",
- "type" : "Boolean",
- "desc" : "False to disable floating (defaults to true)",
- "memberOf" : "",
+ "name" : "menu",
+ "type" : "Roo.menu.Menu",
+ "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "For North/South panels",
- "memberOf" : "",
+ "name" : "menuAlign",
+ "type" : "String",
+ "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "True to start the region hidden (defaults to false)",
- "memberOf" : "",
+ "name" : "minWidth",
+ "type" : "Number",
+ "desc" : "The minimum width for this button (used to give a set of buttons a common width)",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hideTabs",
+ "name" : "pressed",
"type" : "Boolean",
- "desc" : "True to hide the tab strip (defaults to false)",
- "memberOf" : "",
+ "desc" : "True to start pressed (only if enableToggle = true)",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hideWhenEmpty",
- "type" : "Boolean",
- "desc" : "True to hide the region when it has no panels",
- "memberOf" : "",
+ "name" : "renderTo",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The element to append the button to",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
+ "name" : "repeat",
+ "type" : "Boolean/Object",
+ "desc" : "True to repeat fire the click event while the mouse is down. This can also be\n an {@link Roo.util.ClickRepeater} config object (defaults to false).",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "margins",
+ "name" : "scope",
"type" : "Object",
- "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minTabWidth",
- "type" : "Number",
- "desc" : "The minimum tab width (defaults to 40)",
- "memberOf" : "",
+ "desc" : "The scope of the handler",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "preferredTabWidth",
+ "name" : "tabIndex",
"type" : "Number",
- "desc" : "The preferred tab width (defaults to 150)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "preservePanels",
- "type" : "Boolean",
- "desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "resizeTabs",
- "type" : "Boolean",
- "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "showPin",
- "type" : "Boolean",
- "desc" : "True to show a pin button",
- "memberOf" : "",
+ "desc" : "The DOM tabIndex for this button (defaults to undefined)",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "split",
- "type" : "Boolean",
- "desc" : "To show the splitter",
- "memberOf" : "",
+ "name" : "template",
+ "type" : "Roo.Template",
+ "desc" : "An {@link Roo.Template} with which to create the Button's main element. This Template must\ncontain numeric substitution parameter 0 if it is to display the tRoo property. Changing the template could\nrequire code modifications if required elements (e.g. a button) aren't present.",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tabPosition",
+ "name" : "text",
"type" : "String",
- "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom",
- "memberOf" : "",
+ "desc" : "The button text",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
- "optvals" : [
- "top",
- "bottom"
- ]
+ "optvals" : []
},
{
- "name" : "title",
+ "name" : "toggleGroup",
"type" : "String",
- "desc" : "The title for the region (overrides panel titles)",
- "memberOf" : "",
+ "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "titlebar",
- "type" : "Boolean",
- "desc" : "True to display a title bar (defaults to true)",
- "memberOf" : "",
+ "name" : "tooltip",
+ "type" : "String/Object",
+ "desc" : "The tooltip for the button - can be a string or QuickTips config object",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "toolbar",
- "type" : "Boolean",
- "desc" : "xtype configuration for a toolbar - shows on right of tabbar",
- "memberOf" : "",
+ "name" : "tooltipType",
+ "type" : "String",
+ "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "For East/West panels",
- "memberOf" : "",
+ "name" : "type",
+ "type" : "String",
+ "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
{
- "name" : "beforecollapse",
- "type" : "function",
- "desc" : "Fires when this region before collapse.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.LayoutRegion",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeremove",
+ "name" : "click",
"type" : "function",
- "desc" : "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument.",
- "sig" : "function (_self, panel, e)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires when this button is clicked",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Button",
"desc" : "",
"isOptional" : false
},
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel",
- "isOptional" : false
- },
{
"name" : "e",
- "type" : "Object",
- "desc" : "The cancel event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "collapsed",
- "type" : "function",
- "desc" : "Fires when this region is collapsed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.LayoutRegion",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "expanded",
- "type" : "function",
- "desc" : "Fires when this region is expanded.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.LayoutRegion",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "invalidated",
- "type" : "function",
- "desc" : "Fires when the layout for this region is changed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.LayoutRegion",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "panelactivated",
- "type" : "function",
- "desc" : "Fires when a panel is activated.",
- "sig" : "function (_self, panel)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.LayoutRegion",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The activated panel",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "paneladded",
- "type" : "function",
- "desc" : "Fires when a panel is added.",
- "sig" : "function (_self, panel)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.LayoutRegion",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel",
+ "type" : "EventObject",
+ "desc" : "The click event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "panelremoved",
+ "name" : "mouseout",
"type" : "function",
- "desc" : "Fires when a panel is removed.",
- "sig" : "function (_self, panel)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires when the mouse exits the button",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Button",
"desc" : "",
"isOptional" : false
},
{
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resized",
+ "name" : "mouseover",
"type" : "function",
- "desc" : "Fires when the user resizes this region.",
- "sig" : "function (_self, newSize)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires when the mouse hovers over the button",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Button",
"desc" : "",
"isOptional" : false
},
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new size (width for east/west, height for north/south)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "slidehide",
- "type" : "function",
- "desc" : "Fires when this region slides out of view.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.LayoutRegion",
- "desc" : "",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "slideshow",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires when this region is slid into view.",
+ "desc" : "Fires when the button is rendered",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Button",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "visibilitychange",
+ "name" : "toggle",
"type" : "function",
- "desc" : "Fires when this region is shown or hidden",
- "sig" : "function (_self, visibility)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)",
+ "sig" : "function (_self, pressed)\n{\n\n}",
+ "memberOf" : "Roo.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Button",
"desc" : "",
"isOptional" : false
},
{
- "name" : "visibility",
+ "name" : "pressed",
"type" : "Boolean",
- "desc" : "true or false",
+ "desc" : "",
"isOptional" : false
}
],
}
],
"methods" : [
- {
- "name" : "add",
- "type" : "function",
- "desc" : "Adds the passed ContentPanel(s) to this region.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "ContentPanel...",
- "desc" : "The ContentPanel(s) to add (you can pass more than one)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel added (if only one was added; null otherwise)"
- }
- ]
- },
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "collapse",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Collapses this region.",
- "sig" : "(skipAnim)",
+ "desc" : "Removes and destroys this button",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "skipAnim",
- "type" : "Boolean",
- "desc" : "(optional) true to collapse the element without animation (if animate is true)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "expand",
+ "name" : "disable",
"type" : "function",
- "desc" : "Expands this region if it was previously collapsed.",
- "sig" : "(e, skipAnim)",
+ "desc" : "Disables this item",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event that triggered the expand (or null if calling manually)",
- "isOptional" : false
- },
- {
- "name" : "skipAnim",
- "type" : "Boolean",
- "desc" : "(optional) true to expand the element without animation (if animate is true)",
- "isOptional" : false
- }
- ],
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enables this item",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
]
},
{
- "name" : "getActivePanel",
+ "name" : "focus",
"type" : "function",
- "desc" : "Get the active panel for this region.",
+ "desc" : "Focus the button",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The active panel or null"
- }
- ]
+ "returns" : []
},
{
"name" : "getEl",
"type" : "function",
- "desc" : "Returns the container element for this region.",
+ "desc" : "Returns the button's underlying element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Roo.Element",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getPanel",
- "type" : "function",
- "desc" : "Returns the panel specified or null if it's not in this region.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "Roo.BasicLayoutRegion",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : ""
+ "desc" : "The element"
}
]
},
{
- "name" : "getPosition",
+ "name" : "getText",
"type" : "function",
- "desc" : "Returns this regions position (north/south/east/west/center).",
+ "desc" : "Gets the text for this button",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "String",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getTabs",
- "type" : "function",
- "desc" : "Returns the TabPanel component used by this region",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.TabPanel",
- "desc" : ""
+ "desc" : "The button text"
}
]
},
}
]
},
- {
- "name" : "hasPanel",
- "type" : "function",
- "desc" : "Returns true if the panel is in this region.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "Roo.BasicLayoutRegion",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
- },
{
"name" : "hide",
"type" : "function",
- "desc" : "Hides this region.",
+ "desc" : "Hides this button",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"params" : [],
"returns" : []
},
- {
- "name" : "hidePanel",
- "type" : "function",
- "desc" : "Hides the tab for the specified panel.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this region is currently visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
- },
{
"name" : "on",
"type" : "function",
"returns" : []
},
{
- "name" : "remove",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
- "sig" : "(panel, preservePanel)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "preservePanel",
- "type" : "Boolean",
- "desc" : "Overrides the config preservePanel option",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel that was removed"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "removeListener",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Convenience function for boolean enable/disable",
+ "sig" : "(enabled)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "enabled",
+ "type" : "Boolean",
+ "desc" : "True to enable, false to disable",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setHandler",
+ "type" : "function",
+ "desc" : "Assigns this button's click handler",
+ "sig" : "(handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.Button",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
"name" : "handler",
"type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "The function to call when the button is clicked",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "(optional) Scope for the function passed in",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resizeTo",
+ "name" : "setPressed",
"type" : "function",
- "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
- "sig" : "(newSize)",
+ "desc" : "Similar to toggle, but does not trigger event.",
+ "sig" : "(state)",
"static" : false,
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new width or height",
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "[required] Force a particular state",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setCollapsedTitle",
+ "name" : "setText",
"type" : "function",
- "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)",
- "sig" : "(title)",
+ "desc" : "Sets this button's text",
+ "sig" : "(text)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "title",
+ "name" : "text",
"type" : "String",
- "desc" : "(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, \"&#160;\")",
+ "desc" : "The button text",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function for boolean show/hide",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Button",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
{
"name" : "show",
"type" : "function",
- "desc" : "Shows this region if it was previously hidden.",
+ "desc" : "Shows this button",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : []
},
{
- "name" : "showPanel",
+ "name" : "toggle",
"type" : "function",
- "desc" : "Shows the specified panel.",
- "sig" : "(panelId)",
+ "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.",
+ "sig" : "(state)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panelId",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "(optional) Force a particular state",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The shown panel, or null if a panel could not be found from panelId"
- }
- ]
+ "returns" : []
},
{
"name" : "un",
}
],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.Toolbar.Fill" : {
+ "props" : [],
+ "events" : [
{
- "name" : "unhidePanel",
+ "name" : "render",
"type" : "function",
- "desc" : "Unhides the tab for a previously hidden panel.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the button is rendered",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Toolbar.Item",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
+ "name" : "this",
+ "type" : "Button",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
}
],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.SplitLayoutRegion",
- "Roo.bootstrap.layout.Split"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.LoadMask" : {
- "props" : [
+ "methods" : [
{
- "name" : "msg",
- "type" : "String",
- "desc" : "The text to display in a centered loading message box (defaults to 'Loading...')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "msgCls",
- "type" : "String",
- "desc" : "The CSS class to apply to the loading message element (defaults to \"x-mask-loading\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Removes and destroys this item.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Toolbar.Item",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
- {
- "name" : "removeMask",
- "type" : "Boolean",
- "desc" : "True to create a single-use mask that is automatically destroyed after loading (useful for page loads),\nFalse to persist the mask element reference for multiple uses (e.g., for paged data widgets). Defaults to false.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
{
"name" : "disable",
"type" : "function",
- "desc" : "Disables the mask to prevent it from being displayed",
+ "desc" : "Disables this item.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Toolbar.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "enable",
"type" : "function",
- "desc" : "Enables the mask so that it can be displayed",
+ "desc" : "Enables this item.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Toolbar.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.MasterTemplate" : {
- "props" : [
- {
- "name" : "html",
- "type" : "String",
- "desc" : "The HTML fragment or an array of fragments to join(\"\") or multiple arguments to join(\"\")",
- "memberOf" : "Roo.Template",
- "isOptional" : false,
- "optvals" : []
},
{
- "name" : "onLoad",
- "type" : "Function",
- "desc" : "Called after the template has been loaded and complied (usually from a remove source)",
- "memberOf" : "Roo.Template",
- "isOptional" : false,
- "optvals" : []
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Try to focus this item.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Toolbar.Item",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
- "name" : "url",
- "type" : "String",
- "desc" : "The Url to load the template from. beware if you are loading from a url, the data may not be ready if you use it instantly..\n it should be fixed so that template is observable...",
- "memberOf" : "Roo.Template",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
- {
- "name" : "add",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Applies the passed values to a child template.",
- "sig" : "(name, values)",
+ "desc" : "Get this item's HTML Element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Toolbar.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "name",
- "type" : "String/Number",
- "desc" : "(optional) The name or index of the child template",
- "isOptional" : false
- },
- {
- "name" : "values",
- "type" : "Array/Object",
- "desc" : "The values to be applied to the template",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "MasterTemplate",
- "desc" : "this"
+ "type" : "HTMLElement",
+ "desc" : ""
}
]
},
{
- "name" : "addAll",
+ "name" : "hide",
"type" : "function",
- "desc" : "Alias for fill().",
+ "desc" : "Hides this item.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Toolbar.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "append",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Applies the supplied values to the template and appends the new node(s) to el.",
- "sig" : "(el, values, returnElement)",
+ "desc" : "Convenience function for boolean show/hide.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "Roo.Template",
+ "memberOf" : "Roo.Toolbar.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The context element",
- "isOptional" : false
- },
- {
- "name" : "values",
- "type" : "Object",
- "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
- "isOptional" : false
- },
- {
- "name" : "returnElement",
+ "name" : "visible",
"type" : "Boolean",
- "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
+ "desc" : "true to show/false to hide",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Shows this item.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Toolbar.Item",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.Toolbar.Item" : {
+ "props" : [],
+ "events" : [
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires when the button is rendered",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The new node or Element"
+ "name" : "this",
+ "type" : "Button",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Removes and destroys this item.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
- "name" : "apply",
+ "name" : "disable",
"type" : "function",
- "desc" : "Alias for {@link #applyTemplate}",
+ "desc" : "Disables this item.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Template",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "applyTemplate",
+ "name" : "enable",
"type" : "function",
- "desc" : "Returns an HTML fragment of this template with the specified values applied.",
- "sig" : "(values)",
+ "desc" : "Enables this item.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Template",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "values",
- "type" : "Object",
- "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "The HTML fragment"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "compile",
+ "name" : "focus",
"type" : "function",
- "desc" : "Compiles the template into an internal function, eliminating the RegEx overhead.",
+ "desc" : "Try to focus this item.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Template",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Template",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "fill",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Applies all the passed values to a child template.",
- "sig" : "(name, values, reset)",
+ "desc" : "Get this item's HTML Element",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "name",
- "type" : "String/Number",
- "desc" : "(optional) The name or index of the child template",
- "isOptional" : false
- },
- {
- "name" : "values",
- "type" : "Array",
- "desc" : "The values to be applied to the template, this should be an array of objects.",
- "isOptional" : false
- },
- {
- "name" : "reset",
- "type" : "Boolean",
- "desc" : "(optional) True to reset the template first",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "MasterTemplate",
- "desc" : "this"
+ "type" : "HTMLElement",
+ "desc" : ""
}
]
},
{
- "name" : "from",
+ "name" : "hide",
"type" : "function",
- "desc" : "Creates a template from the passed element's value (display:none textarea, preferred) or innerHTML. e.g.\nvar tpl = Roo.MasterTemplate.from('element-id');",
- "sig" : "(el, config)",
- "static" : true,
+ "desc" : "Hides this item.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "config",
- "type" : "Object",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "insertAfter",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Applies the supplied values to the template and inserts the new node(s) after el.",
- "sig" : "(el, values, returnElement)",
+ "desc" : "Convenience function for boolean show/hide.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "Roo.Template",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The context element",
- "isOptional" : false
- },
- {
- "name" : "values",
- "type" : "Object",
- "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
- "isOptional" : false
- },
- {
- "name" : "returnElement",
+ "name" : "visible",
"type" : "Boolean",
- "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
+ "desc" : "true to show/false to hide",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The new node or Element"
- }
- ]
+ "returns" : []
},
{
- "name" : "insertBefore",
+ "name" : "show",
"type" : "function",
- "desc" : "Applies the supplied values to the template and inserts the new node(s) before el.",
- "sig" : "(el, values, returnElement)",
+ "desc" : "Shows this item.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Template",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
+ "params" : [],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.Toolbar.Fill",
+ "Roo.Toolbar.Separator",
+ "Roo.Toolbar.Spacer",
+ "Roo.Toolbar.TextItem"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.Toolbar.Separator" : {
+ "props" : [],
+ "events" : [
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires when the button is rendered",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Toolbar.Item",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The context element",
- "isOptional" : false
- },
- {
- "name" : "values",
- "type" : "Object",
- "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
- "isOptional" : false
- },
- {
- "name" : "returnElement",
- "type" : "Boolean",
- "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
+ "name" : "this",
+ "type" : "Button",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The new node or Element"
- }
- ]
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Removes and destroys this item.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Toolbar.Item",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
- "name" : "insertFirst",
+ "name" : "disable",
"type" : "function",
- "desc" : "Applies the supplied values to the template and inserts the new node(s) as the first child of el.",
- "sig" : "(el, values, returnElement)",
+ "desc" : "Disables this item.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Template",
+ "memberOf" : "Roo.Toolbar.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The context element",
- "isOptional" : false
- },
- {
- "name" : "values",
- "type" : "Object",
- "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
- "isOptional" : false
- },
- {
- "name" : "returnElement",
- "type" : "Boolean",
- "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The new node or Element"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "overwrite",
+ "name" : "enable",
"type" : "function",
- "desc" : "Applies the supplied values to the template and overwrites the content of el with the new node(s).",
- "sig" : "(el, values, returnElement)",
+ "desc" : "Enables this item.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Template",
+ "memberOf" : "Roo.Toolbar.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The context element",
- "isOptional" : false
- },
- {
- "name" : "values",
- "type" : "Object",
- "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
- "isOptional" : false
- },
- {
- "name" : "returnElement",
- "type" : "Boolean",
- "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The new node or Element"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "reset",
+ "name" : "focus",
"type" : "function",
- "desc" : "Resets the template for reuse",
+ "desc" : "Try to focus this item.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Toolbar.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "MasterTemplate",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "set",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Sets the HTML used as the template and optionally compiles it.",
- "sig" : "(html, compile)",
+ "desc" : "Get this item's HTML Element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Template",
+ "memberOf" : "Roo.Toolbar.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "html",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "compile",
- "type" : "Boolean",
- "desc" : "(optional) True to compile the template (defaults to undefined)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Template",
- "desc" : "this"
+ "type" : "HTMLElement",
+ "desc" : ""
}
]
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.MessageBox" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "alert",
+ "name" : "hide",
"type" : "function",
- "desc" : "Displays a standard read-only message box with an OK button (comparable to the basic JavaScript Window.alert).\nIf a callback function is passed it will be called after the user clicks the button, and the\nid of the button that was clicked will be passed as the only parameter to the callback\n(could also be the top-right close button).",
- "sig" : "(title, msg, fn, scope)",
+ "desc" : "Hides this item.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Toolbar.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "title",
- "type" : "String",
- "desc" : "The title bar text",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The message box body text",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "(optional) The callback function invoked after the message box is closed",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the callback function",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "confirm",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's Window.confirm).\nIf a callback function is passed it will be called after the user clicks either button, and the id of the\nbutton that was clicked will be passed as the only parameter to the callback (could also be the top-right close button).",
- "sig" : "(title, msg, fn, scope)",
+ "desc" : "Convenience function for boolean show/hide.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Toolbar.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "title",
- "type" : "String",
- "desc" : "The title bar text",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The message box body text",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "(optional) The callback function invoked after the message box is closed",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the callback function",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "true to show/false to hide",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
+ "returns" : []
},
{
- "name" : "getDialog",
+ "name" : "show",
"type" : "function",
- "desc" : "Returns a reference to the underlying {@link Roo.BasicDialog} element",
+ "desc" : "Shows this item.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Toolbar.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.Toolbar.Spacer" : {
+ "props" : [],
+ "events" : [
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires when the button is rendered",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Toolbar.Item",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.BasicDialog",
- "desc" : "The BasicDialog element"
+ "name" : "this",
+ "type" : "Button",
+ "desc" : "",
+ "isOptional" : false
}
- ]
- },
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
{
- "name" : "hide",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Hides the message box if it is displayed",
+ "desc" : "Removes and destroys this item.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Toolbar.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "isVisible",
+ "name" : "disable",
"type" : "function",
- "desc" : "Returns true if the message box is currently displayed",
+ "desc" : "Disables this item.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Toolbar.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the message box is visible, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "progress",
+ "name" : "enable",
"type" : "function",
- "desc" : "Displays a message box with a progress bar. This message box has no buttons and is not closeable by\nthe user. You are responsible for updating the progress bar as needed via {@link Roo.MessageBox#updateProgress}\nand closing the message box when the process is complete.",
- "sig" : "(title, msg)",
+ "desc" : "Enables this item.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Toolbar.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "title",
- "type" : "String",
- "desc" : "The title bar text",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The message box body text",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "prompt",
+ "name" : "focus",
"type" : "function",
- "desc" : "Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to\nJavaScript's Window.prompt). The prompt can be a single-line or multi-line textbox. If a callback function\nis passed it will be called after the user clicks either button, and the id of the button that was clicked\n(could also be the top-right close button) and the text that was entered will be passed as the two\nparameters to the callback.",
- "sig" : "(title, msg, fn, scope, multiline)",
+ "desc" : "Try to focus this item.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Toolbar.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "title",
- "type" : "String",
- "desc" : "The title bar text",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The message box body text",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "(optional) The callback function invoked after the message box is closed",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the callback function",
- "isOptional" : false
- },
- {
- "name" : "multiline",
- "type" : "Boolean/Number",
- "desc" : "(optional) True to create a multiline textbox using the defaultTextHeight\nproperty, or the height in pixels to create the textbox (defaults to false / single-line)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "show",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Displays a new message box, or reinitializes an existing message box, based on the config options\npassed in. All functions (e.g. prompt, alert, etc) on MessageBox call this function internally.\nThe following config object properties are supported:\n<pre>\nProperty Type Description\n---------- --------------- ------------------------------------------------------------------------------------\nanimEl String/Element An id or Element from which the message box should animate as it opens and\n closes (defaults to undefined)\nbuttons Object/Boolean A button config object (e.g., Roo.MessageBox.OKCANCEL or {ok:'Foo',\n cancel:'Bar'}), or false to not show any buttons (defaults to false)\nclosable Boolean False to hide the top-right close button (defaults to true). Note that\n progress and wait dialogs will ignore this property and always hide the\n close button as they can only be closed programmatically.\ncls String A custom CSS class to apply to the message box element\ndefaultTextHeight Number The default height in pixels of the message box's multiline textarea if\n displayed (defaults to 75)\nfn Function A callback function to execute after closing the dialog. The arguments to the\n function will be btn (the name of the button that was clicked, if applicable,\n e.g. \"ok\"), and text (the value of the active text field, if applicable).\n Progress and wait dialogs will ignore this option since they do not respond to\n user actions and can only be closed programmatically, so any required function\n should be called by the same code after it closes the dialog.\nicon String A CSS class that provides a background image to be used as an icon for\n the dialog (e.g., Roo.MessageBox.WARNING or 'custom-class', defaults to '')\nmaxWidth Number The maximum width in pixels of the message box (defaults to 600)\nminWidth Number The minimum width in pixels of the message box (defaults to 100)\nmodal Boolean False to allow user interaction with the page while the message box is\n displayed (defaults to true)\nmsg String A string that will replace the existing message box body text (defaults\n to the XHTML-compliant non-breaking space character ' ')\nmultiline Boolean True to prompt the user to enter multi-line text (defaults to false)\nprogress Boolean True to display a progress bar (defaults to false)\nprogressText String The text to display inside the progress bar if progress = true (defaults to '')\nprompt Boolean True to prompt the user to enter single-line text (defaults to false)\nproxyDrag Boolean True to display a lightweight proxy while dragging (defaults to false)\ntitle String The title text\nvalue String The string value to set into the active textbox element if displayed\nwait Boolean True to display a progress bar (defaults to false)\nwidth Number The width of the dialog in pixels\n</pre>\n\nExample usage:\n<pre><code>\nRoo.Msg.show({\n title: 'Address',\n msg: 'Please enter your address:',\n width: 300,\n buttons: Roo.MessageBox.OKCANCEL,\n multiline: true,\n fn: saveAddress,\n animEl: 'addAddressBtn'\n});\n</code></pre>",
- "sig" : "(config)",
+ "desc" : "Get this item's HTML Element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Toolbar.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "config",
- "type" : "Object",
- "desc" : "Configuration options",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
+ "type" : "HTMLElement",
+ "desc" : ""
}
]
},
{
- "name" : "updateProgress",
+ "name" : "hide",
"type" : "function",
- "desc" : "Updates a progress-style message box's text and progress bar. Only relevant on message boxes\ninitiated via {@link Roo.MessageBox#progress} or by calling {@link Roo.MessageBox#show} with progress: true.",
- "sig" : "(value, text)",
+ "desc" : "Hides this item.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Toolbar.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Number",
- "desc" : "Any number between 0 and 1 (e.g., .5)",
- "isOptional" : false
- },
- {
- "name" : "text",
- "type" : "String",
- "desc" : "(optional) If defined, the message box's body text is replaced with the specified string (defaults to undefined)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "updateText",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Updates the message box body text",
- "sig" : "(text)",
+ "desc" : "Convenience function for boolean show/hide.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Toolbar.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "text",
- "type" : "String",
- "desc" : "(optional) Replaces the message box element's innerHTML with the specified string (defaults to\nthe XHTML-compliant non-breaking space character '&#160;')",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "true to show/false to hide",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
+ "returns" : []
},
{
- "name" : "wait",
+ "name" : "show",
"type" : "function",
- "desc" : "Displays a message box with an infinitely auto-updating progress bar. This can be used to block user\ninteraction while waiting for a long-running process to complete that does not have defined intervals.\nYou are responsible for closing the message box when the process is complete.",
- "sig" : "(msg, title)",
+ "desc" : "Shows this item.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Toolbar.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The message box body text",
- "isOptional" : false
- },
- {
- "name" : "title",
- "type" : "String",
- "desc" : "(optional) The title bar text",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
+ "params" : [],
+ "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
+ "implementations" : [
+ "Roo.Toolbar.Fill"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.NestedLayoutPanel" : {
+ "Roo.Toolbar.SplitButton" : {
"props" : [
{
- "name" : "adjustments",
- "type" : "Array",
- "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
- "memberOf" : "Roo.ContentPanel",
+ "name" : "arrowHandler",
+ "type" : "Function",
+ "desc" : "A function called when the arrow button is clicked (can be used instead of click event)",
+ "memberOf" : "Roo.SplitButton",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "autoCreate",
- "type" : "Boolean|Object",
- "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
- "memberOf" : "Roo.ContentPanel",
+ "name" : "arrowTooltip",
+ "type" : "String",
+ "desc" : "The title attribute of the arrow",
+ "memberOf" : "Roo.SplitButton",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "autoScroll",
+ "name" : "clickEvent",
+ "type" : "String",
+ "desc" : "The type of event to map to the button's event handler (defaults to 'click')",
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "A CSS class to apply to the button's main element.",
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabled",
"type" : "Boolean",
- "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
- "memberOf" : "Roo.ContentPanel",
+ "desc" : "True to start disabled (defaults to false)",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "background",
+ "name" : "enableToggle",
"type" : "Boolean",
- "desc" : "True if the panel should not be activated when it is added (defaults to false)",
- "memberOf" : "Roo.ContentPanel",
+ "desc" : "True to enable pressed/not pressed toggling (defaults to false)",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "closable",
+ "name" : "handleMouseEvents",
"type" : "Boolean",
- "desc" : "True if the panel can be closed/removed",
- "memberOf" : "Roo.ContentPanel",
+ "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "content",
- "type" : "String",
- "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
- "memberOf" : "Roo.ContentPanel",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "A function called when the button is clicked (can be used instead of click event)",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "fitContainer",
+ "name" : "hidden",
"type" : "Boolean",
- "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
- "memberOf" : "Roo.ContentPanel",
+ "desc" : "True to start hidden (defaults to false)",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "fitToFrame",
- "type" : "Boolean",
- "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
- "memberOf" : "Roo.ContentPanel",
+ "name" : "icon",
+ "type" : "String",
+ "desc" : "The path to an image to display in the button (the image will be set as the background-image\nCSS property of the button by default, so if you want a mixed icon/text button, set cls:\"x-btn-text-icon\")",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "layout",
- "type" : "Roo.BorderLayout",
- "desc" : "The layout for this panel",
- "memberOf" : "Roo",
+ "name" : "iconCls",
+ "type" : "String",
+ "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "loadOnce",
- "type" : "Boolean",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.ContentPanel",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "menu",
"type" : "Roo.menu.Menu",
- "desc" : "popup menu",
- "memberOf" : "Roo.ContentPanel",
+ "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "params",
- "type" : "String|Object",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.ContentPanel",
+ "name" : "menuAlign",
+ "type" : "String",
+ "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "region",
- "type" : "String",
- "desc" : "t) which region to put this panel on (when used with xtype constructor",
- "memberOf" : "Roo.ContentPanel",
+ "name" : "minWidth",
+ "type" : "Number",
+ "desc" : "The minimum width for this button (used to give a set of buttons a common width)",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
- "optvals" : [
- "center",
- "north",
- "south",
- "east",
- "west"
- ]
+ "optvals" : []
},
{
- "name" : "resizeEl",
- "type" : "String|HTMLElement|Element",
- "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
- "memberOf" : "Roo.ContentPanel",
+ "name" : "pressed",
+ "type" : "Boolean",
+ "desc" : "True to start pressed (only if enableToggle = true)",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "Extra style to add to the content panel",
- "memberOf" : "Roo.ContentPanel",
+ "name" : "renderTo",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The element to append the button to",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "title",
+ "name" : "repeat",
+ "type" : "Boolean/Object",
+ "desc" : "True to repeat fire the click event while the mouse is down. This can also be\n an {@link Roo.util.ClickRepeater} config object (defaults to false).",
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "The scope of the handler",
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tabIndex",
+ "type" : "Number",
+ "desc" : "The DOM tabIndex for this button (defaults to undefined)",
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "template",
+ "type" : "Roo.Template",
+ "desc" : "An {@link Roo.Template} with which to create the Button's main element. This Template must\ncontain numeric substitution parameter 0 if it is to display the tRoo property. Changing the template could\nrequire code modifications if required elements (e.g. a button) aren't present.",
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "text",
"type" : "String",
- "desc" : "The title for this panel",
- "memberOf" : "Roo.ContentPanel",
+ "desc" : "The button text",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "toolbar",
- "type" : "Roo.Toolbar",
- "desc" : "A toolbar for this panel",
- "memberOf" : "Roo.ContentPanel",
+ "name" : "toggleGroup",
+ "type" : "String",
+ "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "url",
+ "name" : "tooltip",
+ "type" : "String/Object",
+ "desc" : "The tooltip for the button - can be a string or QuickTips config object",
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tooltipType",
"type" : "String",
- "desc" : "Calls {@link #setUrl} with this value",
- "memberOf" : "Roo.ContentPanel",
+ "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "type",
+ "type" : "String",
+ "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
+ "memberOf" : "Roo.Button",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
{
- "name" : "activate",
+ "name" : "arrowclick",
"type" : "function",
- "desc" : "Fires when this panel is activated.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.ContentPanel",
+ "desc" : "Fires when this button's arrow is clicked",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.SplitButton",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.ContentPanel",
+ "type" : "SplitButton",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "The click event",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "deactivate",
+ "name" : "click",
"type" : "function",
- "desc" : "Fires when this panel is activated.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.ContentPanel",
+ "desc" : "Fires when this button is clicked",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.ContentPanel",
+ "type" : "Button",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "The click event",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "mouseout",
"type" : "function",
- "desc" : "Fires when this tab is created",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.ContentPanel",
+ "desc" : "Fires when the mouse exits the button",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.ContentPanel",
+ "type" : "Button",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resize",
+ "name" : "mouseover",
"type" : "function",
- "desc" : "Fires when this panel is resized if fitToFrame is true.",
- "sig" : "function (_self, width, height)\n{\n\n}",
- "memberOf" : "Roo.ContentPanel",
+ "desc" : "Fires when the mouse hovers over the button",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.ContentPanel",
+ "type" : "Button",
"desc" : "",
"isOptional" : false
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "The width after any component adjustments",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires when the button is rendered",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Button",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Button",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "toggle",
+ "type" : "function",
+ "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)",
+ "sig" : "function (_self, pressed)\n{\n\n}",
+ "memberOf" : "Roo.Button",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Button",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "The height after any component adjustments",
+ "name" : "pressed",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
],
"returns" : []
},
- {
- "name" : "addxtype",
- "type" : "function",
- "desc" : "Adds a xtype elements to the layout of the nested panel\n<pre><code>\n\npanel.addxtype({\n xtype : 'ContentPanel',\n region: 'west',\n items: [ .... ]\n }\n);\n\npanel.addxtype({\n xtype : 'NestedLayoutPanel',\n region: 'west',\n layout: {\n center: { },\n west: { } \n },\n items : [ ... list of content panels or nested layout panels.. ]\n }\n);\n</code></pre>",
- "sig" : "(cfg)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "cfg",
- "type" : "Object",
- "desc" : "Xtype definition of item to add.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
{
"name" : "destroy",
"type" : "function",
- "desc" : "Destroys this panel",
+ "desc" : "Removes and destroys this button",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Disable this button",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "getEl",
+ "name" : "enable",
"type" : "function",
- "desc" : "Returns this panel's element - used by regiosn to add.",
+ "desc" : "Enable this button",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "Roo.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getId",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Returns this panel's id",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
+ "name" : "eventName",
"type" : "String",
- "desc" : ""
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "getLayout",
- "type" : "function",
- "desc" : "Returns the nested BorderLayout for this panel",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.BorderLayout",
- "desc" : ""
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "getTitle",
+ "name" : "focus",
"type" : "function",
- "desc" : "Returns this panel's title",
+ "desc" : "Focus the button",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "Roo.SplitButton",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getToolbar",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns the toolbar for this Panel if one was configured.",
+ "desc" : "Returns the button's underlying element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "Roo.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Toolbar",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "getUpdateManager",
+ "name" : "getText",
"type" : "function",
- "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
+ "desc" : "Gets the text for this button",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "Roo.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.UpdateManager",
- "desc" : "The UpdateManager"
+ "type" : "String",
+ "desc" : "The button text"
}
]
},
]
},
{
- "name" : "isClosable",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns true is this panel was configured to be closable",
+ "desc" : "Hides this button",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "load",
- "type" : "function",
- "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.",
- "sig" : "(url, params, callback, discardUrl)",
- "static" : false,
- "memberOf" : "Roo.ContentPanel",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "url",
- "type" : "Object/String/Function",
- "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\npanel.load({\n url: \"your-url.php\",\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n callback: yourFunction,\n scope: yourObject, //(optional scope)\n discardUrl: false,\n nocache: false,\n text: \"Loading...\",\n timeout: 30,\n scripts: false\n});\n</code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
- "isOptional" : false
- },
- {
- "name" : "discardUrl",
- "type" : "Boolean",
- "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
"name" : "on",
"params" : [],
"returns" : []
},
- {
- "name" : "refresh",
- "type" : "function",
- "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.ContentPanel",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "releaseCapture",
"type" : "function",
"returns" : []
},
{
- "name" : "setContent",
+ "name" : "setArrowHandler",
"type" : "function",
- "desc" : "Updates this panel's element",
- "sig" : "(content, loadScripts)",
+ "desc" : "Sets this button's arrow click handler",
+ "sig" : "(handler, scope)",
"static" : false,
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "Roo.SplitButton",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "content",
- "type" : "String",
- "desc" : "The new content",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The function to call when the arrow is clicked",
"isOptional" : false
},
{
- "name" : "loadScripts",
- "type" : "Boolean",
- "desc" : "(optional) true to look for and process scripts",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) Scope for the function passed above",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setTitle",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Set this panel's title",
- "sig" : "(title)",
+ "desc" : "Convenience function for boolean enable/disable",
+ "sig" : "(enabled)",
"static" : false,
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "Roo.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "title",
- "type" : "String",
- "desc" : "",
+ "name" : "enabled",
+ "type" : "Boolean",
+ "desc" : "True to enable, false to disable",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setUrl",
+ "name" : "setHandler",
"type" : "function",
- "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
- "sig" : "(url, params, loadOnce)",
+ "desc" : "Sets this button's click handler",
+ "sig" : "(handler, scope)",
"static" : false,
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "Roo.SplitButton",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "url",
- "type" : "String/Function",
- "desc" : "The URL to load the content from or a function to call to get the URL",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The function to call when the button is clicked",
"isOptional" : false
},
{
- "name" : "loadOnce",
- "type" : "Boolean",
- "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) Scope for the function passed above",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.UpdateManager",
- "desc" : "The UpdateManager"
- }
- ]
+ "returns" : []
},
{
- "name" : "un",
+ "name" : "setPressed",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Similar to toggle, but does not trigger event.",
+ "sig" : "(state)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "[required] Force a particular state",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : [
- "Roo.BorderLayout",
- "Roo.LayoutDialog",
- "builder"
- ]
- },
- "Roo.PagingToolbar" : {
- "props" : [
- {
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "container The id or element that will contain the toolbar",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "displayInfo",
- "type" : "Boolean",
- "desc" : "True to display the displayMsg (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "displayMsg",
- "type" : "String",
- "desc" : "The paging status message to display (defaults to \"Displaying {start} - {end} of {total}\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "emptyMsg",
- "type" : "String",
- "desc" : "The message to display when no records are found (defaults to \"No data to display\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "items",
- "type" : "Array",
- "desc" : "array of button configs or elements to add (will be converted to a MixedCollection)",
- "memberOf" : "Roo.Toolbar",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "pageSize",
- "type" : "Number",
- "desc" : "The number of records to display per page (defaults to 20)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
},
{
- "name" : "text",
- "type" : "string",
- "desc" : "",
- "memberOf" : "Roo.Toolbar",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
- {
- "name" : "add",
+ "name" : "setText",
"type" : "function",
- "desc" : "Adds element(s) to the toolbar -- this function takes a variable number of \narguments of mixed type and adds them to the toolbar.",
- "sig" : "(arg1, arg2)",
+ "desc" : "Sets this button's text",
+ "sig" : "(text)",
"static" : false,
- "memberOf" : "Roo.Toolbar",
+ "memberOf" : "Roo.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"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" : "",
+ "name" : "text",
+ "type" : "String",
+ "desc" : "The button text",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addButton",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Adds a button (or buttons). See {@link Roo.Toolbar.Button} for more info on the config.",
- "sig" : "(config)",
+ "desc" : "Convenience function for boolean show/hide",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "Roo.Toolbar",
+ "memberOf" : "Roo.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "config",
- "type" : "Object/Array",
- "desc" : "A button config or array of configs",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Toolbar.Button/Array",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "addDom",
+ "name" : "show",
"type" : "function",
- "desc" : "Adds a new element to the toolbar from the passed {@link Roo.DomHelper} config.",
- "sig" : "(config)",
+ "desc" : "Shows this button",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Toolbar",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "config",
- "type" : "Object",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Toolbar.Item",
- "desc" : "The element's item"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "addElement",
+ "name" : "toggle",
"type" : "function",
- "desc" : "Adds any standard HTML element to the toolbar",
- "sig" : "(el)",
+ "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.",
+ "sig" : "(state)",
"static" : false,
- "memberOf" : "Roo.Toolbar",
+ "memberOf" : "Roo.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The element or id of the element to add",
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "(optional) Force a particular state",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Toolbar.Item",
- "desc" : "The element's item"
- }
- ]
+ "returns" : []
},
{
- "name" : "addField",
+ "name" : "un",
"type" : "function",
- "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}.",
- "sig" : "(field)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.Toolbar",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "field",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.Toolbar.TextItem" : {
+ "props" : [
+ {
+ "name" : "text",
+ "type" : "string",
+ "desc" : "",
+ "memberOf" : "Roo.Toolbar",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires when the button is rendered",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Toolbar.Item",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.ToolbarItem",
- "desc" : ""
+ "name" : "this",
+ "type" : "Button",
+ "desc" : "",
+ "isOptional" : false
}
- ]
- },
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
{
- "name" : "addFill",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Adds a fill element that forces subsequent additions to the right side of the toolbar",
+ "desc" : "Removes and destroys this item.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Toolbar",
+ "memberOf" : "Roo.Toolbar.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Toolbar.Fill",
- "desc" : "The fill item"
- }
- ]
+ "returns" : []
},
{
- "name" : "addItem",
+ "name" : "disable",
"type" : "function",
- "desc" : "Adds any Toolbar.Item or subclass",
- "sig" : "(item)",
+ "desc" : "Disables this item.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Toolbar",
+ "memberOf" : "Roo.Toolbar.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "item",
- "type" : "Roo.Toolbar.Item",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Toolbar.Item",
- "desc" : "The item"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "addSeparator",
+ "name" : "enable",
"type" : "function",
- "desc" : "Adds a separator",
+ "desc" : "Enables this item.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Toolbar",
+ "memberOf" : "Roo.Toolbar.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Toolbar.Item",
- "desc" : "The separator item"
- }
- ]
+ "returns" : []
},
{
- "name" : "addSpacer",
+ "name" : "focus",
"type" : "function",
- "desc" : "Adds a spacer element",
+ "desc" : "Try to focus this item.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Toolbar",
+ "memberOf" : "Roo.Toolbar.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Toolbar.Spacer",
- "desc" : "The spacer item"
- }
- ]
+ "returns" : []
},
{
- "name" : "addText",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Adds text to the toolbar",
- "sig" : "(text)",
+ "desc" : "Get this item's HTML Element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Toolbar",
+ "memberOf" : "Roo.Toolbar.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "text",
- "type" : "String",
- "desc" : "The text to add",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Toolbar.Item",
- "desc" : "The element's item"
+ "type" : "HTMLElement",
+ "desc" : ""
}
]
},
{
- "name" : "addxtype",
+ "name" : "hide",
"type" : "function",
- "desc" : "Add an Xtype element",
- "sig" : "(xtype)",
+ "desc" : "Hides this button",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Toolbar",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "xtype",
- "type" : "Object",
- "desc" : "Xtype Object",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "created Object"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "bind",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Binds the paging toolbar to the specified {@link Roo.data.Store}",
- "sig" : "(store)",
+ "desc" : "Convenience function for boolean show/hide.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Toolbar.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to bind",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "true to show/false to hide",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "getEl",
+ "name" : "show",
"type" : "function",
- "desc" : "Returns the Element for this toolbar.",
+ "desc" : "Shows this button",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Toolbar",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : ""
- }
- ]
- },
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.UpdateManager" : {
+ "props" : [
{
- "name" : "hide",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforeupdate",
"type" : "function",
- "desc" : "Hide the toolbar",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Toolbar",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fired before an update is made, return false from your handler and the update is cancelled.",
+ "sig" : "function (el, url, params)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "Roo.Element",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "url",
+ "type" : "String/Object/Function",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "insertButton",
+ "name" : "failure",
"type" : "function",
- "desc" : "Inserts any {@link Roo.Toolbar.Item}/{@link Roo.Toolbar.Button} at the specified index.",
- "sig" : "(index, item)",
- "static" : false,
- "memberOf" : "Roo.Toolbar",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fired on update failure.",
+ "sig" : "function (el, oResponseObject)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The index where the item is to be inserted",
+ "name" : "el",
+ "type" : "Roo.Element",
+ "desc" : "",
"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.",
+ "name" : "oResponseObject",
+ "type" : "Object",
+ "desc" : "The response Object",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Toolbar.Button/Item",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "onClick",
+ "name" : "update",
"type" : "function",
- "desc" : "event that occurs when you click on the navigation buttons - can be used to trigger load of a grid.",
- "sig" : "(which)",
- "static" : false,
+ "desc" : "Fired after successful update is made.",
+ "sig" : "function (el, oResponseObject)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "which",
- "type" : "String",
- "desc" : "(first|prev|next|last|refresh) which button to press.",
+ "name" : "el",
+ "type" : "Roo.Element",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "oResponseObject",
+ "type" : "Object",
+ "desc" : "The response Object",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "show",
+ "name" : "abort",
"type" : "function",
- "desc" : "Show the toolbar",
+ "desc" : "Aborts the executing transaction",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Toolbar",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "unbind",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Unbinds the paging toolbar from the specified {@link Roo.data.Store}",
- "sig" : "(store)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to unbind",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [
- "Roo.Toolbar.Item",
- "Roo.Toolbar.Fill",
- "Roo.Toolbar.Separator",
- "Roo.Toolbar.Spacer",
- "Roo.Toolbar.TextItem",
- "Roo.Toolbar.Button",
- "Roo.Toolbar.SplitButton",
- "Roo.form.Field",
- "Roo.form.Checkbox",
- "Roo.form.ComboBox",
- "Roo.form.ComboBoxArray",
- "Roo.form.ComboCheck",
- "Roo.form.ComboNested",
- "Roo.form.DateField",
- "Roo.form.DayPicker",
- "Roo.form.DisplayField",
- "Roo.form.FCKeditor",
- "Roo.form.GridField",
- "Roo.form.Hidden",
- "Roo.form.HtmlEditor",
- "Roo.form.MonthField",
- "Roo.form.NumberField",
- "Roo.form.Radio",
- "Roo.form.Select",
- "Roo.form.Signature",
- "Roo.form.TextArea",
- "Roo.form.TextField",
- "Roo.form.TriggerField"
- ],
- "tree_parent" : []
- },
- "Roo.QuickTips" : {
- "props" : [
- {
- "name" : "Delay",
- "type" : "Number",
- "desc" : "in milliseconds before the quick tip hides when autoDismiss = true (defaults to 5000)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "True",
- "type" : "Boolean",
- "desc" : "to automatically hide the quick tip after a set period of time, regardless of the user's actions\n(defaults to true). Used in conjunction with autoDismissDelay.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "animate",
- "type" : "Boolean",
- "desc" : "True to turn on fade animation. Defaults to false (ClearType/scrollbar flicker issues in IE7).",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoHide",
- "type" : "Boolean",
- "desc" : "True to automatically hide the quick tip after the mouse exits the target element (defaults to true).\nUsed in conjunction with hideDelay.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "A CSS class to apply to the base quick tip element (defaults to '').",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideDelay",
- "type" : "Number",
- "desc" : "Delay in milliseconds before the quick tip hides when autoHide = true (defaults to 200)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideOnClick",
- "type" : "Boolean",
- "desc" : "True to hide the quick tip if the user clicks anywhere in the document (defaults to true)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "interceptTitles",
- "type" : "Boolean",
- "desc" : "True to automatically use the element's DOM title value if available (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxWidth",
- "type" : "Number",
- "desc" : "The maximum width of the quick tip (defaults to 300)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minWidth",
- "type" : "Number",
- "desc" : "The minimum width of the quick tip (defaults to 40)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "showDelay",
- "type" : "Number",
- "desc" : "Delay in milliseconds before the quick tip displays after the mouse enters the target element (defaults to 500)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "text",
- "type" : "String",
- "desc" : "Body text to display (defaults to ''). This can be any valid HTML markup.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "title",
- "type" : "String",
- "desc" : "Title text to display (defaults to ''). This can be any valid HTML markup.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "trackMouse",
- "type" : "Boolean",
- "desc" : "True to have the quick tip follow the mouse as it moves over the target element (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "Width in pixels of the quick tip (defaults to auto). Width will be ignored if it exceeds the bounds of\nminWidth or maxWidth.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this quick tip.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enable this quick tip.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "init",
- "type" : "function",
- "desc" : "Initialize and enable QuickTips for first use. This should be called once before the first attempt to access\nor display QuickTips in a page.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isEnabled",
- "type" : "function",
- "desc" : "Returns true if the quick tip is enabled, else false.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "register",
- "type" : "function",
- "desc" : "Configures a new quick tip instance and assigns it to a target element. The following config options\nare supported:\n<pre>\nProperty Type Description\n---------- --------------------- ------------------------------------------------------------------------\ntarget Element/String/Array An Element, id or array of ids that this quick tip should be tied to\n</ul>",
- "sig" : "(config)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "config",
- "type" : "Object",
- "desc" : "The config object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "unregister",
- "type" : "function",
- "desc" : "Removes this quick tip from its element and destroys it.",
- "sig" : "(el)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The element from which the quick tip is to be removed.",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.ReaderLayout" : {
- "props" : [
- {
- "name" : "center",
- "type" : "Roo.LayoutRegion",
- "desc" : "",
- "memberOf" : "Roo.BorderLayout",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "east",
- "type" : "Roo.LayoutRegion",
- "desc" : "",
- "memberOf" : "Roo.BorderLayout",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "north",
- "type" : "Roo.LayoutRegion",
- "desc" : "",
- "memberOf" : "Roo.BorderLayout",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "south",
- "type" : "Roo.LayoutRegion",
- "desc" : "",
- "memberOf" : "Roo.BorderLayout",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "west",
- "type" : "Roo.LayoutRegion",
- "desc" : "",
- "memberOf" : "Roo.BorderLayout",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "layout",
- "type" : "function",
- "desc" : "Fires when a layout is performed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.LayoutManager",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.LayoutManager",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "regioncollapsed",
- "type" : "function",
- "desc" : "Fires when a region is collapsed.",
- "sig" : "function (region)\n{\n\n}",
- "memberOf" : "Roo.LayoutManager",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The collapsed region",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "regionexpanded",
- "type" : "function",
- "desc" : "Fires when a region is expanded.",
- "sig" : "function (region)\n{\n\n}",
- "memberOf" : "Roo.LayoutManager",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The expanded region",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "regionresized",
- "type" : "function",
- "desc" : "Fires when the user resizes a region.",
- "sig" : "function (region, newSize)\n{\n\n}",
- "memberOf" : "Roo.LayoutManager",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The resized region",
- "isOptional" : false
- },
- {
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new size (width for east/west, height for north/south)",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "methods" : [
- {
- "name" : "add",
- "type" : "function",
- "desc" : "Adds a ContentPanel (or subclass) to this layout.",
- "sig" : "(target, panel)",
- "static" : false,
- "memberOf" : "Roo.BorderLayout",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "target",
- "type" : "String",
- "desc" : "The target region key (north, south, east, west or center).",
- "isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel to add",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The added panel"
- }
- ]
- },
- {
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
],
"returns" : []
},
- {
- "name" : "addRegion",
- "type" : "function",
- "desc" : "Creates and adds a new region if it doesn't already exist.",
- "sig" : "(target, config)",
- "static" : false,
- "memberOf" : "Roo.BorderLayout",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "target",
- "type" : "String",
- "desc" : "The target region key (north, south, east, west or center).",
- "isOptional" : false
- },
- {
- "name" : "config",
- "type" : "Object",
- "desc" : "The regions config object",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "BorderLayoutRegion",
- "desc" : "The new region"
- }
- ]
- },
- {
- "name" : "addxtype",
- "type" : "function",
- "desc" : "Adds a xtype elements to the layout.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'ContentPanel',\n region: 'west',\n items: [ .... ]\n }\n);\n\nlayout.addxtype({\n xtype : 'NestedLayoutPanel',\n region: 'west',\n layout: {\n center: { },\n west: { } \n },\n items : [ ... list of content panels or nested layout panels.. ]\n }\n);\n</code></pre>",
- "sig" : "(cfg)",
- "static" : false,
- "memberOf" : "Roo.BorderLayout",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "cfg",
- "type" : "Object",
- "desc" : "Xtype definition of item to add.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "batchAdd",
- "type" : "function",
- "desc" : "Adds a batch of multiple ContentPanels dynamically by passing a special regions config object. This config\nobject should contain properties for each region to add ContentPanels to, and each property's value should be\na valid ContentPanel config object. Example:\n<pre><code>\n// Create the main layout\nvar layout = new Roo.BorderLayout('main-ct', {\n west: {\n split:true,\n minSize: 175,\n titlebar: true\n },\n center: {\n title:'Components'\n }\n}, 'main-ct');\n\n// Create and add multiple ContentPanels at once via configs\nlayout.batchAdd({\n west: {\n id: 'source-files',\n autoCreate:true,\n title:'Ext Source Files',\n autoScroll:true,\n fitToFrame:true\n },\n center : {\n el: cview,\n autoScroll:true,\n fitToFrame:true,\n toolbar: tb,\n resizeEl:'cbody'\n }\n});\n</code></pre>",
- "sig" : "(regions)",
- "static" : false,
- "memberOf" : "Roo.BorderLayout",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "regions",
- "type" : "Object",
- "desc" : "An object containing ContentPanel configs by region name",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beginUpdate",
- "type" : "function",
- "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.LayoutManager",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "create",
- "type" : "function",
- "desc" : "Shortcut for creating a new BorderLayout object and adding one or more ContentPanels to it in a single step, handling\nthe beginUpdate and endUpdate calls internally. The key to this method is the <b>panels</b> property that can be\nprovided with each region config, which allows you to add ContentPanel configs in addition to the region configs\nduring creation. The following code is equivalent to the constructor-based example at the beginning of this class:\n<pre><code>\n// shorthand\nvar CP = Roo.ContentPanel;\n\nvar layout = Roo.BorderLayout.create({\n north: {\n initialSize: 25,\n titlebar: false,\n panels: [new CP(\"north\", \"North\")]\n },\n west: {\n split:true,\n initialSize: 200,\n minSize: 175,\n maxSize: 400,\n titlebar: true,\n collapsible: true,\n panels: [new CP(\"west\", {title: \"West\"})]\n },\n east: {\n split:true,\n initialSize: 202,\n minSize: 175,\n maxSize: 400,\n titlebar: true,\n collapsible: true,\n panels: [new CP(\"autoTabs\", {title: \"Auto Tabs\", closable: true})]\n },\n south: {\n split:true,\n initialSize: 100,\n minSize: 100,\n maxSize: 200,\n titlebar: true,\n collapsible: true,\n panels: [new CP(\"south\", {title: \"South\", closable: true})]\n },\n center: {\n titlebar: true,\n autoScroll:true,\n resizeTabs: true,\n minTabWidth: 50,\n preferredTabWidth: 150,\n panels: [\n new CP(\"center1\", {title: \"Close Me\", closable: true}),\n new CP(\"center2\", {title: \"Center Panel\", closable: false})\n ]\n }\n}, document.body);\n\nlayout.getRegion(\"center\").showPanel(\"center1\");\n</code></pre>",
- "sig" : "(config, targetEl)",
- "static" : true,
- "memberOf" : "Roo.BorderLayout",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "config",
- "type" : "",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "targetEl",
- "type" : "",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "endUpdate",
- "type" : "function",
- "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
- "sig" : "(noLayout)",
- "static" : false,
- "memberOf" : "Roo.LayoutManager",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "noLayout",
- "type" : "Boolean",
- "desc" : "true to disable a layout update",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "findPanel",
- "type" : "function",
- "desc" : "Searches all regions for a panel with the specified id",
- "sig" : "(panelId)",
- "static" : false,
- "memberOf" : "Roo.BorderLayout",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panelId",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel or null if it wasn't found"
- }
- ]
- },
{
"name" : "fireEvent",
"type" : "function",
]
},
{
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns the Element this layout is bound to.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.LayoutManager",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getRegion",
+ "name" : "formUpdate",
"type" : "function",
- "desc" : "Returns the specified region.",
- "sig" : "(target)",
+ "desc" : "Performs an async form post, updating this element with the response. If the form has the attribute enctype=\"multipart/form-data\", it assumes it's a file upload.\nUses this.sslBlankUrl for SSL file uploads to prevent IE security warning.",
+ "sig" : "(form, url, reset, callback)",
"static" : false,
- "memberOf" : "Roo.LayoutManager",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "target",
+ "name" : "form",
+ "type" : "String/HTMLElement",
+ "desc" : "The form Id or form element",
+ "isOptional" : false
+ },
+ {
+ "name" : "url",
"type" : "String",
- "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')",
+ "desc" : "(optional) The url to pass the form to. If omitted the action attribute on the form will be used.",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.LayoutRegion",
- "desc" : ""
+ "name" : "reset",
+ "type" : "Boolean",
+ "desc" : "(optional) Whether to try to reset the form after the update",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess, oResponse)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getViewSize",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.",
+ "desc" : "Get the Element this UpdateManager is bound to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutManager",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "The size as an object {width: (the width), height: (the height)}"
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
"name" : "isUpdating",
"type" : "function",
- "desc" : "Returns true if this layout is currently being updated",
+ "desc" : "Returns true if an update is in progress",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutManager",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
- {
- "name" : "layout",
- "type" : "function",
- "desc" : "Performs a layout update.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.BorderLayout",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "refresh",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Refresh the element with the last used url or defaultUrl. If there is no url, it returns immediately",
+ "sig" : "(callback)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Remove a ContentPanel (or subclass) to this layout.",
- "sig" : "(target, panel)",
- "static" : false,
- "memberOf" : "Roo.BorderLayout",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "String",
- "desc" : "The target region key (north, south, east, west or center).",
- "isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Number/String/Roo.ContentPanel",
- "desc" : "The index, id or panel to remove",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The removed panel"
- }
- ]
+ "returns" : []
},
{
"name" : "removeListener",
"returns" : []
},
{
- "name" : "restoreState",
+ "name" : "setDefaultUrl",
"type" : "function",
- "desc" : "Restores this layout's state using Roo.state.Manager or the state provided by the passed provider.",
- "sig" : "(provider)",
+ "desc" : "Set the defaultUrl used for updates",
+ "sig" : "(defaultUrl)",
"static" : false,
- "memberOf" : "Roo.BorderLayout",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "provider",
- "type" : "Roo.state.Provider",
- "desc" : "(optional) An alternate state provider",
+ "name" : "defaultUrl",
+ "type" : "String/Function",
+ "desc" : "The url or a function to call to get the url",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "showPanel",
+ "name" : "setRenderer",
"type" : "function",
- "desc" : "Searches all regions for a panel with the specified id and activates (shows) it.",
- "sig" : "(panelId)",
+ "desc" : "Set the content renderer for this UpdateManager. See {@link Roo.UpdateManager.BasicRenderer#render} for more details.",
+ "sig" : "(renderer)",
"static" : false,
- "memberOf" : "Roo.BorderLayout",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panelId",
- "type" : "String/ContentPanel",
- "desc" : "The panels id or the panel itself",
+ "name" : "renderer",
+ "type" : "Object",
+ "desc" : "The object implementing the render() method",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "showLoading",
+ "type" : "function",
+ "desc" : "Called to update the element to \"Loading\" state. Override to perform custom action.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "startAutoRefresh",
+ "type" : "function",
+ "desc" : "Set this element to auto refresh.",
+ "sig" : "(interval, url, params, callback, refreshNow)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The shown panel or null"
+ "name" : "interval",
+ "type" : "Number",
+ "desc" : "How often to update (in seconds).",
+ "isOptional" : false
+ },
+ {
+ "name" : "url",
+ "type" : "String/Function",
+ "desc" : "(optional) The url for this request or a function to call to get the url (Defaults to the last used url)",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The parameters to pass as either a url encoded string \"¶m1=1¶m2=2\" or as an object {param1: 1, param2: 2}",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)",
+ "isOptional" : false
+ },
+ {
+ "name" : "refreshNow",
+ "type" : "Boolean",
+ "desc" : "(optional) Whether to execute the refresh now, or wait the interval",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "stopAutoRefresh",
+ "type" : "function",
+ "desc" : "Stop auto refresh on this element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
"name" : "un",
}
],
"returns" : []
+ },
+ {
+ "name" : "update",
+ "type" : "function",
+ "desc" : "Performs an async request, updating this element with the response. If params are specified it uses POST, otherwise it uses GET.",
+ "sig" : "(url, params, callback, discardUrl)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "url",
+ "type" : "Object/String/Function",
+ "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\num.update({<br/>\n url: \"your-url.php\",<br/>\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string<br/>\n callback: yourFunction,<br/>\n scope: yourObject, //(optional scope) <br/>\n discardUrl: false, <br/>\n nocache: false,<br/>\n text: \"Loading...\",<br/>\n timeout: 30,<br/>\n scripts: false<br/>\n});\n</code></pre>\nThe only required property is url. The optional properties nocache, text and scripts\nare shorthand for disableCaching, indicatorText and loadScripts and are used to set their associated property on this UpdateManager instance.",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The parameters to pass as either a url encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess, oResponse)",
+ "isOptional" : false
+ },
+ {
+ "name" : "discardUrl",
+ "type" : "Boolean",
+ "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used url. If true, it will not store the url.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "updateElement",
+ "type" : "function",
+ "desc" : "Static convenience method. This method is deprecated in favor of el.load({url:'foo.php', ...}).\nUsage:\n<pre><code>Roo.UpdateManager.updateElement(\"my-div\", \"stuff.php\");</code></pre>",
+ "sig" : "(el, url, params, options)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "This has been deprecated: ",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element to update",
+ "isOptional" : false
+ },
+ {
+ "name" : "url",
+ "type" : "String",
+ "desc" : "The url",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) Url encoded param string or an object of name/value pairs",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) A config object with any of the UpdateManager properties you want to set - for example: {disableCaching:true, indicatorText: \"Loading data...\"}",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.Resizable" : {
- "props" : [
- {
- "name" : "adjustments",
- "type" : "Array/String",
- "desc" : "String \"auto\" or an array [width, height] with values to be <b>added</b> to the\nresize operation's new size (defaults to [0, 0])",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
+ "Roo.UpdateManager.BasicRenderer" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "animate",
- "type" : "Boolean",
- "desc" : "True to animate the resize (not compatible with dynamic sizing, defaults to false)",
+ "name" : "render",
+ "type" : "function",
+ "desc" : "This is called when the transaction is completed and it's time to update the element - The BasicRenderer\nupdates the elements innerHTML with the responseText - To perform a custom render (i.e. XML or JSON processing),\ncreate an object with a \"render(el, response)\" method and pass it to setRenderer on the UpdateManager.",
+ "sig" : "(el, response, updateManager, callback)",
+ "static" : false,
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "constrainTo",
- "type" : "String/HTMLElement/Element",
- "desc" : "Constrain the resize to a particular element",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableTrackOver",
- "type" : "Boolean",
- "desc" : "True to disable mouse tracking. This is only applied at config time. (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "draggable",
- "type" : "Boolean",
- "desc" : "Convenience to initialize drag drop (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "duration",
- "type" : "Number",
- "desc" : "Animation duration if animate = true (defaults to .35)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "dynamic",
- "type" : "Boolean",
- "desc" : "True to resize the element while dragging instead of using a proxy (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "Roo.Element",
+ "desc" : "The element being rendered",
+ "isOptional" : false
+ },
+ {
+ "name" : "response",
+ "type" : "Object",
+ "desc" : "The YUI Connect response object",
+ "isOptional" : false
+ },
+ {
+ "name" : "updateManager",
+ "type" : "UpdateManager",
+ "desc" : "The calling update manager",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "A callback that will need to be called if loadScripts is true on the UpdateManager",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.UpdateManager.defaults" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.View" : {
+ "props" : [
{
- "name" : "easing",
+ "name" : "dataName",
"type" : "String",
- "desc" : "Animation easing if animate = true (defaults to 'easingOutStrong')",
+ "desc" : "the named area of the template to use as the data area\n Works with domtemplates roo-name=\"name\"",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "enabled",
- "type" : "Boolean",
- "desc" : "False to disable resizing (defaults to true)",
+ "name" : "el",
+ "type" : "String|Roo.Element",
+ "desc" : "The container element.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "handles",
+ "name" : "emptyText",
"type" : "String",
- "desc" : "String consisting of the resize handles to display (defaults to undefined)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "The height of the element in pixels (defaults to null)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "heightIncrement",
- "type" : "Number",
- "desc" : "The increment to snap the height resize in pixels (dynamic must be true, defaults to 0)",
+ "desc" : "The empty text to show when nothing is loaded.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"optvals" : []
},
{
- "name" : "maxHeight",
- "type" : "Number",
- "desc" : "The maximum height for the element (defaults to 10000)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxWidth",
- "type" : "Number",
- "desc" : "The maximum width for the element (defaults to 10000)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minHeight",
- "type" : "Number",
- "desc" : "The minimum height for the element (defaults to 5)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minWidth",
- "type" : "Number",
- "desc" : "The minimum width for the element (defaults to 5)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minX",
- "type" : "Number",
- "desc" : "The minimum allowed page X for the element (only used for west resizing, defaults to 0)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minY",
- "type" : "Number",
- "desc" : "The minimum allowed page Y for the element (only used for north resizing, defaults to 0)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "multiDirectional",
+ "name" : "multiSelect",
"type" : "Boolean",
- "desc" : "<b>Deprecated</b>. The old style of adding multi-direction resize handles, deprecated\nin favor of the handles config option (defaults to false)",
+ "desc" : "Allow multiple selection",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "pinned",
- "type" : "Boolean",
- "desc" : "True to ensure that the resize handles are always visible, false to display them only when the\nuser mouses over the resizable borders. This is only applied at config time. (defaults to false)",
+ "name" : "selectedClass",
+ "type" : "String",
+ "desc" : "The css class to add to selected nodes",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "preserveRatio",
+ "name" : "singleSelect",
"type" : "Boolean",
- "desc" : "True to preserve the original ratio between height and width during resize (defaults to false)",
+ "desc" : "Allow single selection",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "resizeChild",
- "type" : "Boolean/String/Element",
- "desc" : "True to resize the first child, or id/element to resize (defaults to false)",
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "Data store to load data from.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "resizeRegion",
- "type" : "Roo.lib.Region",
- "desc" : "Constrain the resize to a particular region",
+ "name" : "text",
+ "type" : "String",
+ "desc" : "to display on mask (default Loading)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "transparent",
+ "name" : "tickable",
"type" : "Boolean",
- "desc" : "True for transparent handles. This is only applied at config time. (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The width of the element in pixels (defaults to null)",
+ "desc" : "- selecting",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "widthIncrement",
- "type" : "Number",
- "desc" : "The increment to snap the width resize in pixels (dynamic must be true, defaults to 0)",
+ "name" : "toggleSelect",
+ "type" : "Boolean",
+ "desc" : "- selecting",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "wrap",
- "type" : "Boolean",
- "desc" : "True to wrap an element with a div if needed (required for textareas and images, defaults to false)",
+ "name" : "tpl",
+ "type" : "String|Roo.Template",
+ "desc" : "The template used by this View",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
],
"events" : [
{
- "name" : "beforeresize",
+ "name" : "beforeclick",
"type" : "function",
- "desc" : "Fired before resize is allowed. Set enabled to false to cancel resize.",
- "sig" : "function (_self, e)\n{\n\n}",
+ "desc" : "Fires before a click is processed. Returns false to cancel the default action.",
+ "sig" : "function (_self, index, node, e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Resizable",
+ "type" : "Roo.View",
"desc" : "",
"isOptional" : false
},
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the target node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "HTMLElement",
+ "desc" : "The target node",
+ "isOptional" : false
+ },
{
"name" : "e",
"type" : "Roo.EventObject",
- "desc" : "The mousedown event",
+ "desc" : "The raw event object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resize",
+ "name" : "beforeselect",
"type" : "function",
- "desc" : "Fired after a resize.",
- "sig" : "function (_self, width, height, e)\n{\n\n}",
+ "desc" : "Fires before a selection is made. If any handlers return false, the selection is cancelled.",
+ "sig" : "function (_self, node, selections)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Resizable",
+ "type" : "Roo.View",
"desc" : "",
"isOptional" : false
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "The new width",
+ "name" : "node",
+ "type" : "HTMLElement",
+ "desc" : "The node to be selected",
"isOptional" : false
},
{
- "name" : "height",
+ "name" : "selections",
+ "type" : "Array",
+ "desc" : "Array of currently selected nodes",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "Fires when a template node is clicked.",
+ "sig" : "function (_self, index, node, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.View",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
"type" : "Number",
- "desc" : "The new height",
+ "desc" : "The index of the target node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "HTMLElement",
+ "desc" : "The target node",
"isOptional" : false
},
{
"name" : "e",
"type" : "Roo.EventObject",
- "desc" : "The mouseup event",
+ "desc" : "The raw event object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resizing",
+ "name" : "contextmenu",
"type" : "function",
- "desc" : "Fired a resizing.",
- "sig" : "function (_self, x, y, w, h, e)\n{\n\n}",
+ "desc" : "Fires when a template node is right clicked.",
+ "sig" : "function (_self, index, node, e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Resizable",
+ "type" : "Roo.View",
"desc" : "",
"isOptional" : false
},
{
- "name" : "x",
+ "name" : "index",
"type" : "Number",
- "desc" : "The new x position",
+ "desc" : "The index of the target node",
"isOptional" : false
},
{
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
+ "name" : "node",
+ "type" : "HTMLElement",
+ "desc" : "The target node",
"isOptional" : false
},
{
- "name" : "w",
- "type" : "Number",
- "desc" : "The new w width",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The raw event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "dblclick",
+ "type" : "function",
+ "desc" : "Fires when a template node is double clicked.",
+ "sig" : "function (_self, index, node, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.View",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "h",
+ "name" : "index",
"type" : "Number",
- "desc" : "The new h hight",
+ "desc" : "The index of the target node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "HTMLElement",
+ "desc" : "The target node",
"isOptional" : false
},
{
"name" : "e",
"type" : "Roo.EventObject",
- "desc" : "The mouseup event",
+ "desc" : "The raw event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "preparedata",
+ "type" : "function",
+ "desc" : "Fires on every row to render, to allow you to change the data.",
+ "sig" : "function (_self, data)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.View",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "to be rendered (change this)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "selectionchange",
+ "type" : "function",
+ "desc" : "Fires when the selected nodes change.",
+ "sig" : "function (_self, selections)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.View",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "selections",
+ "type" : "Array",
+ "desc" : "Array of the selected nodes",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "clearSelections",
"type" : "function",
- "desc" : "Destroys this resizable. If the element was wrapped and\nremoveEl is not true then the element remains.",
- "sig" : "(removeEl)",
+ "desc" : "Clear all selections",
+ "sig" : "(suppressEvent)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "removeEl",
+ "name" : "suppressEvent",
"type" : "Boolean",
- "desc" : "(optional) true to remove the element from the DOM",
+ "desc" : "(optional) true to skip firing of the selectionchange event",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "findItemFromChild",
+ "type" : "function",
+ "desc" : "Returns the template node the passed child belongs to or null if it doesn't belong to one.",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "node",
+ "type" : "HTMLElement",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "The template node"
+ }
+ ]
+ },
{
"name" : "fireEvent",
"type" : "function",
{
"name" : "getEl",
"type" : "function",
- "desc" : "Returns the element this component is bound to.",
+ "desc" : "Returns the element this view is bound to.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
]
},
{
- "name" : "getResizeChild",
+ "name" : "getNode",
"type" : "function",
- "desc" : "Returns the resizeChild element (or null).",
+ "desc" : "Gets a template node.",
+ "sig" : "(nodeInfo)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "nodeInfo",
+ "type" : "HTMLElement/String/Number",
+ "desc" : "An HTMLElement template node, index of a template node or the id of a template node",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "The node or null if it wasn't found"
+ }
+ ]
+ },
+ {
+ "name" : "getNodes",
+ "type" : "function",
+ "desc" : "Gets a range template nodes.",
+ "sig" : "(startIndex, endIndex)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "startIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "endIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "An array of nodes"
+ }
+ ]
+ },
+ {
+ "name" : "getSelectedIndexes",
+ "type" : "function",
+ "desc" : "Get the indexes of the selected nodes.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
+ "type" : "Array",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getSelectedNodes",
+ "type" : "function",
+ "desc" : "Get the currently selected nodes.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "An array of HTMLElements"
+ }
+ ]
+ },
+ {
+ "name" : "getSelectionCount",
+ "type" : "function",
+ "desc" : "Get the number of selected nodes.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
"desc" : ""
}
]
}
]
},
+ {
+ "name" : "indexOf",
+ "type" : "function",
+ "desc" : "Finds the index of the passed node",
+ "sig" : "(nodeInfo)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "nodeInfo",
+ "type" : "HTMLElement/String/Number",
+ "desc" : "An HTMLElement template node, index of a template node or the id of a template node",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The index of the node or -1"
+ }
+ ]
+ },
+ {
+ "name" : "isSelected",
+ "type" : "function",
+ "desc" : "Returns true if the passed node is selected",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "node",
+ "type" : "HTMLElement/Number",
+ "desc" : "The node or node index",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
+ },
{
"name" : "on",
"type" : "function",
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "onBeforeLoad",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "onbeforeLoad - masks the loading area.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "prepareData",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Function to override to reformat the data that is sent to\nthe template for each node.\nDEPRICATED - use the preparedata event handler.",
+ "sig" : "(data)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "data",
+ "type" : "Array/Object",
+ "desc" : "The raw data (array of colData for a data model bound view or\na JSON object for an UpdateManager bound view).",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "resizeTo",
+ "name" : "refresh",
"type" : "function",
- "desc" : "Perform a manual resize",
- "sig" : "(width, height)",
+ "desc" : "Refreshes the view. - called by datachanged on the store. - do not call directly.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "refreshNode",
+ "type" : "function",
+ "desc" : "Refresh an individual node.",
+ "sig" : "(index)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "width",
+ "name" : "index",
"type" : "Number",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "height",
- "type" : "Number",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "un",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
+ "desc" : "Removes a listener",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.Shadow" : {
- "props" : [
- {
- "name" : "mode",
- "type" : "String",
- "desc" : "The shadow display mode. Supports the following options:<br />\nsides: Shadow displays on both sides and bottom only<br />\nframe: Shadow displays equally on all four sides<br />\ndrop: Traditional bottom-right drop shadow (default)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
},
{
- "name" : "offset",
- "type" : "String",
- "desc" : "The number of pixels to offset the shadow from the element (defaults to 4)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
- {
- "name" : "hide",
+ "name" : "select",
"type" : "function",
- "desc" : "Hides this shadow",
- "sig" : "()\n{\n\n}",
+ "desc" : "Selects nodes.",
+ "sig" : "(nodeInfo, keepExisting, suppressEvent)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "nodeInfo",
+ "type" : "Array/HTMLElement/String/Number",
+ "desc" : "An HTMLElement template node, index of a template node, id of a template node or an array of any of those to select",
+ "isOptional" : false
+ },
+ {
+ "name" : "keepExisting",
+ "type" : "Boolean",
+ "desc" : "(optional) true to keep existing selections",
+ "isOptional" : false
+ },
+ {
+ "name" : "suppressEvent",
+ "type" : "Boolean",
+ "desc" : "(optional) true to skip firing of the selectionchange vent",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "isVisible",
+ "name" : "setStore",
"type" : "function",
- "desc" : "Returns true if the shadow is visible, else false",
- "sig" : "()\n{\n\n}",
+ "desc" : "Changes the data store this view uses and refresh the view.",
+ "sig" : "(store)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "store",
+ "type" : "Store",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "realign",
+ "name" : "un",
"type" : "function",
- "desc" : "Direct alignment when values are already available. Show must be called at least once before\ncalling this method to ensure it is initialized.",
- "sig" : "(left, top, width, height)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "left",
- "type" : "Number",
- "desc" : "The target element left position",
- "isOptional" : false
- },
- {
- "name" : "top",
- "type" : "Number",
- "desc" : "The target element top position",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "The target element width",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "The target element height",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setZIndex",
+ "name" : "unselect",
"type" : "function",
- "desc" : "Adjust the z-index of this shadow",
- "sig" : "(zindex)",
+ "desc" : "Unselects nodes.",
+ "sig" : "(nodeInfo, keepExisting, suppressEvent)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "zindex",
- "type" : "Number",
- "desc" : "The new z-index",
+ "name" : "nodeInfo",
+ "type" : "Array/HTMLElement/String/Number",
+ "desc" : "An HTMLElement template node, index of a template node, id of a template node or an array of any of those to select",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Displays the shadow under the target element",
- "sig" : "(targetEl)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "targetEl",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id or element under which the shadow should display",
+ "name" : "keepExisting",
+ "type" : "Boolean",
+ "desc" : "(optional) true IGNORED (for campatibility with select)",
+ "isOptional" : false
+ },
+ {
+ "name" : "suppressEvent",
+ "type" : "Boolean",
+ "desc" : "(optional) true to skip firing of the selectionchange vent",
"isOptional" : false
}
],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
+ "implementations" : [
+ "Roo.JsonView"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.SplitBar" : {
+ "Roo.XComponent" : {
"props" : [
+ {
+ "name" : "disabled",
+ "type" : "Function|boolean",
+ "desc" : "If this module is disabled by some rule, return true from the funtion",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "items",
+ "type" : "Array",
+ "desc" : "A single item array - the first element is the root of the tree..\nIt's done this way to stay compatible with the Xtype system...",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
- }
- ],
- "events" : [
+ },
{
- "name" : "beforeresize",
- "type" : "function",
- "desc" : "Fires before the splitter is dragged",
- "sig" : "function (_self)\n{\n\n}",
+ "name" : "name",
+ "type" : "String",
+ "desc" : "String to display while loading.",
"memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.SplitBar",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "moved",
- "type" : "function",
- "desc" : "Fires when the splitter is moved",
- "sig" : "function (_self, newSize)\n{\n\n}",
+ "name" : "order",
+ "type" : "String",
+ "desc" : "Used to set the order in which elements are created (usefull for multiple tabs)",
"memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.SplitBar",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newSize",
- "type" : "Number",
- "desc" : "the new width or height",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "resize",
+ "name" : "parent",
+ "type" : "String",
+ "desc" : "Name of parent element which it get xtype added to..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "region",
+ "type" : "String",
+ "desc" : "Region to render component to (defaults to center)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "built",
"type" : "function",
- "desc" : "Fires when the splitter is moved (alias for {@link #event-moved})",
- "sig" : "function (_self, newSize)\n{\n\n}",
+ "desc" : "Fires when this the componnt is built",
+ "sig" : "function (c)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.SplitBar",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newSize",
- "type" : "Number",
- "desc" : "the new width or height",
+ "name" : "c",
+ "type" : "Roo.XComponent",
+ "desc" : "the component",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "build",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
+ "desc" : "Build the registered modules.",
+ "sig" : "(parent, optional)",
"static" : true,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
+ "name" : "parent",
+ "type" : "Object",
+ "desc" : "element.",
"isOptional" : false
},
{
- "name" : "fn",
+ "name" : "optional",
"type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "desc" : "method to call after module has been added.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "buildOrder",
"type" : "function",
- "desc" : "Destroy this splitbar.",
- "sig" : "(removeEl)",
- "static" : false,
+ "desc" : "make a list of modules to build.",
+ "sig" : "()\n{\n\n}",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "list of modules."
+ }
+ ]
+ },
+ {
+ "name" : "capture",
+ "type" : "function",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "removeEl",
- "type" : "Boolean",
- "desc" : "True to remove the element",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
]
},
{
- "name" : "getAdapter",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Get the adapter this SplitBar uses",
- "sig" : "()\n{\n\n}",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "",
- "desc" : "The adapter object"
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "getMaximumSize",
+ "name" : "overlayStrings",
"type" : "function",
- "desc" : "Gets the maximum size for the resizing element",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "desc" : "Overlay a set of modified strings onto a component\nThis is dependant on our builder exporting the strings and 'named strings' elements.",
+ "sig" : "(element, associative)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Number",
- "desc" : "The maximum size"
+ "name" : "element",
+ "type" : "Object",
+ "desc" : "to overlay on - eg. Pman.Dialog.Login",
+ "isOptional" : false
+ },
+ {
+ "name" : "associative",
+ "type" : "Object",
+ "desc" : "array of 'named' string and it's new value.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getMinimumSize",
+ "name" : "preBuild",
"type" : "function",
- "desc" : "Gets the minimum size for the resizing element",
+ "desc" : "move modules into their correct place in the tree..",
"sig" : "()\n{\n\n}",
- "static" : false,
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "The minimum size"
- }
- ]
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "register",
+ "type" : "function",
+ "desc" : "Register components to be built later.\n\nThis solves the following issues\n- Building is not done on page load, but after an authentication process has occured.\n- Interface elements are registered on page load\n- Parent Interface elements may not be loaded before child, so this handles that..\n\n\nexample:\n\nMyApp.register({\n order : '000001',\n module : 'Pman.Tab.projectMgr',\n region : 'center',\n parent : 'Pman.layout',\n disabled : false, // or use a function..\n })\n* @param {Object} details about module",
+ "sig" : "()\n{\n\n}",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "on",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "render",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "render\nrender element to dom or tree",
+ "sig" : "(optional)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "optional",
+ "type" : "Roo.Element|String|DomElement",
+ "desc" : "render to if parent is not set.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "toObject",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
+ "desc" : "convert a string to an object..\neg. 'AAA.BBB' -> finds AAA.BBB",
+ "sig" : "()\n{\n\n}",
"static" : true,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "un",
"type" : "function",
- "desc" : "Removes a listener",
+ "desc" : "Removes a listener (shorthand for removeListener)",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
}
],
"returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.XComponent.event.events" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.XTemplate" : {
+ "props" : [
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "The HTML fragment or an array of fragments to join(\"\") or multiple arguments to join(\"\")",
+ "memberOf" : "Roo.Template",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "setAdapter",
+ "name" : "onLoad",
+ "type" : "Function",
+ "desc" : "Called after the template has been loaded and complied (usually from a remove source)",
+ "memberOf" : "Roo.Template",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "url",
+ "type" : "String",
+ "desc" : "The Url to load the template from. beware if you are loading from a url, the data may not be ready if you use it instantly..\n it should be fixed so that template is observable...",
+ "memberOf" : "Roo.Template",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "append",
"type" : "function",
- "desc" : "Set the adapter this SplitBar uses",
- "sig" : "(adapter)",
+ "desc" : "Applies the supplied values to the template and appends the new node(s) to el.",
+ "sig" : "(el, values, returnElement)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Template",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "adapter",
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The context element",
+ "isOptional" : false
+ },
+ {
+ "name" : "values",
"type" : "Object",
- "desc" : "A SplitBar adapter object",
+ "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnElement",
+ "type" : "Boolean",
+ "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
"isOptional" : false
}
],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The new node or Element"
+ }
+ ]
+ },
+ {
+ "name" : "apply",
+ "type" : "function",
+ "desc" : "Alias for {@link #applyTemplate}",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Template",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "setCurrentSize",
+ "name" : "applySubTemplate",
"type" : "function",
- "desc" : "Sets the initialize size for the resizing element",
- "sig" : "(size)",
+ "desc" : "same as applyTemplate, except it's done to one of the subTemplates\nwhen using named templates, you can do:\n\nvar str = pl.applySubTemplate('your-name', values);",
+ "sig" : "(id, values, parent)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "size",
+ "name" : "id",
"type" : "Number",
- "desc" : "The initial size",
+ "desc" : "of the template",
+ "isOptional" : false
+ },
+ {
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "to apply to template",
+ "isOptional" : false
+ },
+ {
+ "name" : "parent",
+ "type" : "Object",
+ "desc" : "(normaly the instance of this object)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setMaximumSize",
+ "name" : "applyTemplate",
"type" : "function",
- "desc" : "Sets the maximum size for the resizing element",
- "sig" : "(maxSize)",
+ "desc" : "Returns an HTML fragment of this template with the specified values applied.",
+ "sig" : "(values)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Template",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "maxSize",
- "type" : "Number",
- "desc" : "The maximum size",
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "The HTML fragment"
+ }
+ ]
},
{
- "name" : "setMinimumSize",
+ "name" : "compile",
"type" : "function",
- "desc" : "Sets the minimum size for the resizing element",
- "sig" : "(minSize)",
+ "desc" : "compile the template\n\nThis is not recursive, so I'm not sure how nested templates are really going to be handled..",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "from",
+ "type" : "function",
+ "desc" : "Creates a template from the passed element's value (<i>display:none</i> textarea, preferred) or innerHTML.",
+ "sig" : "(el)",
+ "static" : true,
+ "memberOf" : "Roo.Template",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "minSize",
- "type" : "Number",
- "desc" : "The minimum size",
+ "name" : "el",
+ "type" : "String/HTMLElement",
+ "desc" : "A DOM element or its id",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "un",
+ "name" : "insertAfter",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Applies the supplied values to the template and inserts the new node(s) after el.",
+ "sig" : "(el, values, returnElement)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Template",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The context element",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "returnElement",
+ "type" : "Boolean",
+ "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.SplitBar.AbsoluteLayoutAdapter" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The new node or Element"
+ }
+ ]
+ },
{
- "name" : "getElementSize",
+ "name" : "insertBefore",
"type" : "function",
- "desc" : "Called before drag operations to get the current size of the resizing element.",
- "sig" : "(s)",
+ "desc" : "Applies the supplied values to the template and inserts the new node(s) before el.",
+ "sig" : "(el, values, returnElement)",
"static" : false,
- "memberOf" : "Roo.SplitBar.BasicLayoutAdapter",
+ "memberOf" : "Roo.Template",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "s",
- "type" : "Roo.SplitBar",
- "desc" : "The SplitBar using this adapter",
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The context element",
+ "isOptional" : false
+ },
+ {
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnElement",
+ "type" : "Boolean",
+ "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The new node or Element"
+ }
+ ]
},
{
- "name" : "setElementSize",
+ "name" : "insertFirst",
"type" : "function",
- "desc" : "Called after drag operations to set the size of the resizing element.",
- "sig" : "(s, newSize, onComplete)",
+ "desc" : "Applies the supplied values to the template and inserts the new node(s) as the first child of el.",
+ "sig" : "(el, values, returnElement)",
"static" : false,
- "memberOf" : "Roo.SplitBar.BasicLayoutAdapter",
+ "memberOf" : "Roo.Template",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "s",
- "type" : "Roo.SplitBar",
- "desc" : "The SplitBar using this adapter",
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The context element",
"isOptional" : false
},
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new size to set",
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
"isOptional" : false
},
{
- "name" : "onComplete",
- "type" : "Function",
- "desc" : "A function to be invoked when resizing is complete",
+ "name" : "returnElement",
+ "type" : "Boolean",
+ "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.SplitBar.BasicLayoutAdapter" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The new node or Element"
+ }
+ ]
+ },
{
- "name" : "getElementSize",
+ "name" : "overwrite",
"type" : "function",
- "desc" : "Called before drag operations to get the current size of the resizing element.",
- "sig" : "(s)",
+ "desc" : "Applies the supplied values to the template and overwrites the content of el with the new node(s).",
+ "sig" : "(el, values, returnElement)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Template",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "s",
- "type" : "Roo.SplitBar",
- "desc" : "The SplitBar using this adapter",
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The context element",
+ "isOptional" : false
+ },
+ {
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnElement",
+ "type" : "Boolean",
+ "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The new node or Element"
+ }
+ ]
},
{
- "name" : "setElementSize",
+ "name" : "set",
"type" : "function",
- "desc" : "Called after drag operations to set the size of the resizing element.",
- "sig" : "(s, newSize, onComplete)",
+ "desc" : "Sets the HTML used as the template and optionally compiles it.",
+ "sig" : "(html, compile)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Template",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "s",
- "type" : "Roo.SplitBar",
- "desc" : "The SplitBar using this adapter",
- "isOptional" : false
- },
- {
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new size to set",
+ "name" : "html",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "onComplete",
- "type" : "Function",
- "desc" : "A function to be invoked when resizing is complete",
+ "name" : "compile",
+ "type" : "Boolean",
+ "desc" : "(optional) True to compile the template (defaults to undefined)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Template",
+ "desc" : "this"
+ }
+ ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.SplitBar.AbsoluteLayoutAdapter"
- ],
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.SplitButton" : {
+ "Roo.bootstrap" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.Alert" : {
"props" : [
{
- "name" : "arrowHandler",
- "type" : "Function",
- "desc" : "A function called when the arrow button is clicked (can be used instead of click event)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "arrowTooltip",
- "type" : "String",
- "desc" : "The title attribute of the arrow",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "clickEvent",
- "type" : "String",
- "desc" : "The type of event to map to the button's event handler (defaults to 'click')",
- "memberOf" : "Roo.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cls",
+ "name" : "actionMode",
"type" : "String",
- "desc" : "A CSS class to apply to the button's main element.",
- "memberOf" : "Roo.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "True to start disabled (defaults to false)",
- "memberOf" : "Roo.Button",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "enableToggle",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "True to enable pressed/not pressed toggling (defaults to false)",
- "memberOf" : "Roo.Button",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "handleMouseEvents",
+ "name" : "can_build_overlaid",
"type" : "Boolean",
- "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
- "memberOf" : "Roo.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "A function called when the button is clicked (can be used instead of click event)",
- "memberOf" : "Roo.Button",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hidden",
+ "name" : "close",
"type" : "Boolean",
- "desc" : "True to start hidden (defaults to false)",
- "memberOf" : "Roo.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "icon",
- "type" : "String",
- "desc" : "The path to an image to display in the button (the image will be set as the background-image\nCSS property of the button by default, so if you want a mixed icon/text button, set cls:\"x-btn-text-icon\")",
- "memberOf" : "Roo.Button",
+ "desc" : "true to show a x closer",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "iconCls",
+ "name" : "cls",
"type" : "String",
- "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
- "memberOf" : "Roo.Button",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "menu",
- "type" : "Roo.menu.Menu",
- "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
- "memberOf" : "Roo.Button",
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "menuAlign",
+ "name" : "disableClass",
"type" : "String",
- "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').",
- "memberOf" : "Roo.Button",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "minWidth",
- "type" : "Number",
- "desc" : "The minimum width for this button (used to give a set of buttons a common width)",
- "memberOf" : "Roo.Button",
+ "name" : "fa",
+ "type" : "String",
+ "desc" : "font-awesomeicon",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "pressed",
- "type" : "Boolean",
- "desc" : "True to start pressed (only if enableToggle = true)",
- "memberOf" : "Roo.Button",
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "renderTo",
- "type" : "String/HTMLElement/Element",
- "desc" : "The element to append the button to",
- "memberOf" : "Roo.Button",
+ "name" : "html",
+ "type" : "String",
+ "desc" : "The content of alert",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "repeat",
- "type" : "Boolean/Object",
- "desc" : "True to repeat fire the click event while the mouse is down. This can also be\n an {@link Roo.util.ClickRepeater} config object (defaults to false).",
- "memberOf" : "Roo.Button",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "The scope of the handler",
- "memberOf" : "Roo.Button",
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tabIndex",
+ "name" : "seconds",
"type" : "Number",
- "desc" : "The DOM tabIndex for this button (defaults to undefined)",
- "memberOf" : "Roo.Button",
+ "desc" : "default:-1 Number of seconds until it disapears (-1 means never.)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "template",
- "type" : "Roo.Template",
- "desc" : "An {@link Roo.Template} with which to create the Button's main element. This Template must\ncontain numeric substitution parameter 0 if it is to display the tRoo property. Changing the template could\nrequire code modifications if required elements (e.g. a button) aren't present.",
- "memberOf" : "Roo.Button",
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "text",
+ "name" : "title",
"type" : "String",
- "desc" : "The button text",
- "memberOf" : "Roo.Button",
+ "desc" : "The title of alert",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "toggleGroup",
- "type" : "String",
- "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
- "memberOf" : "Roo.Button",
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tooltip",
- "type" : "String/Object",
- "desc" : "The tooltip for the button - can be a string or QuickTips config object",
- "memberOf" : "Roo.Button",
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
- "name" : "tooltipType",
+ "name" : "weight",
"type" : "String",
- "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
- "memberOf" : "Roo.Button",
+ "desc" : "r) Weight of the messa",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "success",
+ "info",
+ "warning",
+ "danger"
+ ]
},
{
- "name" : "type",
- "type" : "String",
- "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
- "memberOf" : "Roo.Button",
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
{
- "name" : "arrowclick",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fires when this button's arrow is clicked",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "SplitButton",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforehide",
+ "type" : "function",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "e",
- "type" : "EventObject",
- "desc" : "The click event",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "click",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires when this button is clicked",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.Button",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Button",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "e",
- "type" : "EventObject",
- "desc" : "The click event",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "mouseout",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires when the mouse exits the button",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.Button",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Button",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "mouseover",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires when the mouse hovers over the button",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.Button",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Button",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires when the button is rendered",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Button",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Button",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "toggle",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)",
- "sig" : "function (_self, pressed)\n{\n\n}",
- "memberOf" : "Roo.Button",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Button",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "pressed",
- "type" : "Boolean",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
{
"name" : "destroy",
"type" : "function",
- "desc" : "Destroys this Button and removes any listeners.",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Button",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "disable",
"type" : "function",
- "desc" : "Disable this button",
+ "desc" : "Disable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Button",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "enable",
"type" : "function",
- "desc" : "Enable this button",
+ "desc" : "Enable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Button",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "fireEvent",
{
"name" : "focus",
"type" : "function",
- "desc" : "Focus the button",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "getChildContainer",
+ "type" : "function",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
+ }
+ ]
},
{
"name" : "getEl",
"type" : "function",
- "desc" : "Returns the button's underlying element",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Button",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
]
},
{
- "name" : "getText",
+ "name" : "getId",
"type" : "function",
- "desc" : "Gets the text for this button",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Button",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "String",
- "desc" : "The button text"
+ "desc" : ""
}
]
},
+ {
+ "name" : "getVisibilityEl",
+ "type" : "function",
+ "desc" : "Get the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "hasListener",
"type" : "function",
{
"name" : "hide",
"type" : "function",
- "desc" : "Hide this button",
+ "desc" : "Hide the Alert",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Button",
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "initEvents",
+ "type" : "function",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "setArrowHandler",
+ "name" : "render",
"type" : "function",
- "desc" : "Sets this button's arrow click handler",
- "sig" : "(handler, scope)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The function to call when the arrow is clicked",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) Scope for the function passed above",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
{
"name" : "setDisabled",
"type" : "function",
- "desc" : "Convenience function for boolean enable/disable",
- "sig" : "(enabled)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "Roo.Button",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "enabled",
+ "name" : "disabled",
"type" : "Boolean",
- "desc" : "True to enable, false to disable",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setHandler",
+ "name" : "setHtml",
"type" : "function",
- "desc" : "Sets this button's click handler",
- "sig" : "(handler, scope)",
+ "desc" : "Set the Body Message HTML",
+ "sig" : "(html)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The function to call when the button is clicked",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) Scope for the function passed above",
+ "name" : "html",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setPressed",
+ "name" : "setIcon",
"type" : "function",
- "desc" : "Similar to toggle, but does not trigger event.",
- "sig" : "(state)",
+ "desc" : "Set the Icon of the alert",
+ "sig" : "(see)",
"static" : false,
- "memberOf" : "Roo.Button",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "state",
- "type" : "Boolean",
- "desc" : "[required] Force a particular state",
+ "name" : "see",
+ "type" : "String",
+ "desc" : "fontawsome names (name without the 'fa-' bit)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setText",
+ "name" : "setTitle",
"type" : "function",
- "desc" : "Sets this button's text",
- "sig" : "(text)",
+ "desc" : "Set the Title Message HTML",
+ "sig" : "(html)",
"static" : false,
- "memberOf" : "Roo.Button",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "text",
+ "name" : "html",
"type" : "String",
- "desc" : "The button text",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "setVisibilityEl",
+ "type" : "function",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "setVisible",
"type" : "function",
- "desc" : "Convenience function for boolean show/hide",
+ "desc" : "Convenience function to hide or show this component by boolean.",
"sig" : "(visible)",
"static" : false,
- "memberOf" : "Roo.Button",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"isOptional" : false
}
],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "setWeight",
+ "type" : "function",
+ "desc" : "Set the Weight of the alert",
+ "sig" : "((success|info|warning|danger))",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "(success|info|warning|danger)",
+ "type" : "String",
+ "desc" : "weight",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
"name" : "show",
"type" : "function",
- "desc" : "Show this button",
+ "desc" : "Show the Alert",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Button",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "toggle",
+ "name" : "tooltipEl",
"type" : "function",
- "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.",
- "sig" : "(state)",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Button",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "state",
- "type" : "Boolean",
- "desc" : "(optional) Force a particular state",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
- ],
- "returns" : []
+ ]
},
{
"name" : "un",
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.Toolbar.SplitButton"
- ],
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.SplitLayoutRegion" : {
+ "Roo.bootstrap.BezierSignature" : {
"props" : [
{
- "name" : "alwaysShowTabs",
- "type" : "Boolean",
- "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
- "memberOf" : "Roo.LayoutRegion",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "animate",
- "type" : "Boolean",
- "desc" : "True to animate expand/collapse (defaults to false)",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "Add",
+ "type" : "integer",
+ "desc" : "the next point only if the previous one is farther than x pixels. Defaults to 5.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "autoHide",
- "type" : "Boolean",
- "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "Callback",
+ "type" : "function",
+ "desc" : "when stroke begin.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "autoScroll",
- "type" : "Boolean",
- "desc" : "True to enable overflow scrolling (defaults to false)",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "Color",
+ "type" : "string",
+ "desc" : "used to draw the lines. Can be any color format accepted by context.fillStyle. Defaults to \"black\".",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "closeOnTab",
- "type" : "Boolean",
- "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "Draw",
+ "type" : "integer",
+ "desc" : "the next point at most once per every x milliseconds. Set it to 0 to turn off throttling. Defaults to 16.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "cmargins",
- "type" : "Object",
- "desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "Maximum",
+ "type" : "float",
+ "desc" : "width of a line. Defaults to 2.5.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "collapsed",
- "type" : "Boolean",
- "desc" : "True to set the initial display to collapsed (defaults to false)",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "Minimum",
+ "type" : "float",
+ "desc" : "width of a line. Defaults to 0.5.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "collapsedTitle",
- "type" : "String",
- "desc" : "Optional string message to display in the collapsed block of a north or south region",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "Radius",
+ "type" : "float|function",
+ "desc" : "of a single dot.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "collapsible",
- "type" : "Boolean",
- "desc" : "False to disable collapsing (defaults to true)",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "Weight",
+ "type" : "float",
+ "desc" : "used to modify new velocity based on the previous velocity. Defaults to 0.7.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disableTabTips",
- "type" : "Boolean",
- "desc" : "True to disable tab tooltips",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "floatable",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "False to disable floating (defaults to true)",
- "memberOf" : "Roo.LayoutRegion",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "For North/South panels",
- "memberOf" : "Roo.LayoutRegion",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hidden",
+ "name" : "can_build_overlaid",
"type" : "Boolean",
- "desc" : "True to start the region hidden (defaults to false)",
- "memberOf" : "Roo.LayoutRegion",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hideTabs",
- "type" : "Boolean",
- "desc" : "True to hide the tab strip (defaults to false)",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "canvas",
+ "type" : "int",
+ "desc" : "height",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hideWhenEmpty",
- "type" : "Boolean",
- "desc" : "True to hide the region when it has no panels",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "margins",
- "type" : "Object",
- "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "minTabWidth",
- "type" : "Number",
- "desc" : "The minimum tab width (defaults to 40)",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "preferredTabWidth",
- "type" : "Number",
- "desc" : "The preferred tab width (defaults to 150)",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "preservePanels",
- "type" : "Boolean",
- "desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "resizeTabs",
- "type" : "Boolean",
- "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "showPin",
- "type" : "Boolean",
- "desc" : "True to show a pin button",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "split",
- "type" : "Boolean",
- "desc" : "To show the splitter",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tabPosition",
- "type" : "String",
- "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : [
- "top",
- "bottom"
+ "el",
+ "parent"
]
},
{
- "name" : "title",
- "type" : "String",
- "desc" : "The title for the region (overrides panel titles)",
- "memberOf" : "Roo.LayoutRegion",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "titlebar",
- "type" : "Boolean",
- "desc" : "True to display a title bar (defaults to true)",
- "memberOf" : "Roo.LayoutRegion",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "toolbar",
- "type" : "Boolean",
- "desc" : "xtype configuration for a toolbar - shows on right of tabbar",
- "memberOf" : "Roo.LayoutRegion",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "For East/West panels",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
{
- "name" : "beforecollapse",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fires when this region before collapse.",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.LayoutRegion",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeremove",
- "type" : "function",
- "desc" : "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument.",
- "sig" : "function (_self, panel, e)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Object",
- "desc" : "The cancel event object",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "collapsed",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Fires when this region is collapsed.",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "expanded",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires when this region is expanded.",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "invalidated",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Fires when the layout for this region is changed.",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "panelactivated",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires when a panel is activated.",
- "sig" : "function (_self, panel)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The activated panel",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "paneladded",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires when a panel is added.",
- "sig" : "function (_self, panel)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "panelremoved",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires when a panel is removed.",
- "sig" : "function (_self, panel)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resized",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires when the user resizes this region.",
- "sig" : "function (_self, newSize)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new size (width for east/west, height for north/south)",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "slidehide",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires when this region slides out of view.",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "slideshow",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires when this region is slid into view.",
+ "desc" : "Fires after the component is rendered.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "visibilitychange",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires when this region is shown or hidden",
- "sig" : "function (_self, visibility)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "visibility",
- "type" : "Boolean",
- "desc" : "true or false",
- "isOptional" : false
}
],
"returns" : []
}
],
"methods" : [
- {
- "name" : "add",
- "type" : "function",
- "desc" : "Adds the passed ContentPanel(s) to this region.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "Roo.LayoutRegion",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "ContentPanel...",
- "desc" : "The ContentPanel(s) to add (you can pass more than one)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel added (if only one was added; null otherwise)"
- }
- ]
- },
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "collapse",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Collapses this region.",
- "sig" : "(skipAnim)",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "skipAnim",
- "type" : "Boolean",
- "desc" : "(optional) true to collapse the element without animation (if animate is true)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "expand",
+ "name" : "disable",
"type" : "function",
- "desc" : "Expands this region if it was previously collapsed.",
- "sig" : "(e, skipAnim)",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event that triggered the expand (or null if calling manually)",
- "isOptional" : false
- },
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "skipAnim",
- "type" : "Boolean",
- "desc" : "(optional) true to expand the element without animation (if animate is true)",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
"name" : "fireEvent",
]
},
{
- "name" : "getActivePanel",
+ "name" : "focus",
"type" : "function",
- "desc" : "Get the active panel for this region.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The active panel or null"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getEl",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Returns the container element for this region.",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Roo.Element",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getPanel",
- "type" : "function",
- "desc" : "Returns the panel specified or null if it's not in this region.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "Roo.BasicLayoutRegion",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : ""
+ "desc" : "defaults to this.el"
}
]
},
{
- "name" : "getPosition",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns this regions position (north/south/east/west/center).",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "getSplitBar",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns the {@link Roo.SplitBar} for this region.",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.SplitBar",
+ "type" : "String",
"desc" : ""
}
]
},
{
- "name" : "getTabs",
+ "name" : "getVisibilityEl",
"type" : "function",
- "desc" : "Returns the TabPanel component used by this region",
+ "desc" : "Get the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.TabPanel",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
"name" : "hasListener",
}
]
},
- {
- "name" : "hasPanel",
- "type" : "function",
- "desc" : "Returns true if the panel is in this region.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "Roo.BasicLayoutRegion",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
- },
{
"name" : "hide",
"type" : "function",
- "desc" : "Hides this region.",
+ "desc" : "Hide a component - adds 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "hidePanel",
+ "name" : "initEvents",
"type" : "function",
- "desc" : "Hides the tab for the specified panel.",
- "sig" : "(panel)",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
"name" : "isVisible",
"type" : "function",
- "desc" : "Returns true if this region is currently visible.",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
"name" : "on",
],
"returns" : []
},
- {
- "name" : "remove",
- "type" : "function",
- "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
- "sig" : "(panel, preservePanel)",
- "static" : false,
- "memberOf" : "Roo.LayoutRegion",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
- "isOptional" : false
- },
- {
- "name" : "preservePanel",
- "type" : "Boolean",
- "desc" : "Overrides the config preservePanel option",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel that was removed"
- }
- ]
- },
{
"name" : "removeListener",
"type" : "function",
"returns" : []
},
{
- "name" : "resizeTo",
+ "name" : "render",
"type" : "function",
- "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
- "sig" : "(newSize)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new width or height",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setCollapsedTitle",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)",
- "sig" : "(title)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "title",
- "type" : "String",
- "desc" : "(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, \"&#160;\")",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Shows this region if it was previously hidden.",
+ "desc" : "Set the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "showPanel",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Shows the specified panel.",
- "sig" : "(panelId)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panelId",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The shown panel, or null if a panel could not be found from panelId"
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
}
],
"returns" : []
- },
- {
- "name" : "unhidePanel",
- "type" : "function",
- "desc" : "Unhides the tab for a previously hidden panel.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "Roo.LayoutRegion",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.TabPanel" : {
+ "Roo.bootstrap.Body" : {
"props" : [
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
- }
- ],
- "events" : [
+ },
{
- "name" : "beforetabchange",
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fires before the active tab changes, set cancel to true on the \"e\" parameter to cancel the change",
- "sig" : "function (_self, e, tab)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.TabPanel",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Object",
- "desc" : "Set cancel to true on this object to cancel the tab change",
- "isOptional" : false
- },
- {
- "name" : "tab",
- "type" : "Roo.TabPanelItem",
- "desc" : "The tab being changed to",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "tabchange",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Fires when the active tab changes",
- "sig" : "function (_self, activePanel)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.TabPanel",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "activePanel",
- "type" : "Roo.TabPanelItem",
- "desc" : "The new active tab",
- "isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "activate",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Activates a {@link Roo.TabPanelItem}. The currently active one will be deactivated.",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to activate.",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.TabPanelItem",
- "desc" : "The TabPanelItem."
- }
- ]
+ "returns" : []
},
{
- "name" : "addEvents",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "this",
+ "type" : "Roo.bootstrap.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addTab",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Creates a new {@link Roo.TabPanelItem} by looking for an existing element with the provided id -- if it's not found it creates one.",
- "sig" : "(id, text, content, closable)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the div to use <b>or create</b>",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "text",
- "type" : "String",
- "desc" : "The text for the tab",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "content",
- "type" : "String",
- "desc" : "(optional) Content to put in the TabPanelItem body",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "closable",
- "type" : "Boolean",
- "desc" : "(optional) True to create a close icon on the tab",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.TabPanelItem",
- "desc" : "The created TabPanelItem"
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "addTabItem",
+ "name" : "show",
"type" : "function",
- "desc" : "Adds an existing {@link Roo.TabPanelItem}.",
- "sig" : "(item)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "item",
- "type" : "Roo.TabPanelItem",
- "desc" : "The TabPanelItem to add",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "autoSizeTabs",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Manual call to resize the tabs (if {@link #resizeTabs} is false this does nothing)",
- "sig" : "()\n{\n\n}",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "beginUpdate",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Disables tab resizing while tabs are being added (if {@link #resizeTabs} is false this does nothing)",
- "sig" : "()\n{\n\n}",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
{
"name" : "destroy",
"type" : "function",
- "desc" : "Destroys this TabPanel",
- "sig" : "(removeEl)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "removeEl",
- "type" : "Boolean",
- "desc" : "(optional) True to remove the element from the DOM as well (defaults to undefined)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "disableTab",
- "type" : "function",
- "desc" : "Disables a {@link Roo.TabPanelItem}. It cannot be the active tab, if it is this call is ignored.",
- "sig" : "(id)",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to disable.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "enableTab",
+ "name" : "disable",
"type" : "function",
- "desc" : "Enables a {@link Roo.TabPanelItem} that is disabled.",
- "sig" : "(id)",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to enable.",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "endUpdate",
+ "name" : "enable",
"type" : "function",
- "desc" : "Stops an update and resizes the tabs (if {@link #resizeTabs} is false this does nothing)",
+ "desc" : "Enable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "fireEvent",
]
},
{
- "name" : "getActiveTab",
+ "name" : "focus",
"type" : "function",
- "desc" : "Gets the active {@link Roo.TabPanelItem}.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.TabPanelItem",
- "desc" : "The active TabPanelItem or null if none are active."
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getCount",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Returns the number of tabs in this TabPanel.",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
{
- "name" : "getTab",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns the {@link Roo.TabPanelItem} with the specified id/index",
- "sig" : "(id)",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to fetch.",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
- ],
+ ]
+ },
+ {
+ "name" : "getId",
+ "type" : "function",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.TabPanelItem",
+ "type" : "String",
"desc" : ""
}
]
},
+ {
+ "name" : "getVisibilityEl",
+ "type" : "function",
+ "desc" : "Get the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "hasListener",
"type" : "function",
]
},
{
- "name" : "hideTab",
+ "name" : "hide",
"type" : "function",
- "desc" : "Hides the {@link Roo.TabPanelItem} with the specified id/index",
- "sig" : "(id)",
+ "desc" : "Hide a component - adds 'hidden' class",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to hide.",
- "isOptional" : false
- }
- ],
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "initEvents",
+ "type" : "function",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
"returns" : []
},
{
- "name" : "removeTab",
- "type" : "function",
- "desc" : "Removes a {@link Roo.TabPanelItem}.",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to remove.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setTabWidth",
+ "name" : "render",
"type" : "function",
- "desc" : "Resizes all the tabs to the passed width",
- "sig" : "(The)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "The",
- "type" : "Number",
- "desc" : "new width",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "syncHeight",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Updates the tab body element to fit the height of the container element\nfor overflow scrolling",
- "sig" : "(targetHeight)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "targetHeight",
- "type" : "Number",
- "desc" : "(optional) Override the starting height from the elements height",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "un",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "unhideTab",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "\"Unhides\" the {@link Roo.TabPanelItem} with the specified id/index.",
- "sig" : "(id)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to unhide.",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.TabPanelItem" : {
- "props" : [
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "activate",
- "type" : "function",
- "desc" : "Fires when this tab becomes the active tab.",
- "sig" : "function (tabPanel, _self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "tabPanel",
- "type" : "Roo.TabPanel",
- "desc" : "The parent TabPanel",
- "isOptional" : false
- },
- {
- "name" : "this",
- "type" : "Roo.TabPanelItem",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeclose",
- "type" : "function",
- "desc" : "Fires before this tab is closed. To cancel the close, set cancel to true on e (e.cancel = true).",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.TabPanelItem",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Object",
- "desc" : "Set cancel to true on this object to cancel the close.",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "close",
- "type" : "function",
- "desc" : "Fires when this tab is closed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.TabPanelItem",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "deactivate",
- "type" : "function",
- "desc" : "Fires when this tab is no longer the active tab.",
- "sig" : "function (tabPanel, _self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "tabPanel",
- "type" : "Roo.TabPanel",
- "desc" : "The parent TabPanel",
- "isOptional" : false
- },
- {
- "name" : "this",
- "type" : "Roo.TabPanelItem",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "methods" : [
- {
- "name" : "activate",
+ "name" : "show",
"type" : "function",
- "desc" : "Activates this TabPanelItem -- this <b>does</b> deactivate the currently active TabPanelItem.",
+ "desc" : "Show a component - removes 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "addEvents",
+ "name" : "tooltipEl",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "addListener",
+ "name" : "un",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : [
+ "none",
+ "builder"
+ ]
+ },
+ "Roo.bootstrap.Brick" : {
+ "props" : [
+ {
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "capture",
- "type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "bgimage",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "href",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "square",
+ "type" : "Boolean",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "video",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforedestroy",
+ "type" : "function",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforehide",
+ "type" : "function",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforerender",
+ "type" : "function",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "When a Brick is click",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Brick",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "capture",
+ "type" : "function",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
},
{
"name" : "scope",
"returns" : []
},
{
- "name" : "disable",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Disables this TabPanelItem -- this does nothing if this is the active TabPanelItem.",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
{
"name" : "enable",
"type" : "function",
- "desc" : "Enables this TabPanelItem if it was previously disabled.",
+ "desc" : "Enable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "fireEvent",
]
},
{
- "name" : "getText",
+ "name" : "focus",
"type" : "function",
- "desc" : "Returns the text for this tab",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "getChildContainer",
+ "type" : "function",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
{
- "name" : "getUpdateManager",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Gets the {@link Roo.UpdateManager} for the body of this TabPanelItem. Enables you to perform Ajax updates.",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.UpdateManager",
- "desc" : "The UpdateManager"
+ "type" : "Roo.Element",
+ "desc" : "The element"
+ }
+ ]
+ },
+ {
+ "name" : "getId",
+ "type" : "function",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
}
]
},
+ {
+ "name" : "getVisibilityEl",
+ "type" : "function",
+ "desc" : "Get the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "hasListener",
"type" : "function",
{
"name" : "hide",
"type" : "function",
- "desc" : "Hides this TabPanelItem -- if you don't activate another TabPanelItem this could look odd.",
+ "desc" : "Hide a component - adds 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "isActive",
+ "name" : "initEvents",
"type" : "function",
- "desc" : "Returns true if this tab is the active tab.",
+ "desc" : "Initialize Events for the element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "isHidden",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Returns true if this tab is \"hidden\"",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
"name" : "on",
"params" : [],
"returns" : []
},
- {
- "name" : "refresh",
- "type" : "function",
- "desc" : "Forces a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the setUrl method has not been called.\n This does not activate the panel, just updates its content.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "releaseCapture",
"type" : "function",
"returns" : []
},
{
- "name" : "setContent",
+ "name" : "render",
"type" : "function",
- "desc" : "Sets the content for this TabPanelItem.",
- "sig" : "(content, loadScripts)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "content",
- "type" : "String",
- "desc" : "The content",
- "isOptional" : false
- },
- {
- "name" : "loadScripts",
- "type" : "Boolean",
- "desc" : "true to look for and load scripts",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setHidden",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Show or hide the tab",
- "sig" : "(hidden)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "hidden",
+ "name" : "disabled",
"type" : "Boolean",
- "desc" : "True to hide or false to show.",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setText",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Sets the text for the tab (Note: this also sets the tooltip text)",
- "sig" : "(text)",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "text",
- "type" : "String",
- "desc" : "The tab's text and tooltip",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setTooltip",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Set the tooltip for the tab.",
- "sig" : "(tooltip)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "tooltip",
- "type" : "String",
- "desc" : "The tab's tooltip",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "setUrl",
+ "name" : "show",
"type" : "function",
- "desc" : "Set a URL to be used to load the content for this TabPanelItem.",
- "sig" : "(url, params, loadOnce)",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "url",
- "type" : "String/Function",
- "desc" : "The URL to load the content from, or a function to call to get the URL",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
- "isOptional" : false
- },
- {
- "name" : "loadOnce",
- "type" : "Boolean",
- "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this TabPanelItem is activated. (Defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.UpdateManager",
- "desc" : "The UpdateManager"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "show",
+ "name" : "tooltipEl",
"type" : "function",
- "desc" : "Shows this TabPanelItem -- this <b>does not</b> deactivate the currently active TabPanelItem.",
+ "desc" : "Fetch the element to display the tooltip on.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
+ }
+ ]
},
{
"name" : "un",
"tree_children" : [],
"tree_parent" : []
},
- "Roo.Template" : {
+ "Roo.bootstrap.Button" : {
"props" : [
{
- "name" : "html",
+ "name" : "actionMode",
"type" : "String",
- "desc" : "The HTML fragment or an array of fragments to join(\"\") or multiple arguments to join(\"\")",
- "memberOf" : "",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "onLoad",
- "type" : "Function",
- "desc" : "Called after the template has been loaded and complied (usually from a remove source)",
- "memberOf" : "",
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "url",
+ "name" : "badge",
"type" : "String",
- "desc" : "The Url to load the template from. beware if you are loading from a url, the data may not be ready if you use it instantly..\n it should be fixed so that template is observable...",
+ "desc" : "text for badge",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "append",
- "type" : "function",
- "desc" : "Applies the supplied values to the template and appends the new node(s) to el.",
- "sig" : "(el, values, returnElement)",
- "static" : false,
+ "name" : "badge_weight",
+ "type" : "String",
+ "desc" : "k) default (same as butto",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The context element",
- "isOptional" : false
- },
- {
- "name" : "values",
- "type" : "Object",
- "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
- "isOptional" : false
- },
- {
- "name" : "returnElement",
- "type" : "Boolean",
- "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The new node or Element"
- }
+ "isOptional" : false,
+ "optvals" : [
+ "default",
+ "primary",
+ "secondary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "link",
+ "light",
+ "dark"
]
},
{
- "name" : "apply",
- "type" : "function",
- "desc" : "Alias for {@link #applyTemplate}",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "applyTemplate",
- "type" : "function",
- "desc" : "Returns an HTML fragment of this template with the specified values applied.",
- "sig" : "(values)",
- "static" : false,
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "default false;",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "values",
- "type" : "Object",
- "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "The HTML fragment"
- }
- ]
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "compile",
- "type" : "function",
- "desc" : "Compiles the template into an internal function, eliminating the RegEx overhead.",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "name" : "fa",
+ "type" : "String",
+ "desc" : "fontawesome icon - eg. 'comment' - without the fa/fas etc..",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Template",
- "desc" : "this"
- }
- ]
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "from",
- "type" : "function",
- "desc" : "Creates a template from the passed element's value (<i>display:none</i> textarea, preferred) or innerHTML.",
- "sig" : "(el)",
- "static" : true,
+ "name" : "glyphicon",
+ "type" : "String",
+ "desc" : "depricated - use fa",
"memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "grpup",
+ "type" : "Boolean",
+ "desc" : "if parent is a btn group - then it turns it into a toogleGroup.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "href",
+ "type" : "String",
+ "desc" : "empty or href",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "The button content",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "dark themed version",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "isClose",
+ "type" : "Boolean",
+ "desc" : "default false;",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "menu",
+ "type" : "Roo.bootstrap.menu.Menu",
+ "desc" : "a Menu",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "offtext",
+ "type" : "String",
+ "desc" : "text for off slidy toggle state",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "ontext",
+ "type" : "String",
+ "desc" : "text for on slidy toggle state",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "outline",
+ "type" : "Boolean",
+ "desc" : "default false (except for weight=default which emulates old behaveiour with an outline)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "pressed",
+ "type" : "Boolean",
+ "desc" : "default null - if the button ahs active state",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "default true (stop click event triggering the URL if it's a link.)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "removeClass",
+ "type" : "Boolean",
+ "desc" : "remove the standard class..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "size",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "lg",
+ "sm",
+ "xs"
+ ]
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "a",
+ "input",
+ "submit"
+ ]
+ },
+ {
+ "name" : "target",
+ "type" : "String",
+ "desc" : "r) target for a hre",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "_self",
+ "_blank",
+ "_parent",
+ "_top",
+ "other"
+ ]
+ },
+ {
+ "name" : "theme",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "default",
+ "glow"
+ ]
+ },
+ {
+ "name" : "toggle",
+ "type" : "Boolean",
+ "desc" : "is it a slidy toggle button",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "k) defau",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "default",
+ "primary",
+ "secondary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "link",
+ "light",
+ "dark"
+ ]
+ },
+ {
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforedestroy",
+ "type" : "function",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement",
- "desc" : "A DOM element or its id",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "insertAfter",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Applies the supplied values to the template and inserts the new node(s) after el.",
- "sig" : "(el, values, returnElement)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The context element",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforerender",
+ "type" : "function",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "values",
- "type" : "Object",
- "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "returnElement",
- "type" : "Boolean",
- "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The new node or Element"
+ "name" : "this",
+ "type" : "Roo.bootstrap.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "insertBefore",
+ "name" : "click",
"type" : "function",
- "desc" : "Applies the supplied values to the template and inserts the new node(s) before el.",
- "sig" : "(el, values, returnElement)",
- "static" : false,
+ "desc" : "When a button is pressed",
+ "sig" : "function (btn, e)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The context element",
+ "name" : "btn",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "values",
- "type" : "Object",
- "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "dblclick",
+ "type" : "function",
+ "desc" : "When a button is double clicked",
+ "sig" : "function (btn, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "btn",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "returnElement",
- "type" : "Boolean",
- "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The new node or Element"
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "insertFirst",
+ "name" : "disable",
"type" : "function",
- "desc" : "Applies the supplied values to the template and inserts the new node(s) as the first child of el.",
- "sig" : "(el, values, returnElement)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The context element",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "values",
- "type" : "Object",
- "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "returnElement",
- "type" : "Boolean",
- "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The new node or Element"
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "overwrite",
+ "name" : "show",
"type" : "function",
- "desc" : "Applies the supplied values to the template and overwrites the content of el with the new node(s).",
- "sig" : "(el, values, returnElement)",
- "static" : false,
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "toggle",
+ "type" : "function",
+ "desc" : "After the button has been toggles",
+ "sig" : "function (btn, e, pressed)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The context element",
+ "name" : "btn",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "values",
- "type" : "Object",
- "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "returnElement",
- "type" : "Boolean",
- "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
+ "name" : "pressed",
+ "type" : "boolean",
+ "desc" : "(also available as button.pressed)",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The new node or Element"
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "set",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Sets the HTML used as the template and optionally compiles it.",
- "sig" : "(html, compile)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "html",
+ "name" : "eventName",
"type" : "String",
- "desc" : "",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "compile",
- "type" : "Boolean",
- "desc" : "(optional) True to compile the template (defaults to undefined)",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Template",
- "desc" : "this"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
}
- ]
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.DomTemplate",
- "Roo.MasterTemplate",
- "Roo.XTemplate"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.Toolbar" : {
- "props" : [
- {
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id or element that will contain the toolbar",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "items",
- "type" : "Array",
- "desc" : "array of button configs or elements to add (will be converted to a MixedCollection)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ ],
+ "returns" : []
},
{
- "name" : "text",
- "type" : "string",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
- {
- "name" : "add",
+ "name" : "capture",
"type" : "function",
- "desc" : "Adds element(s) to the toolbar -- this function takes a variable number of \narguments of mixed type and adds them to the toolbar.",
- "sig" : "(arg1, arg2)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"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>",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "arg2",
- "type" : "Mixed",
- "desc" : "",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addButton",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Adds a button (or buttons). See {@link Roo.Toolbar.Button} for more info on the config.",
- "sig" : "(config)",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this button",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "config",
- "type" : "Object/Array",
- "desc" : "A button config or array of configs",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Toolbar.Button/Array",
- "desc" : ""
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "addDom",
+ "name" : "enable",
"type" : "function",
- "desc" : "Adds a new element to the toolbar from the passed {@link Roo.DomHelper} config.",
- "sig" : "(config)",
+ "desc" : "Enables this button",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "fireEvent",
+ "type" : "function",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "config",
- "type" : "Object",
+ "name" : "eventName",
+ "type" : "String",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Toolbar.Item",
- "desc" : "The element's item"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "addElement",
+ "name" : "focus",
"type" : "function",
- "desc" : "Adds any standard HTML element to the toolbar",
- "sig" : "(el)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The element or id of the element to add",
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Toolbar.Item",
- "desc" : "The element's item"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "addField",
+ "name" : "getChildContainer",
"type" : "function",
- "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}.",
- "sig" : "(field)",
+ "desc" : "Fetch the element to add children to",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "field",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.ToolbarItem",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
{
- "name" : "addFill",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Adds a fill element that forces subsequent additions to the right side of the toolbar",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Toolbar.Fill",
- "desc" : "The fill item"
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "addItem",
+ "name" : "getId",
"type" : "function",
- "desc" : "Adds any Toolbar.Item or subclass",
- "sig" : "(item)",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "item",
- "type" : "Roo.Toolbar.Item",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Toolbar.Item",
- "desc" : "The item"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "addSeparator",
+ "name" : "getText",
"type" : "function",
- "desc" : "Adds a separator",
+ "desc" : "get the text of the first selected button",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Toolbar.Item",
- "desc" : "The separator item"
- }
- ]
+ "returns" : []
},
{
- "name" : "addSpacer",
+ "name" : "getVisibilityEl",
"type" : "function",
- "desc" : "Adds a spacer element",
+ "desc" : "Get the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Toolbar.Spacer",
- "desc" : "The spacer item"
- }
- ]
+ "returns" : []
},
{
- "name" : "addText",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Adds text to the toolbar",
- "sig" : "(text)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "text",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The text to add",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Toolbar.Item",
- "desc" : "The element's item"
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "addxtype",
+ "name" : "hide",
"type" : "function",
- "desc" : "Add an Xtype element",
- "sig" : "(xtype)",
+ "desc" : "Hide a component - adds 'hidden' class",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "xtype",
- "type" : "Object",
- "desc" : "Xtype Object",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "created Object"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "getEl",
+ "name" : "initEvents",
"type" : "function",
- "desc" : "Returns the Element for this toolbar.",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isActive",
+ "type" : "function",
+ "desc" : "get the current active state",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : ""
+ "type" : "boolean",
+ "desc" : "true if it's active"
}
]
},
{
- "name" : "hide",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Hide the toolbar",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "insertButton",
+ "name" : "on",
"type" : "function",
- "desc" : "Inserts any {@link Roo.Toolbar.Item}/{@link Roo.Toolbar.Button} at the specified index.",
- "sig" : "(index, item)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The index where the item is to be inserted",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"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.",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Toolbar.Button/Item",
- "desc" : ""
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "show",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Show the toolbar",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.PagingToolbar"
- ],
- "tree_children" : [
- "Roo.Toolbar.Item",
- "Roo.Toolbar.Fill",
- "Roo.Toolbar.Separator",
- "Roo.Toolbar.Spacer",
- "Roo.Toolbar.TextItem",
- "Roo.Toolbar.Button",
- "Roo.Toolbar.SplitButton",
- "Roo.form.Field",
- "Roo.form.Checkbox",
- "Roo.form.ComboBox",
- "Roo.form.ComboBoxArray",
- "Roo.form.ComboCheck",
- "Roo.form.ComboNested",
- "Roo.form.DateField",
- "Roo.form.DayPicker",
- "Roo.form.DisplayField",
- "Roo.form.FCKeditor",
- "Roo.form.GridField",
- "Roo.form.Hidden",
- "Roo.form.HtmlEditor",
- "Roo.form.MonthField",
- "Roo.form.NumberField",
- "Roo.form.Radio",
- "Roo.form.Select",
- "Roo.form.Signature",
- "Roo.form.TextArea",
- "Roo.form.TextField",
- "Roo.form.TriggerField"
- ],
- "tree_parent" : []
- },
- "Roo.Toolbar.Button" : {
- "props" : [
+ },
{
- "name" : "clickEvent",
- "type" : "String",
- "desc" : "The type of event to map to the button's event handler (defaults to 'click')",
- "memberOf" : "Roo.Button",
- "isOptional" : false,
- "optvals" : []
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "cls",
- "type" : "String",
- "desc" : "A CSS class to apply to the button's main element.",
- "memberOf" : "Roo.Button",
- "isOptional" : false,
- "optvals" : []
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "True to start disabled (defaults to false)",
- "memberOf" : "Roo.Button",
- "isOptional" : false,
- "optvals" : []
+ "name" : "render",
+ "type" : "function",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "enableToggle",
- "type" : "Boolean",
- "desc" : "True to enable pressed/not pressed toggling (defaults to false)",
- "memberOf" : "Roo.Button",
- "isOptional" : false,
- "optvals" : []
+ "name" : "setActive",
+ "type" : "function",
+ "desc" : "sets the active state on/off,",
+ "sig" : "(state)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "(optional) Force a particular state",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "handleMouseEvents",
- "type" : "Boolean",
- "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
- "memberOf" : "Roo.Button",
- "isOptional" : false,
- "optvals" : []
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "A function called when the button is clicked (can be used instead of click event)",
- "memberOf" : "Roo.Button",
- "isOptional" : false,
- "optvals" : []
+ "name" : "setText",
+ "type" : "function",
+ "desc" : "set the text of the first selected button",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "True to start hidden (defaults to false)",
- "memberOf" : "Roo.Button",
+ "name" : "setVisibilityEl",
+ "type" : "function",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "toggleActive",
+ "type" : "function",
+ "desc" : "toggles the current active state",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
+ }
+ ]
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.form.CardUploader"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.ButtonGroup" : {
+ "props" : [
+ {
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "icon",
+ "name" : "align",
"type" : "String",
- "desc" : "The path to an image to display in the button (the image will be set as the background-image\nCSS property of the button by default, so if you want a mixed icon/text button, set cls:\"x-btn-text-icon\")",
- "memberOf" : "Roo.Button",
+ "desc" : "vertical | justified (default none)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "iconCls",
- "type" : "String",
- "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
- "memberOf" : "Roo.Button",
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
+ "name" : "btn",
+ "type" : "Boolean",
+ "desc" : "true | false",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "menu",
- "type" : "Roo.menu.Menu",
- "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
- "memberOf" : "Roo.Button",
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "menuAlign",
+ "name" : "cls",
"type" : "String",
- "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').",
- "memberOf" : "Roo.Button",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "minWidth",
- "type" : "Number",
- "desc" : "The minimum width for this button (used to give a set of buttons a common width)",
- "memberOf" : "Roo.Button",
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "pressed",
- "type" : "Boolean",
- "desc" : "True to start pressed (only if enableToggle = true)",
- "memberOf" : "Roo.Button",
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "renderTo",
- "type" : "String/HTMLElement/Element",
- "desc" : "The element to append the button to",
- "memberOf" : "Roo.Button",
+ "name" : "direction",
+ "type" : "String",
+ "desc" : "up | down (default down)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "repeat",
- "type" : "Boolean/Object",
- "desc" : "True to repeat fire the click event while the mouse is down. This can also be\n an {@link Roo.util.ClickRepeater} config object (defaults to false).",
- "memberOf" : "Roo.Button",
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "scope",
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "listeners",
"type" : "Object",
- "desc" : "The scope of the handler",
- "memberOf" : "Roo.Button",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tabIndex",
- "type" : "Number",
- "desc" : "The DOM tabIndex for this button (defaults to undefined)",
- "memberOf" : "Roo.Button",
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "template",
- "type" : "Roo.Template",
- "desc" : "An {@link Roo.Template} with which to create the Button's main element. This Template must\ncontain numeric substitution parameter 0 if it is to display the tRoo property. Changing the template could\nrequire code modifications if required elements (e.g. a button) aren't present.",
- "memberOf" : "Roo.Button",
+ "name" : "size",
+ "type" : "String",
+ "desc" : "lg | sm | xs (default empty normal)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "text",
+ "name" : "style",
"type" : "String",
- "desc" : "The button text",
- "memberOf" : "Roo.Button",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "toggleGroup",
- "type" : "String",
- "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
- "memberOf" : "Roo.Button",
+ "name" : "toolbar",
+ "type" : "Boolean",
+ "desc" : "false | true",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
"name" : "tooltip",
- "type" : "String/Object",
- "desc" : "The tooltip for the button - can be a string or QuickTips config object",
- "memberOf" : "Roo.Button",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tooltipType",
- "type" : "String",
- "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
- "memberOf" : "Roo.Button",
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
- "name" : "type",
- "type" : "String",
- "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
- "memberOf" : "Roo.Button",
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
{
- "name" : "click",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fires when this button is clicked",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.Button",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Button",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforehide",
+ "type" : "function",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "e",
- "type" : "EventObject",
- "desc" : "The click event",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "mouseout",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires when the mouse exits the button",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.Button",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Button",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "mouseover",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires when the mouse hovers over the button",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.Button",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Button",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires when the button is rendered",
+ "desc" : "Fires after the component is disabled.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Button",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Button",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "toggle",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)",
- "sig" : "function (_self, pressed)\n{\n\n}",
- "memberOf" : "Roo.Button",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Button",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "pressed",
- "type" : "Boolean",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "addItem",
+ "type" : "function",
+ "desc" : "Add a button to the group (similar to NavItem API.)",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "addListener",
"type" : "function",
{
"name" : "destroy",
"type" : "function",
- "desc" : "Removes and destroys this button",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "disable",
"type" : "function",
- "desc" : "Disables this item",
+ "desc" : "Disable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "enable",
"type" : "function",
- "desc" : "Enables this item",
+ "desc" : "Enable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "fireEvent",
{
"name" : "focus",
"type" : "function",
- "desc" : "Focus the button",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "getChildContainer",
+ "type" : "function",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Button",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
+ }
+ ]
},
{
"name" : "getEl",
"type" : "function",
- "desc" : "Returns the button's underlying element",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Button",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
]
},
{
- "name" : "getText",
+ "name" : "getId",
"type" : "function",
- "desc" : "Gets the text for this button",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Button",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "String",
- "desc" : "The button text"
+ "desc" : ""
}
]
},
+ {
+ "name" : "getVisibilityEl",
+ "type" : "function",
+ "desc" : "Get the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "hasListener",
"type" : "function",
{
"name" : "hide",
"type" : "function",
- "desc" : "Hides this button",
+ "desc" : "Hide a component - adds 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "initEvents",
+ "type" : "function",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "setDisabled",
- "type" : "function",
- "desc" : "Convenience function for boolean enable/disable",
- "sig" : "(enabled)",
- "static" : false,
- "memberOf" : "Roo.Button",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "enabled",
- "type" : "Boolean",
- "desc" : "True to enable, false to disable",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setHandler",
+ "name" : "render",
"type" : "function",
- "desc" : "Assigns this button's click handler",
- "sig" : "(handler, scope)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.Button",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The function to call when the button is clicked",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) Scope for the function passed in",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setPressed",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Similar to toggle, but does not trigger event.",
- "sig" : "(state)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "Roo.Button",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "state",
+ "name" : "disabled",
"type" : "Boolean",
- "desc" : "[required] Force a particular state",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setText",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Sets this button's text",
- "sig" : "(text)",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Button",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "text",
- "type" : "String",
- "desc" : "The button text",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
"name" : "setVisible",
"type" : "function",
- "desc" : "Convenience function for boolean show/hide",
+ "desc" : "Convenience function to hide or show this component by boolean.",
"sig" : "(visible)",
"static" : false,
- "memberOf" : "Roo.Button",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "show",
"type" : "function",
- "desc" : "Shows this button",
+ "desc" : "Show a component - removes 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "toggle",
+ "name" : "tooltipEl",
"type" : "function",
- "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.",
- "sig" : "(state)",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Button",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "state",
- "type" : "Boolean",
- "desc" : "(optional) Force a particular state",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
- ],
- "returns" : []
+ ]
},
{
"name" : "un",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [],
+ "tree_children" : [
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.Form"
+ ],
"tree_parent" : []
},
- "Roo.Toolbar.Fill" : {
- "props" : [],
- "events" : [
+ "Roo.bootstrap.ButtonUploader" : {
+ "props" : [
{
- "name" : "render",
- "type" : "function",
- "desc" : "Fires when the button is rendered",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Toolbar.Item",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Button",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "methods" : [
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
- "name" : "destroy",
- "type" : "function",
- "desc" : "Removes and destroys this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Toolbar.Item",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "disable",
- "type" : "function",
- "desc" : "Disables this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Toolbar.Item",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
+ "name" : "badge",
+ "type" : "String",
+ "desc" : "text for badge",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "enable",
+ "name" : "badge_weight",
+ "type" : "String",
+ "desc" : "k) default (same as butto",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : [
+ "default",
+ "primary",
+ "secondary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "link",
+ "light",
+ "dark"
+ ]
+ },
+ {
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "default false;",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "errorTimeout",
+ "type" : "Number",
+ "desc" : "default 3000",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fa",
+ "type" : "String",
+ "desc" : "fontawesome icon - eg. 'comment' - without the fa/fas etc..",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "glyphicon",
+ "type" : "String",
+ "desc" : "depricated - use fa",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "grpup",
+ "type" : "Boolean",
+ "desc" : "if parent is a btn group - then it turns it into a toogleGroup.",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "href",
+ "type" : "String",
+ "desc" : "empty or href",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "html",
+ "type" : "Array",
+ "desc" : "The button text.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "images",
+ "type" : "Array",
+ "desc" : "an array of ?? Img objects ??? when loading existing files..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "dark themed version",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "isClose",
+ "type" : "Boolean",
+ "desc" : "default false;",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "menu",
+ "type" : "Roo.bootstrap.menu.Menu",
+ "desc" : "a Menu",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "multiple",
+ "type" : "Boolean",
+ "desc" : "(default true) Should the upload allow multiple files to be uploaded.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "offtext",
+ "type" : "String",
+ "desc" : "text for off slidy toggle state",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "ontext",
+ "type" : "String",
+ "desc" : "text for on slidy toggle state",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "outline",
+ "type" : "Boolean",
+ "desc" : "default false (except for weight=default which emulates old behaveiour with an outline)",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "pressed",
+ "type" : "Boolean",
+ "desc" : "default null - if the button ahs active state",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "default true (stop click event triggering the URL if it's a link.)",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "removeClass",
+ "type" : "Boolean",
+ "desc" : "remove the standard class..",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "size",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : [
+ "lg",
+ "sm",
+ "xs"
+ ]
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : [
+ "a",
+ "input",
+ "submit"
+ ]
+ },
+ {
+ "name" : "target",
+ "type" : "String",
+ "desc" : "r) target for a hre",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : [
+ "_self",
+ "_blank",
+ "_parent",
+ "_top",
+ "other"
+ ]
+ },
+ {
+ "name" : "theme",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : [
+ "default",
+ "glow"
+ ]
+ },
+ {
+ "name" : "toggle",
+ "type" : "Boolean",
+ "desc" : "is it a slidy toggle button",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "k) defau",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : [
+ "default",
+ "primary",
+ "secondary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "link",
+ "light",
+ "dark"
+ ]
+ },
+ {
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Enables this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Toolbar.Item",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "focus",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Try to focus this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Toolbar.Item",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "getEl",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Get this item's HTML Element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Toolbar.Item",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "HTMLElement",
- "desc" : ""
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hide",
+ "name" : "beforeselect",
"type" : "function",
- "desc" : "Hides this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Toolbar.Item",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "When button is pressed, before show upload files dialog is shown",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploaderButton",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Convenience function for boolean show/hide.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Toolbar.Item",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "true to show/false to hide",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Shows this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Toolbar.Item",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.Toolbar.Item" : {
- "props" : [],
- "events" : [
+ },
{
- "name" : "render",
+ "name" : "click",
"type" : "function",
- "desc" : "Fires when the button is rendered",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "When a button is pressed",
+ "sig" : "function (btn, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Button",
+ "name" : "btn",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "destroy",
+ "name" : "dblclick",
"type" : "function",
- "desc" : "Removes and destroys this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "When a button is double clicked",
+ "sig" : "function (btn, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "btn",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Disables this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "enable",
+ "name" : "disable",
"type" : "function",
- "desc" : "Enables this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "focus",
+ "name" : "enable",
"type" : "function",
- "desc" : "Try to focus this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "getEl",
+ "name" : "fired when files have been selected,",
"type" : "function",
- "desc" : "Get this item's HTML Element",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "desc" : "When a the download link is clicked",
+ "sig" : "function (_self, Array)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "HTMLElement",
- "desc" : ""
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploaderButton",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "Array",
+ "type" : "Array",
+ "desc" : "of files that have been uploaded",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
"name" : "hide",
"type" : "function",
- "desc" : "Hides this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "render",
"type" : "function",
- "desc" : "Convenience function for boolean show/hide.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "true to show/false to hide",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
{
"name" : "show",
"type" : "function",
- "desc" : "Shows this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.Toolbar.Fill",
- "Roo.Toolbar.Separator",
- "Roo.Toolbar.Spacer",
- "Roo.Toolbar.TextItem"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.Toolbar.Separator" : {
- "props" : [],
- "events" : [
+ },
{
- "name" : "render",
+ "name" : "toggle",
"type" : "function",
- "desc" : "Fires when the button is rendered",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Toolbar.Item",
+ "desc" : "After the button has been toggles",
+ "sig" : "function (btn, e, pressed)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Button",
+ "name" : "btn",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "pressed",
+ "type" : "boolean",
+ "desc" : "(also available as button.pressed)",
+ "isOptional" : false
}
],
"returns" : []
],
"methods" : [
{
- "name" : "destroy",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Removes and destroys this item.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.Toolbar.Item",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Disables this item.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.Toolbar.Item",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "enable",
+ "name" : "capture",
"type" : "function",
- "desc" : "Enables this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Toolbar.Item",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "focus",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Try to focus this item.",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Toolbar.Item",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "getEl",
+ "name" : "disable",
"type" : "function",
- "desc" : "Get this item's HTML Element",
+ "desc" : "Disable this button",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Toolbar.Item",
+ "memberOf" : "Roo.bootstrap.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "HTMLElement",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "hide",
+ "name" : "enable",
"type" : "function",
- "desc" : "Hides this item.",
+ "desc" : "Enables this button",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Toolbar.Item",
+ "memberOf" : "Roo.bootstrap.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Convenience function for boolean show/hide.",
- "sig" : "(visible)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.Toolbar.Item",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "true to show/false to hide",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "show",
+ "name" : "focus",
"type" : "function",
- "desc" : "Shows this item.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.Toolbar.Item",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.Toolbar.Spacer" : {
- "props" : [],
- "events" : [
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires when the button is rendered",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Toolbar.Item",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Button",
- "desc" : "",
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "methods" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
{
- "name" : "destroy",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Removes and destroys this item.",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Toolbar.Item",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
+ }
+ ]
},
{
- "name" : "disable",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Disables this item.",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Toolbar.Item",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "The element"
+ }
+ ]
},
{
- "name" : "enable",
+ "name" : "getId",
"type" : "function",
- "desc" : "Enables this item.",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Toolbar.Item",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "focus",
+ "name" : "getText",
"type" : "function",
- "desc" : "Try to focus this item.",
+ "desc" : "get the text of the first selected button",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Toolbar.Item",
+ "memberOf" : "Roo.bootstrap.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "getEl",
+ "name" : "getVisibilityEl",
"type" : "function",
- "desc" : "Get this item's HTML Element",
+ "desc" : "Get the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Toolbar.Item",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "HTMLElement",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "hide",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Hides this item.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.Toolbar.Item",
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Hide a component - adds 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "initEvents",
+ "type" : "function",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isActive",
+ "type" : "function",
+ "desc" : "get the current active state",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Button",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "boolean",
+ "desc" : "true if it's active"
+ }
+ ]
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "on",
+ "type" : "function",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "addCard - add an Attachment to the uploader",
+ "sig" : "(data)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "data",
+ "type" : "",
+ "desc" : "- the data about the image to upload\n\n{\n id : 123\n title : \"Title of file\",\n is_uploaded : false,\n src : \"http://.....\",\n srcfile : { the File upload object },\n mimetype : file.type,\n preview : false,\n is_deleted : 0\n .. any other data...\n }",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setActive",
+ "type" : "function",
+ "desc" : "sets the active state on/off,",
+ "sig" : "(state)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Button",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "(optional) Force a particular state",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setText",
+ "type" : "function",
+ "desc" : "set the text of the first selected button",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Button",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "setVisibilityEl",
+ "type" : "function",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "setVisible",
"type" : "function",
- "desc" : "Convenience function for boolean show/hide.",
+ "desc" : "Convenience function to hide or show this component by boolean.",
"sig" : "(visible)",
"static" : false,
- "memberOf" : "Roo.Toolbar.Item",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "visible",
"type" : "Boolean",
- "desc" : "true to show/false to hide",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "show",
"type" : "function",
- "desc" : "Shows this item.",
+ "desc" : "Show a component - removes 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Toolbar.Item",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "toggleActive",
+ "type" : "function",
+ "desc" : "toggles the current active state",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Button",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
+ }
+ ]
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
"returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.Toolbar.Fill"
- ],
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.Toolbar.SplitButton" : {
+ "Roo.bootstrap.Calendar" : {
"props" : [
{
- "name" : "arrowHandler",
- "type" : "Function",
- "desc" : "A function called when the arrow button is clicked (can be used instead of click event)",
- "memberOf" : "Roo.SplitButton",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "arrowTooltip",
- "type" : "String",
- "desc" : "The title attribute of the arrow",
- "memberOf" : "Roo.SplitButton",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "clickEvent",
+ "name" : "actionMode",
"type" : "String",
- "desc" : "The type of event to map to the button's event handler (defaults to 'click')",
- "memberOf" : "Roo.Button",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "cls",
- "type" : "String",
- "desc" : "A CSS class to apply to the button's main element.",
- "memberOf" : "Roo.Button",
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disabled",
+ "name" : "can_build_overlaid",
"type" : "Boolean",
- "desc" : "True to start disabled (defaults to false)",
- "memberOf" : "Roo.Button",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "enableToggle",
- "type" : "Boolean",
- "desc" : "True to enable pressed/not pressed toggling (defaults to false)",
- "memberOf" : "Roo.Button",
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "handleMouseEvents",
- "type" : "Boolean",
- "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
- "memberOf" : "Roo.Button",
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "A function called when the button is clicked (can be used instead of click event)",
- "memberOf" : "Roo.Button",
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "True to start hidden (defaults to false)",
- "memberOf" : "Roo.Button",
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "icon",
- "type" : "String",
- "desc" : "The path to an image to display in the button (the image will be set as the background-image\nCSS property of the button by default, so if you want a mixed icon/text button, set cls:\"x-btn-text-icon\")",
- "memberOf" : "Roo.Button",
+ "name" : "header",
+ "type" : "Object",
+ "desc" : "generate the user specific header of the calendar, default false",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "iconCls",
+ "name" : "hideMode",
"type" : "String",
- "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
- "memberOf" : "Roo.Button",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "listeners",
"optvals" : []
},
{
- "name" : "menu",
- "type" : "Roo.menu.Menu",
- "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
- "memberOf" : "Roo.Button",
+ "name" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "menuAlign",
- "type" : "String",
- "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').",
- "memberOf" : "Roo.Button",
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "minWidth",
+ "name" : "startDay",
"type" : "Number",
- "desc" : "The minimum width for this button (used to give a set of buttons a common width)",
- "memberOf" : "Roo.Button",
+ "desc" : "Day index at which the week should begin, 0-based (defaults to 0, which is Sunday)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "pressed",
- "type" : "Boolean",
- "desc" : "True to start pressed (only if enableToggle = true)",
- "memberOf" : "Roo.Button",
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data source for the calendar",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "renderTo",
- "type" : "String/HTMLElement/Element",
- "desc" : "The element to append the button to",
- "memberOf" : "Roo.Button",
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "repeat",
- "type" : "Boolean/Object",
- "desc" : "True to repeat fire the click event while the mouse is down. This can also be\n an {@link Roo.util.ClickRepeater} config object (defaults to false).",
- "memberOf" : "Roo.Button",
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "The scope of the handler",
- "memberOf" : "Roo.Button",
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
- "name" : "tabIndex",
- "type" : "Number",
- "desc" : "The DOM tabIndex for this button (defaults to undefined)",
- "memberOf" : "Roo.Button",
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforedestroy",
+ "type" : "function",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "template",
- "type" : "Roo.Template",
- "desc" : "An {@link Roo.Template} with which to create the Button's main element. This Template must\ncontain numeric substitution parameter 0 if it is to display the tRoo property. Changing the template could\nrequire code modifications if required elements (e.g. a button) aren't present.",
- "memberOf" : "Roo.Button",
- "isOptional" : false,
- "optvals" : []
+ "name" : "beforehide",
+ "type" : "function",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "text",
- "type" : "String",
- "desc" : "The button text",
- "memberOf" : "Roo.Button",
- "isOptional" : false,
- "optvals" : []
+ "name" : "beforerender",
+ "type" : "function",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "toggleGroup",
- "type" : "String",
- "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
- "memberOf" : "Roo.Button",
- "isOptional" : false,
- "optvals" : []
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "tooltip",
- "type" : "String/Object",
- "desc" : "The tooltip for the button - can be a string or QuickTips config object",
- "memberOf" : "Roo.Button",
- "isOptional" : false,
- "optvals" : []
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "tooltipType",
- "type" : "String",
- "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
- "memberOf" : "Roo.Button",
- "isOptional" : false,
- "optvals" : []
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "type",
- "type" : "String",
- "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
- "memberOf" : "Roo.Button",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
- "name" : "arrowclick",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires when this button's arrow is clicked",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.SplitButton",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "SplitButton",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "eventclick",
+ "type" : "function",
+ "desc" : "Fires when the mouse click an",
+ "sig" : "function (_self, )\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Calendar",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "EventObject",
- "desc" : "The click event",
+ "name" : "",
+ "type" : "event",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "click",
+ "name" : "evententer",
"type" : "function",
- "desc" : "Fires when this button is clicked",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.Button",
+ "desc" : "Fires when mouse over an event",
+ "sig" : "function (_self, Event)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Button",
+ "type" : "Calendar",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "EventObject",
- "desc" : "The click event",
+ "name" : "Event",
+ "type" : "event",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "mouseout",
+ "name" : "eventleave",
"type" : "function",
- "desc" : "Fires when the mouse exits the button",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.Button",
+ "desc" : "Fires when the mouse leaves an",
+ "sig" : "function (_self, )\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Button",
+ "type" : "Calendar",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
+ "name" : "",
+ "type" : "event",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "mouseover",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires when the mouse hovers over the button",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.Button",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Button",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "monthchange",
+ "type" : "function",
+ "desc" : "Fires when the displayed month changes",
+ "sig" : "function (_self, date)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "DatePicker",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
+ "name" : "date",
+ "type" : "Date",
+ "desc" : "The selected month",
"isOptional" : false
}
],
{
"name" : "render",
"type" : "function",
- "desc" : "Fires when the button is rendered",
+ "desc" : "Fires after the component is rendered.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Button",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Button",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "toggle",
+ "name" : "select",
"type" : "function",
- "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)",
- "sig" : "function (_self, pressed)\n{\n\n}",
- "memberOf" : "Roo.Button",
+ "desc" : "Fires when a date is selected",
+ "sig" : "function (_self, date)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Button",
+ "type" : "DatePicker",
"desc" : "",
"isOptional" : false
},
{
- "name" : "pressed",
- "type" : "Boolean",
+ "name" : "date",
+ "type" : "Date",
+ "desc" : "The selected date",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
{
"name" : "destroy",
"type" : "function",
- "desc" : "Removes and destroys this button",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "disable",
"type" : "function",
- "desc" : "Disable this button",
+ "desc" : "Disable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Button",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "enable",
"type" : "function",
- "desc" : "Enable this button",
+ "desc" : "Enable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Button",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "fireEvent",
{
"name" : "focus",
"type" : "function",
- "desc" : "Focus the button",
- "sig" : "()\n{\n\n}",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.SplitButton",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "getEl",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Returns the button's underlying element",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Button",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "The element"
+ "desc" : "defaults to this.el"
}
]
},
{
- "name" : "getText",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Gets the text for this button",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Button",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "The button text"
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "hasListener",
+ "name" : "getId",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getVisibilityEl",
+ "type" : "function",
+ "desc" : "Get the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "hasListener",
+ "type" : "function",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
"name" : "eventName",
"type" : "String",
{
"name" : "hide",
"type" : "function",
- "desc" : "Hides this button",
+ "desc" : "Hide a component - adds 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "initEvents",
+ "type" : "function",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "setArrowHandler",
+ "name" : "render",
"type" : "function",
- "desc" : "Sets this button's arrow click handler",
- "sig" : "(handler, scope)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.SplitButton",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The function to call when the arrow is clicked",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) Scope for the function passed above",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
{
"name" : "setDisabled",
"type" : "function",
- "desc" : "Convenience function for boolean enable/disable",
- "sig" : "(enabled)",
- "static" : false,
- "memberOf" : "Roo.Button",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "enabled",
- "type" : "Boolean",
- "desc" : "True to enable, false to disable",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setHandler",
- "type" : "function",
- "desc" : "Sets this button's click handler",
- "sig" : "(handler, scope)",
- "static" : false,
- "memberOf" : "Roo.SplitButton",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The function to call when the button is clicked",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) Scope for the function passed above",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setPressed",
- "type" : "function",
- "desc" : "Similar to toggle, but does not trigger event.",
- "sig" : "(state)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "Roo.Button",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "state",
+ "name" : "disabled",
"type" : "Boolean",
- "desc" : "[required] Force a particular state",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setText",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Sets this button's text",
- "sig" : "(text)",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Button",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "text",
- "type" : "String",
- "desc" : "The button text",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
"name" : "setVisible",
"type" : "function",
- "desc" : "Convenience function for boolean show/hide",
+ "desc" : "Convenience function to hide or show this component by boolean.",
"sig" : "(visible)",
"static" : false,
- "memberOf" : "Roo.Button",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "show",
"type" : "function",
- "desc" : "Shows this button",
+ "desc" : "Show a component - removes 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "toggle",
+ "name" : "tooltipEl",
"type" : "function",
- "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.",
- "sig" : "(state)",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Button",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "state",
- "type" : "Boolean",
- "desc" : "(optional) Force a particular state",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
- ],
- "returns" : []
+ ]
},
{
"name" : "un",
"tree_children" : [],
"tree_parent" : []
},
- "Roo.Toolbar.TextItem" : {
+ "Roo.bootstrap.Card" : {
"props" : [
{
- "name" : "text",
- "type" : "string",
- "desc" : "",
- "memberOf" : "Roo.Toolbar",
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
- }
- ],
- "events" : [
+ },
{
- "name" : "render",
- "type" : "function",
- "desc" : "Fires when the button is rendered",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Toolbar.Item",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Button",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "methods" : [
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
- "name" : "destroy",
- "type" : "function",
- "desc" : "Removes and destroys this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Toolbar.Item",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "disable",
- "type" : "function",
- "desc" : "Disables this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Toolbar.Item",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "enable",
- "type" : "function",
- "desc" : "Enables this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Toolbar.Item",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Toolbar.Item",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "getEl",
- "type" : "function",
- "desc" : "Get this item's HTML Element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Toolbar.Item",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "HTMLElement",
- "desc" : ""
- }
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "display",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "none",
+ "inline",
+ "inline-block",
+ "block",
+ "table",
+ "table-cell",
+ "table-row",
+ "flex",
+ "inline-flex"
]
},
{
- "name" : "hide",
- "type" : "function",
- "desc" : "Hides this button",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "name" : "display_lg",
+ "type" : "String",
+ "desc" : "",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
+ "isOptional" : false,
+ "optvals" : [
+ "none",
+ "inline",
+ "inline-block",
+ "block",
+ "table",
+ "table-cell",
+ "table-row",
+ "flex",
+ "inline-flex"
+ ]
},
{
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function for boolean show/hide.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Toolbar.Item",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "true to show/false to hide",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "display_sm",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "none",
+ "inline",
+ "inline-block",
+ "block",
+ "table",
+ "table-cell",
+ "table-row",
+ "flex",
+ "inline-flex"
+ ]
},
{
- "name" : "show",
- "type" : "function",
- "desc" : "Shows this button",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "name" : "display_xl",
+ "type" : "String",
+ "desc" : "",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.TreePanel" : {
- "props" : [
+ "isOptional" : false,
+ "optvals" : [
+ "none",
+ "inline",
+ "inline-block",
+ "block",
+ "table",
+ "table-cell",
+ "table-row",
+ "flex",
+ "inline-flex"
+ ]
+ },
{
- "name" : "adjustments",
- "type" : "Array",
- "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
- "memberOf" : "Roo.ContentPanel",
+ "name" : "display_xs",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "none",
+ "inline",
+ "inline-block",
+ "block",
+ "table",
+ "table-cell",
+ "table-row",
+ "flex",
+ "inline-flex"
+ ]
},
{
- "name" : "autoCreate",
- "type" : "Boolean|Object",
- "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
- "memberOf" : "Roo.ContentPanel",
+ "name" : "footer",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "autoScroll",
- "type" : "Boolean",
- "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
- "memberOf" : "Roo.ContentPanel",
+ "name" : "header",
+ "type" : "String|Object",
+ "desc" : "",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "background",
- "type" : "Boolean",
- "desc" : "True if the panel should not be activated when it is added (defaults to false)",
- "memberOf" : "Roo.ContentPanel",
+ "name" : "header_image",
+ "type" : "String",
+ "desc" : "src url of image.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "closable",
- "type" : "Boolean",
- "desc" : "True if the panel can be closed/removed",
- "memberOf" : "Roo.ContentPanel",
+ "name" : "header_size",
+ "type" : "Number",
+ "desc" : "5) H1 or H2 etc.. 0 indicates defau",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5"
+ ]
},
{
- "name" : "content",
- "type" : "String",
- "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
- "memberOf" : "Roo.ContentPanel",
+ "name" : "header_weight",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "primary",
+ "secondary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "light",
+ "dark"
+ ]
},
{
- "name" : "fitContainer",
- "type" : "Boolean",
- "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
- "memberOf" : "Roo.ContentPanel",
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "fitToFrame",
- "type" : "Boolean",
- "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
- "memberOf" : "Roo.ContentPanel",
+ "name" : "html",
+ "type" : "String|Boolean",
+ "desc" : "-- html contents - or just use children.. use false to hide it..",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "loadOnce",
- "type" : "Boolean",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.ContentPanel",
+ "name" : "margin",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5",
+ "auto"
+ ]
},
{
- "name" : "menu",
- "type" : "Roo.menu.Menu",
- "desc" : "popup menu",
- "memberOf" : "Roo.ContentPanel",
+ "name" : "margin_bottom",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5",
+ "auto"
+ ]
},
{
- "name" : "params",
- "type" : "String|Object",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.ContentPanel",
+ "name" : "margin_left",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5",
+ "auto"
+ ]
},
{
- "name" : "region",
+ "name" : "margin_right",
"type" : "String",
- "desc" : "t) which region to put this panel on (when used with xtype constructor",
- "memberOf" : "Roo.ContentPanel",
+ "desc" : "",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : [
- "center",
- "north",
- "south",
- "east",
- "west"
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5",
+ "auto"
]
},
{
- "name" : "resizeEl",
- "type" : "String|HTMLElement|Element",
- "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
- "memberOf" : "Roo.ContentPanel",
+ "name" : "margin_top",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5",
+ "auto"
+ ]
+ },
+ {
+ "name" : "margin_x",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5",
+ "auto"
+ ]
+ },
+ {
+ "name" : "margin_y",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5",
+ "auto"
+ ]
+ },
+ {
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "padding",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5"
+ ]
+ },
+ {
+ "name" : "padding_bottom",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5"
+ ]
+ },
+ {
+ "name" : "padding_left",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5"
+ ]
+ },
+ {
+ "name" : "padding_right",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5"
+ ]
+ },
+ {
+ "name" : "padding_top",
+ "type" : "String",
+ "desc" : "5)next_to_ca",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5"
+ ]
+ },
+ {
+ "name" : "padding_x",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5"
+ ]
+ },
+ {
+ "name" : "padding_y",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5"
+ ]
+ },
{
"name" : "style",
"type" : "String",
- "desc" : "Extra style to add to the content panel",
- "memberOf" : "Roo.ContentPanel",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "subtitle",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
"name" : "title",
"type" : "String",
- "desc" : "The title for this panel",
- "memberOf" : "Roo.ContentPanel",
+ "desc" : "",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "toolbar",
- "type" : "Roo.Toolbar",
- "desc" : "A toolbar for this panel",
- "memberOf" : "Roo.ContentPanel",
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "url",
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "name" : "weight",
"type" : "String",
- "desc" : "Calls {@link #setUrl} with this value",
- "memberOf" : "Roo.ContentPanel",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "primary",
+ "warning",
+ "info",
+ "danger",
+ "secondary",
+ "success",
+ "light",
+ "dark"
+ ]
+ },
+ {
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
{
- "name" : "activate",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fires when this panel is activated.",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.ContentPanel",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "deactivate",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Fires when this panel is activated.",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.ContentPanel",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "render",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires when this tab is created",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.ContentPanel",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "resize",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Fires when this panel is resized if fitToFrame is true.",
- "sig" : "function (_self, width, height)\n{\n\n}",
- "memberOf" : "Roo.ContentPanel",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.ContentPanel",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The width after any component adjustments",
- "isOptional" : false
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "The height after any component adjustments",
- "isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "addEvents",
+ "name" : "cardover",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "When a card element is dragged over ready to drop (return false to block dropable)",
+ "sig" : "function (_self, data)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "object",
+ "name" : "this",
+ "type" : "Roo.bootstrap.Card",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
"type" : "Object",
- "desc" : "The object with the events defined",
+ "desc" : "from dragdrop",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "this",
+ "type" : "Roo.bootstrap.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addxtype",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'Form',\n items: [ .... ]\n }\n);\n\n</code></pre>",
- "sig" : "(cfg)",
- "static" : false,
- "memberOf" : "Roo.ContentPanel",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "cfg",
- "type" : "Object",
- "desc" : "Xtype definition of item to add.",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "disable",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this panel",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.ContentPanel",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "fireEvent",
+ "name" : "drop",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "When a element a card is dropped",
+ "sig" : "function (_self, move_card, position, next_to_card)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
+ "name" : "this",
+ "type" : "Roo.bootstrap.Card",
"desc" : "",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "move_card",
+ "type" : "Roo.bootstrap.Card",
+ "desc" : "the card being dropped?",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
- },
- {
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns this panel's element - used by regiosn to add.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.ContentPanel",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "name" : "position",
+ "type" : "String",
+ "desc" : "'above' or 'below'",
+ "isOptional" : false
+ },
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : ""
+ "name" : "next_to_card",
+ "type" : "Roo.bootstrap.Card",
+ "desc" : "What card position is relative to of 'false' for empty list.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getId",
+ "name" : "enable",
"type" : "function",
- "desc" : "Returns this panel's id",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.ContentPanel",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : ""
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getTitle",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns this panel's title",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.ContentPanel",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : ""
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getToolbar",
+ "name" : "render",
"type" : "function",
- "desc" : "Returns the toolbar for this Panel if one was configured.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.ContentPanel",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Toolbar",
- "desc" : ""
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getUpdateManager",
+ "name" : "rotate",
"type" : "function",
- "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.ContentPanel",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "When a element a card is rotate",
+ "sig" : "function (_self, n, rotate)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.UpdateManager",
- "desc" : "The UpdateManager"
+ "name" : "this",
+ "type" : "Roo.bootstrap.Card",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "n",
+ "type" : "Roo.Element",
+ "desc" : "the node being dropped?",
+ "isOptional" : false
+ },
+ {
+ "name" : "rotate",
+ "type" : "Boolean",
+ "desc" : "status",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "show",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
- },
+ "returns" : []
+ }
+ ],
+ "methods" : [
{
- "name" : "isClosable",
+ "name" : "acceptCard",
"type" : "function",
- "desc" : "Returns true is this panel was configured to be closable",
+ "desc" : "accept card\n\n- card.acceptCard(move_card, info.position, info.card, info.items_n);",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "load",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.",
- "sig" : "(url, params, callback, discardUrl)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "url",
- "type" : "Object/String/Function",
- "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\npanel.load({\n url: \"your-url.php\",\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n callback: yourFunction,\n scope: yourObject, //(optional scope)\n discardUrl: false,\n nocache: false,\n text: \"Loading...\",\n timeout: 30,\n scripts: false\n});\n</code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
- "isOptional" : false
- },
- {
- "name" : "discardUrl",
- "type" : "Boolean",
- "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "on",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "desc" : "Appends an event handler to this component",
"sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
{
"name" : "options",
"type" : "Object",
- "desc" : "(optional)",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "refresh",
- "type" : "function",
- "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.ContentPanel",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
+ "name" : "capture",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
"static" : true,
"memberOf" : "Roo.util.Observable",
"isStatic" : true,
{
"name" : "o",
"type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "removeListener",
- "type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "handler",
+ "name" : "fn",
"type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "The function to call",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setContent",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Updates this panel's element",
- "sig" : "(content, loadScripts)",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "content",
- "type" : "String",
- "desc" : "The new content",
- "isOptional" : false
- },
- {
- "name" : "loadScripts",
- "type" : "Boolean",
- "desc" : "(optional) true to look for and process scripts",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setTitle",
+ "name" : "disable",
"type" : "function",
- "desc" : "Set this panel's title",
- "sig" : "(title)",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "title",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setUrl",
+ "name" : "enable",
"type" : "function",
- "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
- "sig" : "(url, params, loadOnce)",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.ContentPanel",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "url",
- "type" : "String/Function",
- "desc" : "The URL to load the content from or a function to call to get the URL",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
- "isOptional" : false
- },
- {
- "name" : "loadOnce",
- "type" : "Boolean",
- "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.UpdateManager",
- "desc" : "The UpdateManager"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "un",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : [
- "Roo.BorderLayout",
- "Roo.LayoutDialog",
- "builder"
- ]
- },
- "Roo.UpdateManager" : {
- "props" : [
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "beforeupdate",
- "type" : "function",
- "desc" : "Fired before an update is made, return false from your handler and the update is cancelled.",
- "sig" : "function (el, url, params)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "Roo.Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "url",
- "type" : "String/Object/Function",
- "desc" : "",
- "isOptional" : false
- },
+ "returns" : [
{
- "name" : "params",
- "type" : "String/Object",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "failure",
+ "name" : "focus",
"type" : "function",
- "desc" : "Fired on update failure.",
- "sig" : "function (el, oResponseObject)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "Roo.Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "oResponseObject",
- "type" : "Object",
- "desc" : "The response Object",
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "update",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Fired after successful update is made.",
- "sig" : "function (el, oResponseObject)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fetch the element to add children to",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "el",
+ "name" : "",
"type" : "Roo.Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "oResponseObject",
- "type" : "Object",
- "desc" : "The response Object",
- "isOptional" : false
+ "desc" : "defaults to this.el"
}
- ],
- "returns" : []
- }
- ],
- "methods" : [
+ ]
+ },
{
- "name" : "abort",
+ "name" : "getDropPoint",
"type" : "function",
- "desc" : "Aborts the executing transaction",
+ "desc" : "Decide whether to drop above or below a View node.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : []
},
{
- "name" : "addEvents",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "addListener",
+ "name" : "getId",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "eventName",
+ "name" : "",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
- "isOptional" : false
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "capture",
+ "name" : "getTargetFromEvent",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Part of the Roo.dd.DropZone interface. If no target node is found, the\n whole Element becomes the target, and this causes the drop gesture to append.\n\n Returns an object:\n {\n \n position : 'below' or 'above'\n card : relateive to card OBJECT (or true for no cards listed)\n items_n : relative to nth item in list\n card_n : relative to nth card in list\n }",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "getVisibilityEl",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Get the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "formUpdate",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Performs an async form post, updating this element with the response. If the form has the attribute enctype=\"multipart/form-data\", it assumes it's a file upload.\nUses this.sslBlankUrl for SSL file uploads to prevent IE security warning.",
- "sig" : "(form, url, reset, callback)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "form",
- "type" : "String/HTMLElement",
- "desc" : "The form Id or form element",
- "isOptional" : false
- },
- {
- "name" : "url",
+ "name" : "eventName",
"type" : "String",
- "desc" : "(optional) The url to pass the form to. If omitted the action attribute on the form will be used.",
+ "desc" : "The name of the event to check for",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
- "name" : "reset",
+ "name" : "",
"type" : "Boolean",
- "desc" : "(optional) Whether to try to reset the form after the update",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess, oResponse)",
- "isOptional" : false
+ "desc" : "True if the event is being listened for, else false"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "getEl",
+ "name" : "hide",
"type" : "function",
- "desc" : "Get the Element this UpdateManager is bound to",
+ "desc" : "Hide a component - adds 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
- }
- ]
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "initEvents",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "isUpdating",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Returns true if an update is in progress",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
"name" : "on",
"params" : [],
"returns" : []
},
- {
- "name" : "refresh",
- "type" : "function",
- "desc" : "Refresh the element with the last used url or defaultUrl. If there is no url, it returns immediately",
- "sig" : "(callback)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "releaseCapture",
"type" : "function",
"returns" : []
},
{
- "name" : "setDefaultUrl",
+ "name" : "render",
"type" : "function",
- "desc" : "Set the defaultUrl used for updates",
- "sig" : "(defaultUrl)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "defaultUrl",
- "type" : "String/Function",
- "desc" : "The url or a function to call to get the url",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setRenderer",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Set the content renderer for this UpdateManager. See {@link Roo.UpdateManager.BasicRenderer#render} for more details.",
- "sig" : "(renderer)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "renderer",
- "type" : "Object",
- "desc" : "The object implementing the render() method",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "showLoading",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Called to update the element to \"Loading\" state. Override to perform custom action.",
+ "desc" : "Set the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "startAutoRefresh",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Set this element to auto refresh.",
- "sig" : "(interval, url, params, callback, refreshNow)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "interval",
- "type" : "Number",
- "desc" : "How often to update (in seconds).",
- "isOptional" : false
- },
- {
- "name" : "url",
- "type" : "String/Function",
- "desc" : "(optional) The url for this request or a function to call to get the url (Defaults to the last used url)",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The parameters to pass as either a url encoded string \"¶m1=1¶m2=2\" or as an object {param1: 1, param2: 2}",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)",
- "isOptional" : false
- },
- {
- "name" : "refreshNow",
+ "name" : "visible",
"type" : "Boolean",
- "desc" : "(optional) Whether to execute the refresh now, or wait the interval",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "stopAutoRefresh",
+ "name" : "show",
"type" : "function",
- "desc" : "Stop auto refresh on this element.",
+ "desc" : "Show a component - removes 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "un",
+ "name" : "tooltipEl",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "update",
+ "name" : "un",
"type" : "function",
- "desc" : "Performs an async request, updating this element with the response. If params are specified it uses POST, otherwise it uses GET.",
- "sig" : "(url, params, callback, discardUrl)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "url",
- "type" : "Object/String/Function",
- "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\num.update({<br/>\n url: \"your-url.php\",<br/>\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string<br/>\n callback: yourFunction,<br/>\n scope: yourObject, //(optional scope) <br/>\n discardUrl: false, <br/>\n nocache: false,<br/>\n text: \"Loading...\",<br/>\n timeout: 30,<br/>\n scripts: false<br/>\n});\n</code></pre>\nThe only required property is url. The optional properties nocache, text and scripts\nare shorthand for disableCaching, indicatorText and loadScripts and are used to set their associated property on this UpdateManager instance.",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The parameters to pass as either a url encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "callback",
+ "name" : "handler",
"type" : "Function",
- "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess, oResponse)",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "discardUrl",
- "type" : "Boolean",
- "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used url. If true, it will not store the url.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "updateElement",
- "type" : "function",
- "desc" : "Static convenience method. This method is deprecated in favor of el.load({url:'foo.php', ...}).\nUsage:\n<pre><code>Roo.UpdateManager.updateElement(\"my-div\", \"stuff.php\");</code></pre>",
- "sig" : "(el, url, params, options)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "This has been deprecated: ",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The element to update",
- "isOptional" : false
- },
- {
- "name" : "url",
- "type" : "String",
- "desc" : "The url",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) Url encoded param string or an object of name/value pairs",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) A config object with any of the UpdateManager properties you want to set - for example: {disableCaching:true, indicatorText: \"Loading data...\"}",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.UpdateManager.BasicRenderer" : {
- "props" : [],
- "events" : [],
- "methods" : [
- {
- "name" : "render",
- "type" : "function",
- "desc" : "This is called when the transaction is completed and it's time to update the element - The BasicRenderer\nupdates the elements innerHTML with the responseText - To perform a custom render (i.e. XML or JSON processing),\ncreate an object with a \"render(el, response)\" method and pass it to setRenderer on the UpdateManager.",
- "sig" : "(el, response, updateManager, callback)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "Roo.Element",
- "desc" : "The element being rendered",
- "isOptional" : false
- },
- {
- "name" : "response",
- "type" : "Object",
- "desc" : "The YUI Connect response object",
- "isOptional" : false
- },
- {
- "name" : "updateManager",
- "type" : "UpdateManager",
- "desc" : "The calling update manager",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "A callback that will need to be called if loadScripts is true on the UpdateManager",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.CardFooter",
+ "Roo.bootstrap.CardHeader",
+ "Roo.bootstrap.CardImageTop",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.UpdateManager.defaults" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
"tree_parent" : []
},
- "Roo.View" : {
+ "Roo.bootstrap.CardFooter" : {
"props" : [
{
- "name" : "dataName",
+ "name" : "actionMode",
"type" : "String",
- "desc" : "the named area of the template to use as the data area\n Works with domtemplates roo-name=\"name\"",
- "memberOf" : "",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "el",
- "type" : "String|Roo.Element",
- "desc" : "The container element.",
- "memberOf" : "",
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "emptyText",
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "clickable",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "cls",
"type" : "String",
- "desc" : "The empty text to show when nothing is loaded.",
- "memberOf" : "",
+ "desc" : "class of the element",
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "contents of the element",
+ "memberOf" : "Roo.bootstrap.Element",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "multiSelect",
- "type" : "Boolean",
- "desc" : "Allow multiple selection",
- "memberOf" : "",
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "selectedClass",
- "type" : "String",
- "desc" : "The css class to add to selected nodes",
- "memberOf" : "",
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
+ "memberOf" : "Roo.bootstrap.Element",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "singleSelect",
- "type" : "Boolean",
- "desc" : "Allow single selection",
- "memberOf" : "",
+ "name" : "role",
+ "type" : "String",
+ "desc" : "default blank - set to button to force cursor pointer",
+ "memberOf" : "Roo.bootstrap.Element",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "Data store to load data from.",
- "memberOf" : "",
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "text",
+ "name" : "tag",
"type" : "String",
- "desc" : "to display on mask (default Loading)",
- "memberOf" : "",
+ "desc" : "tag of the element",
+ "memberOf" : "Roo.bootstrap.Element",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tickable",
- "type" : "Boolean",
- "desc" : "- selecting",
- "memberOf" : "",
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "toggleSelect",
- "type" : "Boolean",
- "desc" : "- selecting",
- "memberOf" : "",
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
- "name" : "tpl",
- "type" : "String|Roo.Template",
- "desc" : "The template used by this View",
- "memberOf" : "",
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
{
- "name" : "beforeclick",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fires before a click is processed. Returns false to cancel the default action.",
- "sig" : "function (_self, index, node, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.View",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the target node",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "HTMLElement",
- "desc" : "The target node",
- "isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforehide",
+ "type" : "function",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The raw event object",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeselect",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires before a selection is made. If any handlers return false, the selection is cancelled.",
- "sig" : "function (_self, node, selections)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.View",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "node",
- "type" : "HTMLElement",
- "desc" : "The node to be selected",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "selections",
- "type" : "Array",
- "desc" : "Array of currently selected nodes",
+ "name" : "this",
+ "type" : "Roo.bootstrap.Component",
+ "desc" : "",
"isOptional" : false
}
],
{
"name" : "click",
"type" : "function",
- "desc" : "Fires when a template node is clicked.",
- "sig" : "function (_self, index, node, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "When a element is chick",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Element",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.View",
+ "type" : "Roo.bootstrap.Element",
"desc" : "",
"isOptional" : false
},
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the target node",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "HTMLElement",
- "desc" : "The target node",
- "isOptional" : false
- },
{
"name" : "e",
"type" : "Roo.EventObject",
- "desc" : "The raw event object",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "contextmenu",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires when a template node is right clicked.",
- "sig" : "function (_self, index, node, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.View",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the target node",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "HTMLElement",
- "desc" : "The target node",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The raw event object",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "dblclick",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires when a template node is double clicked.",
- "sig" : "function (_self, index, node, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.View",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the target node",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "HTMLElement",
- "desc" : "The target node",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The raw event object",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "preparedata",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires on every row to render, to allow you to change the data.",
- "sig" : "function (_self, data)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.View",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "data",
- "type" : "Object",
- "desc" : "to be rendered (change this)",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "selectionchange",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires when the selected nodes change.",
- "sig" : "function (_self, selections)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.View",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "selections",
- "type" : "Array",
- "desc" : "Array of the selected nodes",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "clearSelections",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Clear all selections",
- "sig" : "(suppressEvent)",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "suppressEvent",
- "type" : "Boolean",
- "desc" : "(optional) true to skip firing of the selectionchange event",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "findItemFromChild",
+ "name" : "disable",
"type" : "function",
- "desc" : "Returns the template node the passed child belongs to or null if it doesn't belong to one.",
- "sig" : "(node)",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "node",
- "type" : "HTMLElement",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
+ ]
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "HTMLElement",
- "desc" : "The template node"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
]
},
{
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns the element this view is bound to.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getNode",
+ "name" : "focus",
"type" : "function",
- "desc" : "Gets a template node.",
- "sig" : "(nodeInfo)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "nodeInfo",
- "type" : "HTMLElement/String/Number",
- "desc" : "An HTMLElement template node, index of a template node or the id of a template node",
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "HTMLElement",
- "desc" : "The node or null if it wasn't found"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getNodes",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Gets a range template nodes.",
- "sig" : "(startIndex, endIndex)",
+ "desc" : "Fetch the element to add children to",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "startIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "endIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Array",
- "desc" : "An array of nodes"
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
{
- "name" : "getSelectedIndexes",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Get the indexes of the selected nodes.",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Array",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "getSelectedNodes",
+ "name" : "getId",
"type" : "function",
- "desc" : "Get the currently selected nodes.",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Array",
- "desc" : "An array of HTMLElements"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getSelectionCount",
+ "name" : "getVisibilityEl",
"type" : "function",
- "desc" : "Get the number of selected nodes.",
+ "desc" : "Get the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
"name" : "hasListener",
]
},
{
- "name" : "indexOf",
+ "name" : "hide",
"type" : "function",
- "desc" : "Finds the index of the passed node",
- "sig" : "(nodeInfo)",
+ "desc" : "Hide a component - adds 'hidden' class",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "nodeInfo",
- "type" : "HTMLElement/String/Number",
- "desc" : "An HTMLElement template node, index of a template node or the id of a template node",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "The index of the node or -1"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "isSelected",
+ "name" : "initEvents",
"type" : "function",
- "desc" : "Returns true if the passed node is selected",
- "sig" : "(node)",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "node",
- "type" : "HTMLElement/Number",
- "desc" : "The node or node index",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
"name" : "on",
"returns" : []
},
{
- "name" : "onBeforeLoad",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "onbeforeLoad - masks the loading area.",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "prepareData",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Function to override to reformat the data that is sent to\nthe template for each node.\nDEPRICATED - use the preparedata event handler.",
- "sig" : "(data)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "data",
- "type" : "Array/Object",
- "desc" : "The raw data (array of colData for a data model bound view or\na JSON object for an UpdateManager bound view).",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "refresh",
+ "name" : "render",
"type" : "function",
- "desc" : "Refreshes the view. - called by datachanged on the store. - do not call directly.",
- "sig" : "()\n{\n\n}",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "refreshNode",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Refresh an individual node.",
- "sig" : "(index)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
+ "name" : "disabled",
+ "type" : "Boolean",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "select",
+ "name" : "show",
"type" : "function",
- "desc" : "Selects nodes.",
- "sig" : "(nodeInfo, keepExisting, suppressEvent)",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "nodeInfo",
- "type" : "Array/HTMLElement/String/Number",
- "desc" : "An HTMLElement template node, index of a template node, id of a template node or an array of any of those to select",
- "isOptional" : false
- },
- {
- "name" : "keepExisting",
- "type" : "Boolean",
- "desc" : "(optional) true to keep existing selections",
- "isOptional" : false
- },
- {
- "name" : "suppressEvent",
- "type" : "Boolean",
- "desc" : "(optional) true to skip firing of the selectionchange vent",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setStore",
+ "name" : "tooltipEl",
"type" : "function",
- "desc" : "Changes the data store this view uses and refresh the view.",
- "sig" : "(store)",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "store",
- "type" : "Store",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
- ],
- "returns" : []
+ ]
},
{
"name" : "un",
}
],
"returns" : []
- },
- {
- "name" : "unselect",
- "type" : "function",
- "desc" : "Unselects nodes.",
- "sig" : "(nodeInfo, keepExisting, suppressEvent)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "nodeInfo",
- "type" : "Array/HTMLElement/String/Number",
- "desc" : "An HTMLElement template node, index of a template node, id of a template node or an array of any of those to select",
- "isOptional" : false
- },
- {
- "name" : "keepExisting",
- "type" : "Boolean",
- "desc" : "(optional) true IGNORED (for campatibility with select)",
- "isOptional" : false
- },
- {
- "name" : "suppressEvent",
- "type" : "Boolean",
- "desc" : "(optional) true to skip firing of the selectionchange vent",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.JsonView"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.XComponent" : {
- "props" : [
- {
- "name" : "disabled",
- "type" : "Function|boolean",
- "desc" : "If this module is disabled by some rule, return true from the funtion",
- "memberOf" : "",
- "isOptional" : false,
+ "implementations" : [],
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : [
+ "Roo.bootstrap.Card"
+ ]
+ },
+ "Roo.bootstrap.CardHeader" : {
+ "props" : [
+ {
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
"optvals" : []
},
{
- "name" : "items",
- "type" : "Array",
- "desc" : "A single item array - the first element is the root of the tree..\nIt's done this way to stay compatible with the Xtype system...",
- "memberOf" : "",
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "clickable",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "class of the element",
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "contents of the element",
+ "memberOf" : "Roo.bootstrap.Element",
"isOptional" : false,
"optvals" : []
},
},
{
"name" : "name",
- "type" : "String",
- "desc" : "String to display while loading.",
- "memberOf" : "",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "order",
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "role",
"type" : "String",
- "desc" : "Used to set the order in which elements are created (usefull for multiple tabs)",
- "memberOf" : "",
+ "desc" : "default blank - set to button to force cursor pointer",
+ "memberOf" : "Roo.bootstrap.Element",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "parent",
+ "name" : "style",
"type" : "String",
- "desc" : "Name of parent element which it get xtype added to..",
- "memberOf" : "",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "region",
+ "name" : "tag",
"type" : "String",
- "desc" : "Region to render component to (defaults to center)",
- "memberOf" : "",
+ "desc" : "tag of the element",
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
{
- "name" : "built",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fires when this the componnt is built",
- "sig" : "function (c)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "c",
- "type" : "Roo.XComponent",
- "desc" : "the component",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforehide",
+ "type" : "function",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforerender",
+ "type" : "function",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "When a element is chick",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Element",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "build",
+ "name" : "capture",
"type" : "function",
- "desc" : "Build the registered modules.",
- "sig" : "(parent, optional)",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
"static" : true,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "parent",
- "type" : "Object",
- "desc" : "element.",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "optional",
+ "name" : "fn",
"type" : "Function",
- "desc" : "method to call after module has been added.",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "buildOrder",
+ "name" : "destroy",
"type" : "function",
- "desc" : "make a list of modules to build.",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
"sig" : "()\n{\n\n}",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"returns" : [
{
"name" : "",
- "type" : "Array",
- "desc" : "list of modules."
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "capture",
+ "name" : "enable",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
"name" : "fireEvent",
]
},
{
- "name" : "hasListener",
+ "name" : "focus",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "overlayStrings",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Overlay a set of modified strings onto a component\nThis is dependant on our builder exporting the strings and 'named strings' elements.",
- "sig" : "(element, associative)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Fetch the element to add children to",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "element",
- "type" : "Object",
- "desc" : "to overlay on - eg. Pman.Dialog.Login",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "associative",
- "type" : "Object",
- "desc" : "array of 'named' string and it's new value.",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "preBuild",
+ "name" : "getEl",
"type" : "function",
- "desc" : "move modules into their correct place in the tree..",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "The element"
+ }
+ ]
},
{
- "name" : "purgeListeners",
+ "name" : "getId",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "register",
+ "name" : "getVisibilityEl",
"type" : "function",
- "desc" : "Register components to be built later.\n\nThis solves the following issues\n- Building is not done on page load, but after an authentication process has occured.\n- Interface elements are registered on page load\n- Parent Interface elements may not be loaded before child, so this handles that..\n\n\nexample:\n\nMyApp.register({\n order : '000001',\n module : 'Pman.Tab.projectMgr',\n region : 'center',\n parent : 'Pman.layout',\n disabled : false, // or use a function..\n })\n* @param {Object} details about module",
+ "desc" : "Get the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
"memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "removeListener",
+ "name" : "hide",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Hide a component - adds 'hidden' class",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "render",
+ "name" : "initEvents",
"type" : "function",
- "desc" : "render\nrender element to dom or tree",
- "sig" : "(optional)",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "optional",
- "type" : "Roo.Element|String|DomElement",
- "desc" : "render to if parent is not set.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "toObject",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "convert a string to an object..\neg. 'AAA.BBB' -> finds AAA.BBB",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"returns" : []
},
{
- "name" : "un",
+ "name" : "on",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.XComponent.event.events" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.XTemplate" : {
- "props" : [
- {
- "name" : "html",
- "type" : "String",
- "desc" : "The HTML fragment or an array of fragments to join(\"\") or multiple arguments to join(\"\")",
- "memberOf" : "Roo.Template",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "onLoad",
- "type" : "Function",
- "desc" : "Called after the template has been loaded and complied (usually from a remove source)",
- "memberOf" : "Roo.Template",
- "isOptional" : false,
- "optvals" : []
},
{
- "name" : "url",
- "type" : "String",
- "desc" : "The Url to load the template from. beware if you are loading from a url, the data may not be ready if you use it instantly..\n it should be fixed so that template is observable...",
- "memberOf" : "Roo.Template",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
- {
- "name" : "append",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Applies the supplied values to the template and appends the new node(s) to el.",
- "sig" : "(el, values, returnElement)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Template",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The context element",
- "isOptional" : false
- },
- {
- "name" : "values",
- "type" : "Object",
- "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
- "isOptional" : false
- },
- {
- "name" : "returnElement",
- "type" : "Boolean",
- "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The new node or Element"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "apply",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Alias for {@link #applyTemplate}",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Template",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "applySubTemplate",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "same as applyTemplate, except it's done to one of the subTemplates\nwhen using named templates, you can do:\n\nvar str = pl.applySubTemplate('your-name', values);",
- "sig" : "(id, values, parent)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "Number",
- "desc" : "of the template",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "values",
- "type" : "Object",
- "desc" : "to apply to template",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "parent",
+ "name" : "scope",
"type" : "Object",
- "desc" : "(normaly the instance of this object)",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "applyTemplate",
+ "name" : "render",
"type" : "function",
- "desc" : "Returns an HTML fragment of this template with the specified values applied.",
- "sig" : "(values)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.Template",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "values",
- "type" : "Object",
- "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "The HTML fragment"
- }
- ]
+ "returns" : []
},
{
- "name" : "compile",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "compile the template\n\nThis is not recursive, so I'm not sure how nested templates are really going to be handled..",
- "sig" : "()\n{\n\n}",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "from",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Creates a template from the passed element's value (<i>display:none</i> textarea, preferred) or innerHTML.",
- "sig" : "(el)",
- "static" : true,
- "memberOf" : "Roo.Template",
- "isStatic" : true,
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement",
- "desc" : "A DOM element or its id",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "insertAfter",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Applies the supplied values to the template and inserts the new node(s) after el.",
- "sig" : "(el, values, returnElement)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "Roo.Template",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The context element",
- "isOptional" : false
- },
- {
- "name" : "values",
- "type" : "Object",
- "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
- "isOptional" : false
- },
- {
- "name" : "returnElement",
+ "name" : "visible",
"type" : "Boolean",
- "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The new node or Element"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "insertBefore",
+ "name" : "show",
"type" : "function",
- "desc" : "Applies the supplied values to the template and inserts the new node(s) before el.",
- "sig" : "(el, values, returnElement)",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Template",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The context element",
- "isOptional" : false
- },
- {
- "name" : "values",
- "type" : "Object",
- "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
- "isOptional" : false
- },
- {
- "name" : "returnElement",
- "type" : "Boolean",
- "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
- "isOptional" : false
- }
- ],
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The new node or Element"
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
{
- "name" : "insertFirst",
+ "name" : "un",
"type" : "function",
- "desc" : "Applies the supplied values to the template and inserts the new node(s) as the first child of el.",
- "sig" : "(el, values, returnElement)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.Template",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The context element",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "values",
- "type" : "Object",
- "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
- "isOptional" : false
- },
- {
- "name" : "returnElement",
- "type" : "Boolean",
- "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The new node or Element"
- }
- ]
- },
- {
- "name" : "overwrite",
- "type" : "function",
- "desc" : "Applies the supplied values to the template and overwrites the content of el with the new node(s).",
- "sig" : "(el, values, returnElement)",
- "static" : false,
- "memberOf" : "Roo.Template",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The context element",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "values",
+ "name" : "scope",
"type" : "Object",
- "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
- "isOptional" : false
- },
- {
- "name" : "returnElement",
- "type" : "Boolean",
- "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "HTMLElement/Roo.Element",
- "desc" : "The new node or Element"
- }
- ]
- },
- {
- "name" : "set",
- "type" : "function",
- "desc" : "Sets the HTML used as the template and optionally compiles it.",
- "sig" : "(html, compile)",
- "static" : false,
- "memberOf" : "Roo.Template",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "html",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "compile",
- "type" : "Boolean",
- "desc" : "(optional) True to compile the template (defaults to undefined)",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Template",
- "desc" : "this"
- }
- ]
+ "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.bootstrap" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : [
+ "Roo.bootstrap.Card"
+ ]
},
- "Roo.bootstrap.Alert" : {
+ "Roo.bootstrap.CardImageTop" : {
"props" : [
{
"name" : "actionMode",
"optvals" : []
},
{
- "name" : "close",
+ "name" : "clickable",
"type" : "Boolean",
- "desc" : "true to show a x closer",
- "memberOf" : "",
+ "desc" : "e) default fal",
+ "memberOf" : "Roo.bootstrap.Element",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "class of the element",
+ "memberOf" : "Roo.bootstrap.Element",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "fa",
- "type" : "String",
- "desc" : "font-awesomeicon",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "hideMode",
"type" : "String",
{
"name" : "html",
"type" : "String",
- "desc" : "The content of alert",
- "memberOf" : "",
+ "desc" : "contents of the element",
+ "memberOf" : "Roo.bootstrap.Element",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "seconds",
- "type" : "Number",
- "desc" : "default:-1 Number of seconds until it disapears (-1 means never.)",
- "memberOf" : "",
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "role",
+ "type" : "String",
+ "desc" : "default blank - set to button to force cursor pointer",
+ "memberOf" : "Roo.bootstrap.Element",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "title",
+ "name" : "tag",
"type" : "String",
- "desc" : "The title of alert",
- "memberOf" : "",
+ "desc" : "tag of the element",
+ "memberOf" : "Roo.bootstrap.Element",
"isOptional" : false,
"optvals" : []
},
"parent"
]
},
- {
- "name" : "weight",
- "type" : "String",
- "desc" : "r) Weight of the messa",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "success",
- "info",
- "warning",
- "danger"
- ]
- },
{
"name" : "xattr",
"type" : "Object",
],
"returns" : []
},
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "When a element is chick",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Element",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
{
"name" : "hide",
"type" : "function",
- "desc" : "Hide the Alert",
+ "desc" : "Hide a component - adds 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
},
- {
- "name" : "setHtml",
- "type" : "function",
- "desc" : "Set the Body Message HTML",
- "sig" : "(html)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "html",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setIcon",
- "type" : "function",
- "desc" : "Set the Icon of the alert",
- "sig" : "(see)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "see",
- "type" : "String",
- "desc" : "fontawsome names (name without the 'fa-' bit)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setTitle",
- "type" : "function",
- "desc" : "Set the Title Message HTML",
- "sig" : "(html)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "html",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
}
]
},
- {
- "name" : "setWeight",
- "type" : "function",
- "desc" : "Set the Weight of the alert",
- "sig" : "((success|info|warning|danger))",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "(success|info|warning|danger)",
- "type" : "String",
- "desc" : "weight",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
- "desc" : "Show the Alert",
+ "desc" : "Show a component - removes 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : [
+ "Roo.bootstrap.Card"
+ ]
},
- "Roo.bootstrap.BezierSignature" : {
+ "Roo.bootstrap.Column" : {
"props" : [
- {
- "name" : "Add",
- "type" : "integer",
- "desc" : "the next point only if the previous one is farther than x pixels. Defaults to 5.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "Callback",
- "type" : "function",
- "desc" : "when stroke begin.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "Color",
- "type" : "string",
- "desc" : "used to draw the lines. Can be any color format accepted by context.fillStyle. Defaults to \"black\".",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "Draw",
- "type" : "integer",
- "desc" : "the next point at most once per every x milliseconds. Set it to 0 to turn off throttling. Defaults to 16.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "Maximum",
- "type" : "float",
- "desc" : "width of a line. Defaults to 2.5.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "Minimum",
- "type" : "float",
- "desc" : "width of a line. Defaults to 0.5.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "Radius",
- "type" : "float|function",
- "desc" : "of a single dot.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "Weight",
- "type" : "float",
- "desc" : "used to modify new velocity based on the previous velocity. Defaults to 0.7.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "actionMode",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "alert",
+ "type" : "String",
+ "desc" : "r) type alert (changes background / border..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "success",
+ "info",
+ "warning",
+ "danger"
+ ]
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "canvas",
- "type" : "int",
- "desc" : "height",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "cls",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "fa",
+ "type" : "String",
+ "desc" : ".) font awesome ic",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "ban",
+ "check",
+ "..."
+ ]
+ },
+ {
+ "name" : "fasize",
+ "type" : "Number",
+ "desc" : ".) font awsome si",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "1",
+ "2",
+ "...."
+ ]
+ },
+ {
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "e) hide the eleme",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "hideMode",
"type" : "String",
"visibility"
]
},
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "content of column.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "icon",
+ "type" : "String",
+ "desc" : ".) glyphicon na",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "info-sign",
+ "check",
+ "..."
+ ]
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens or 0 for hidden",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "lgoff",
+ "type" : "Number",
+ "desc" : "colspan offset out of 12 for large computer-sized screens or 0 for hidden",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens or 0 for hidden",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "mdoff",
+ "type" : "Number",
+ "desc" : "colspan offset out of 12 for computer-sized screens or 0 for hidden",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "name",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens or 0 for hidden",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "smoff",
+ "type" : "Number",
+ "desc" : "colspan offset out of 12 for tablet-sized screens or 0 for hidden",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "style",
"type" : "String",
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens or 0 for hidden",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "xsoff",
+ "type" : "Number",
+ "desc" : "colspan offset out of 12 for mobile-sized screens or 0 for hidden",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
+ "implementations" : [
+ "Roo.bootstrap.TabGroup"
+ ],
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
"tree_parent" : []
},
- "Roo.bootstrap.Body" : {
+ "Roo.bootstrap.Component" : {
"props" : [
{
"name" : "actionMode",
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"name" : "visibilityEl",
"type" : "string|object",
"desc" : "t) What element to use for visibility (@see getVisibilityEl(",
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : [
"el",
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
}
"type" : "function",
"desc" : "Fires when the children have been rendered..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Get the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Hide a component - adds 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Initialize Events for the element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Set the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Show a component - removes 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Fetch the element to display the tooltip on.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
}
],
- "isAbstract" : false,
+ "isAbstract" : true,
"isBuilderTop" : false,
- "implementations" : [],
+ "implementations" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Body",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.CardFooter",
+ "Roo.bootstrap.CardHeader",
+ "Roo.bootstrap.CardImageTop",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Modal",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Popover",
+ "Roo.bootstrap.PopoverNav",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.TableBody",
+ "Roo.bootstrap.TableCell",
+ "Roo.bootstrap.TableRow",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Item",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.HtmlEditorToolbar.Standard",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.layout.Border",
+ "Roo.bootstrap.layout.Manager",
+ "Roo.bootstrap.menu.Item",
+ "Roo.bootstrap.menu.Menu",
+ "Roo.bootstrap.menu.Separator",
+ "Roo.bootstrap.nav.Bar",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.Item",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
"tree_children" : [
"Roo.bootstrap.Alert",
"Roo.bootstrap.BezierSignature",
"Roo.bootstrap.nav.SidebarItem",
"Roo.bootstrap.nav.Simplebar"
],
- "tree_parent" : [
- "none",
- "builder"
- ]
+ "tree_parent" : []
},
- "Roo.bootstrap.Brick" : {
+ "Roo.bootstrap.Container" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "alert",
+ "type" : "String",
+ "desc" : "r) type alert (changes background / border..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "success",
+ "info",
+ "warning",
+ "danger"
+ ]
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "bgimage",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "clickable",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "cls",
"type" : "String",
- "desc" : "",
- "memberOf" : "",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "expandable",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "expanded",
+ "type" : "Boolean",
+ "desc" : "e) default tr",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "fa",
+ "type" : "String",
+ "desc" : "font awesome icon",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "footer",
+ "type" : "String",
+ "desc" : "content of footer (for panel)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "header",
+ "type" : "String",
+ "desc" : "content of header (for panel)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "e) hide the eleme",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "hideMode",
"type" : "String",
]
},
{
- "name" : "href",
+ "name" : "html",
"type" : "String",
- "desc" : "",
+ "desc" : "content of element",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "html",
+ "name" : "icon",
"type" : "String",
- "desc" : "",
+ "desc" : ".) glyphicon na",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "info-sign",
+ "check",
+ "..."
+ ]
+ },
+ {
+ "name" : "jumbotron",
+ "type" : "Boolean",
+ "desc" : "is it a jumbotron element",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"optvals" : []
},
{
- "name" : "square",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "panel",
+ "type" : "String",
+ "desc" : "r) render as panel - type - primary/success...",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "default",
+ "primary",
+ "success",
+ "info",
+ "warning",
+ "danger"
+ ]
+ },
+ {
+ "name" : "rheader",
+ "type" : "String",
+ "desc" : "contet on the right of header",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "sticky",
+ "type" : "String",
+ "desc" : "h) block to use as footer or body- needs css-bootstrap/sticky-footer.c",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "footer",
+ "wrap",
+ "push"
+ ]
+ },
{
"name" : "style",
"type" : "String",
"optvals" : []
},
{
- "name" : "title",
+ "name" : "tag",
"type" : "String",
- "desc" : "",
+ "desc" : "n) type of HTML ta",
"memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "header",
+ "aside",
+ "section"
+ ]
},
{
"name" : "tooltip",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "video",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "visibilityEl",
"type" : "string|object",
"parent"
]
},
+ {
+ "name" : "well",
+ "type" : "String",
+ "desc" : "d) a well, large, small or mediu",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "lg",
+ "sm",
+ "md"
+ ]
+ },
{
"name" : "xattr",
"type" : "Object",
{
"name" : "click",
"type" : "function",
- "desc" : "When a Brick is click",
+ "desc" : "When a element is chick",
"sig" : "function (_self, e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Brick",
+ "type" : "Roo.bootstrap.Container",
"desc" : "",
"isOptional" : false
},
],
"returns" : []
},
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "After the panel has been collapsed",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Container",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "After the panel has been expand",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Container",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : [
+ "builder"
+ ]
},
- "Roo.bootstrap.Button" : {
+ "Roo.bootstrap.DocumentManager" : {
"props" : [
{
"name" : "actionMode",
"optvals" : []
},
{
- "name" : "badge",
- "type" : "String",
- "desc" : "text for badge",
+ "name" : "boxes",
+ "type" : "Number",
+ "desc" : "number of boxes, 0 is no limit.. default 0",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "badge_weight",
- "type" : "String",
- "desc" : "k) default (same as butto",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "default",
- "primary",
- "secondary",
- "success",
- "info",
- "warning",
- "danger",
- "link",
- "light",
- "dark"
- ]
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"optvals" : []
},
{
- "name" : "disabled",
+ "name" : "editable",
"type" : "Boolean",
- "desc" : "default false;",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fa",
- "type" : "String",
- "desc" : "fontawesome icon - eg. 'comment' - without the fa/fas etc..",
+ "desc" : "e) allow edit when upload a image default tr",
"memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "glyphicon",
+ "name" : "fieldLabel",
"type" : "String",
- "desc" : "depricated - use fa",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "grpup",
- "type" : "Boolean",
- "desc" : "if parent is a btn group - then it turns it into a toogleGroup.",
+ "desc" : "",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
]
},
{
- "name" : "href",
- "type" : "String",
- "desc" : "empty or href",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "html",
+ "name" : "labelAlign",
"type" : "String",
- "desc" : "The button content",
+ "desc" : "p) default le",
"memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "left",
+ "top"
+ ]
},
{
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "dark themed version",
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "default 4",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "isClose",
- "type" : "Boolean",
- "desc" : "default false;",
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "menu",
- "type" : "Roo.bootstrap.menu.Menu",
- "desc" : "a Menu",
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "offtext",
- "type" : "String",
- "desc" : "text for off slidy toggle state",
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "ontext",
- "type" : "String",
- "desc" : "text for on slidy toggle state",
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "outline",
- "type" : "Boolean",
- "desc" : "default false (except for weight=default which emulates old behaveiour with an outline)",
- "memberOf" : "",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "pressed",
- "type" : "Boolean",
- "desc" : "default null - if the button ahs active state",
+ "name" : "method",
+ "type" : "String",
+ "desc" : "default POST",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "preventDefault",
+ "name" : "multiple",
"type" : "Boolean",
- "desc" : "default true (stop click event triggering the URL if it's a link.)",
+ "desc" : "multiple upload default true",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "removeClass",
- "type" : "Boolean",
- "desc" : "remove the standard class..",
- "memberOf" : "",
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "size",
+ "name" : "paramName",
"type" : "String",
- "desc" : "",
+ "desc" : "default 'imageUpload'",
"memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "lg",
- "sm",
- "xs"
- ]
+ "optvals" : []
},
{
"name" : "style",
"optvals" : []
},
{
- "name" : "tag",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "a",
- "input",
- "submit"
- ]
- },
- {
- "name" : "target",
- "type" : "String",
- "desc" : "r) target for a hre",
+ "name" : "thumbSize",
+ "type" : "Number",
+ "desc" : "default 300",
"memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "_self",
- "_blank",
- "_parent",
- "_top",
- "other"
- ]
+ "optvals" : []
},
{
- "name" : "theme",
+ "name" : "toolTipName",
"type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "default",
- "glow"
- ]
- },
- {
- "name" : "toggle",
- "type" : "Boolean",
- "desc" : "is it a slidy toggle button",
+ "desc" : "default 'filename'",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "url",
+ "type" : "String",
+ "desc" : "action url",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"parent"
]
},
- {
- "name" : "weight",
- "type" : "String",
- "desc" : "k) defau",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "default",
- "primary",
- "secondary",
- "success",
- "info",
- "warning",
- "danger",
- "link",
- "light",
- "dark"
- ]
- },
{
"name" : "xattr",
"type" : "Object",
}
],
"events" : [
+ {
+ "name" : "afterupload",
+ "type" : "function",
+ "desc" : "Fire when xhr load exception",
+ "sig" : "function (_self, xhr)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.DocumentManager",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "xhr",
+ "type" : "XMLHttpRequest",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "beforeselectfile",
+ "type" : "function",
+ "desc" : "Fire before select file",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.DocumentManager",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforeshow",
"type" : "function",
{
"name" : "click",
"type" : "function",
- "desc" : "When a button is pressed",
- "sig" : "function (btn, e)\n{\n\n}",
+ "desc" : "Fire after click the image",
+ "sig" : "function (_self, file)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "btn",
- "type" : "Roo.bootstrap.Button",
+ "name" : "this",
+ "type" : "Roo.bootstrap.DocumentManager",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "file",
+ "type" : "Object",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "dblclick",
+ "name" : "destroy",
"type" : "function",
- "desc" : "When a button is double clicked",
- "sig" : "function (btn, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "btn",
- "type" : "Roo.bootstrap.Button",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
+ "desc" : "Fires after the component is disabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "disable",
+ "name" : "edit",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fire when upload a image and editable set to true",
+ "sig" : "function (_self, file)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.DocumentManager",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "file",
+ "type" : "Object",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "exception",
+ "type" : "function",
+ "desc" : "Fire when xhr load exception",
+ "sig" : "function (_self, xhr)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.DocumentManager",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "xhr",
+ "type" : "XMLHttpRequest",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
"returns" : []
},
{
- "name" : "render",
+ "name" : "initial",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
+ "desc" : "Fire when initial the DocumentManager",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.DocumentManager",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "show",
+ "name" : "inspect",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "inspect selected file",
+ "sig" : "function (_self, file)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.DocumentManager",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "file",
+ "type" : "File",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "toggle",
+ "name" : "prepare",
"type" : "function",
- "desc" : "After the button has been toggles",
- "sig" : "function (btn, e, pressed)\n{\n\n}",
+ "desc" : "prepare the form data",
+ "sig" : "function (_self, formData)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "btn",
- "type" : "Roo.bootstrap.Button",
+ "name" : "this",
+ "type" : "Roo.bootstrap.DocumentManager",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "formData",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "previewrendered",
+ "type" : "function",
+ "desc" : "Fire when preview rendered",
+ "sig" : "function (_self, file)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.DocumentManager",
"desc" : "",
"isOptional" : false
},
{
- "name" : "pressed",
- "type" : "boolean",
- "desc" : "(also available as button.pressed)",
+ "name" : "file",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "process",
+ "type" : "function",
+ "desc" : "Fire before process file",
+ "sig" : "function (_self, file)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.DocumentManager",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "file",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "refresh",
+ "type" : "function",
+ "desc" : "Fire after refresh the file",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.DocumentManager",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "remove",
+ "type" : "function",
+ "desc" : "Fire when remove the file",
+ "sig" : "function (_self, file)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.DocumentManager",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "file",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
{
"name" : "disable",
"type" : "function",
- "desc" : "Disable this button",
+ "desc" : "Disable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "enable",
"type" : "function",
- "desc" : "Enables this button",
+ "desc" : "Enable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "fireEvent",
}
]
},
- {
- "name" : "getText",
- "type" : "function",
- "desc" : "get the text of the first selected button",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "isActive",
- "type" : "function",
- "desc" : "get the current active state",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "boolean",
- "desc" : "true if it's active"
- }
- ]
- },
{
"name" : "isVisible",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setActive",
- "type" : "function",
- "desc" : "sets the active state on/off,",
- "sig" : "(state)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "state",
- "type" : "Boolean",
- "desc" : "(optional) Force a particular state",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setText",
- "type" : "function",
- "desc" : "set the text of the first selected button",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "toggleActive",
- "type" : "function",
- "desc" : "toggles the current active state",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "tooltipEl",
"type" : "function",
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.form.CardUploader"
- ],
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.ButtonGroup" : {
+ "Roo.bootstrap.DocumentSlider" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "align",
- "type" : "String",
- "desc" : "vertical | justified (default none)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "btn",
- "type" : "Boolean",
- "desc" : "true | false",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "direction",
- "type" : "String",
- "desc" : "up | down (default down)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "disableClass",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "size",
- "type" : "String",
- "desc" : "lg | sm | xs (default empty normal)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "style",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "toolbar",
- "type" : "Boolean",
- "desc" : "false | true",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "tooltip",
"type" : "string",
],
"returns" : []
},
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "Fire after click",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.DocumentSlider",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "initial",
+ "type" : "function",
+ "desc" : "Fire after initEvent",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.DocumentSlider",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "update",
+ "type" : "function",
+ "desc" : "Fire after update",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.DocumentSlider",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
],
"returns" : []
},
- {
- "name" : "addItem",
- "type" : "function",
- "desc" : "Add a button to the group (similar to NavItem API.)",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "addListener",
"type" : "function",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.Button",
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.form.CardUploader",
- "Roo.bootstrap.form.Form"
- ],
+ "tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.ButtonUploader" : {
+ "Roo.bootstrap.DocumentViewer" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "badge",
- "type" : "String",
- "desc" : "text for badge",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "badge_weight",
- "type" : "String",
- "desc" : "k) default (same as butto",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : [
- "default",
- "primary",
- "secondary",
- "success",
- "info",
- "warning",
- "danger",
- "link",
- "light",
- "dark"
- ]
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "default false;",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "errorTimeout",
- "type" : "Number",
- "desc" : "default 3000",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fa",
- "type" : "String",
- "desc" : "fontawesome icon - eg. 'comment' - without the fa/fas etc..",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "glyphicon",
- "type" : "String",
- "desc" : "depricated - use fa",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "grpup",
- "type" : "Boolean",
- "desc" : "if parent is a btn group - then it turns it into a toogleGroup.",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "hideMode",
"type" : "String",
"visibility"
]
},
- {
- "name" : "href",
- "type" : "String",
- "desc" : "empty or href",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "html",
- "type" : "Array",
- "desc" : "The button text.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "images",
- "type" : "Array",
- "desc" : "an array of ?? Img objects ??? when loading existing files..",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "dark themed version",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "isClose",
- "type" : "Boolean",
- "desc" : "default false;",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "menu",
- "type" : "Roo.bootstrap.menu.Menu",
- "desc" : "a Menu",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "multiple",
- "type" : "Boolean",
- "desc" : "(default true) Should the upload allow multiple files to be uploaded.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "name",
"type" : "string",
"optvals" : []
},
{
- "name" : "offtext",
- "type" : "String",
- "desc" : "text for off slidy toggle state",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "ontext",
- "type" : "String",
- "desc" : "text for on slidy toggle state",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "outline",
- "type" : "Boolean",
- "desc" : "default false (except for weight=default which emulates old behaveiour with an outline)",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "pressed",
- "type" : "Boolean",
- "desc" : "default null - if the button ahs active state",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "preventDefault",
+ "name" : "showDownload",
"type" : "Boolean",
- "desc" : "default true (stop click event triggering the URL if it's a link.)",
- "memberOf" : "Roo.bootstrap.Button",
+ "desc" : "e) show download button (default tru",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "removeClass",
+ "name" : "showTrash",
"type" : "Boolean",
- "desc" : "remove the standard class..",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "size",
- "type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.Button",
+ "desc" : "e) show trash button (default tru",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : [
- "lg",
- "sm",
- "xs"
+ "true",
+ "false"
]
},
{
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "tag",
- "type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : [
- "a",
- "input",
- "submit"
- ]
- },
- {
- "name" : "target",
- "type" : "String",
- "desc" : "r) target for a hre",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : [
- "_self",
- "_blank",
- "_parent",
- "_top",
- "other"
- ]
- },
- {
- "name" : "theme",
- "type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : [
- "default",
- "glow"
- ]
- },
- {
- "name" : "toggle",
- "type" : "Boolean",
- "desc" : "is it a slidy toggle button",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "tooltip",
"type" : "string",
"parent"
]
},
- {
- "name" : "weight",
- "type" : "String",
- "desc" : "k) defau",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : [
- "default",
- "primary",
- "secondary",
- "success",
- "info",
- "warning",
- "danger",
- "link",
- "light",
- "dark"
- ]
- },
{
"name" : "xattr",
"type" : "Object",
],
"returns" : []
},
- {
- "name" : "beforeselect",
- "type" : "function",
- "desc" : "When button is pressed, before show upload files dialog is shown",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploaderButton",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforeshow",
"type" : "function",
{
"name" : "click",
"type" : "function",
- "desc" : "When a button is pressed",
- "sig" : "function (btn, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Button",
+ "desc" : "Fire after click",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "btn",
- "type" : "Roo.bootstrap.Button",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.bootstrap.DocumentViewer",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "dblclick",
+ "name" : "destroy",
"type" : "function",
- "desc" : "When a button is double clicked",
- "sig" : "function (btn, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Button",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "btn",
- "type" : "Roo.bootstrap.Button",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
+ "desc" : "Fires after the component is disabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "disable",
+ "name" : "download",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
+ "desc" : "Fire after download button",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.DocumentViewer",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "fired when files have been selected,",
+ "name" : "hide",
"type" : "function",
- "desc" : "When a the download link is clicked",
- "sig" : "function (_self, Array)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.UploaderButton",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "Array",
- "type" : "Array",
- "desc" : "of files that have been uploaded",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "hide",
+ "name" : "initial",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fire after initEvent",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.DocumentViewer",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "toggle",
+ "name" : "trash",
"type" : "function",
- "desc" : "After the button has been toggles",
- "sig" : "function (btn, e, pressed)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Button",
+ "desc" : "Fire after trash button",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "btn",
- "type" : "Roo.bootstrap.Button",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.bootstrap.DocumentViewer",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "pressed",
- "type" : "boolean",
- "desc" : "(also available as button.pressed)",
- "isOptional" : false
}
],
"returns" : []
{
"name" : "disable",
"type" : "function",
- "desc" : "Disable this button",
+ "desc" : "Disable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Button",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "enable",
"type" : "function",
- "desc" : "Enables this button",
+ "desc" : "Enable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Button",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "fireEvent",
}
]
},
- {
- "name" : "getText",
- "type" : "function",
- "desc" : "get the text of the first selected button",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Button",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "isActive",
- "type" : "function",
- "desc" : "get the current active state",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Button",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "boolean",
- "desc" : "true if it's active"
- }
- ]
- },
{
"name" : "isVisible",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "addCard - add an Attachment to the uploader",
- "sig" : "(data)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "data",
- "type" : "",
- "desc" : "- the data about the image to upload\n\n{\n id : 123\n title : \"Title of file\",\n is_uploaded : false,\n src : \"http://.....\",\n srcfile : { the File upload object },\n mimetype : file.type,\n preview : false,\n is_deleted : 0\n .. any other data...\n }",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setActive",
- "type" : "function",
- "desc" : "sets the active state on/off,",
- "sig" : "(state)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Button",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "state",
- "type" : "Boolean",
- "desc" : "(optional) Force a particular state",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setText",
- "type" : "function",
- "desc" : "set the text of the first selected button",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Button",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "toggleActive",
- "type" : "function",
- "desc" : "toggles the current active state",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Button",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "tooltipEl",
"type" : "function",
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.Calendar" : {
+ "Roo.bootstrap.DropTarget" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "clickable",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "class of the element",
+ "memberOf" : "Roo.bootstrap.Element",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "header",
- "type" : "Object",
- "desc" : "generate the user specific header of the calendar, default false",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "hideMode",
"type" : "String",
"visibility"
]
},
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "contents of the element",
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"optvals" : []
},
{
- "name" : "loadMask",
+ "name" : "name",
+ "type" : "string",
+ "desc" : "dropable name",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "preventDefault",
"type" : "Boolean",
"desc" : "e) default fal",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Element",
"isOptional" : false,
"optvals" : [
"true",
]
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "startDay",
- "type" : "Number",
- "desc" : "Day index at which the week should begin, 0-based (defaults to 0, which is Sunday)",
- "memberOf" : "",
+ "name" : "role",
+ "type" : "String",
+ "desc" : "default blank - set to button to force cursor pointer",
+ "memberOf" : "Roo.bootstrap.Element",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data source for the calendar",
- "memberOf" : "",
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "style",
+ "name" : "tag",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "tag of the element",
+ "memberOf" : "Roo.bootstrap.Element",
"isOptional" : false,
"optvals" : []
},
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "click",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "When a element is chick",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.Element",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "enable",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
+ "desc" : "Fires after the component is destroyed.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "eventclick",
- "type" : "function",
- "desc" : "Fires when the mouse click an",
- "sig" : "function (_self, )\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Calendar",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "",
- "type" : "event",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "evententer",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires when mouse over an event",
- "sig" : "function (_self, Event)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Calendar",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "Event",
- "type" : "event",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "eventleave",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires when the mouse leaves an",
- "sig" : "function (_self, )\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Calendar",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "",
- "type" : "event",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "monthchange",
- "type" : "function",
- "desc" : "Fires when the displayed month changes",
- "sig" : "function (_self, date)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "DatePicker",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "date",
- "type" : "Date",
- "desc" : "The selected month",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when a date is selected",
- "sig" : "function (_self, date)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "DatePicker",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "date",
- "type" : "Date",
- "desc" : "The selected date",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.Card" : {
+ "Roo.bootstrap.Element" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "clickable",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "class of the element",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "display",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "none",
- "inline",
- "inline-block",
- "block",
- "table",
- "table-cell",
- "table-row",
- "flex",
- "inline-flex"
- ]
- },
- {
- "name" : "display_lg",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "none",
- "inline",
- "inline-block",
- "block",
- "table",
- "table-cell",
- "table-row",
- "flex",
- "inline-flex"
- ]
- },
- {
- "name" : "display_sm",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "none",
- "inline",
- "inline-block",
- "block",
- "table",
- "table-cell",
- "table-row",
- "flex",
- "inline-flex"
- ]
- },
- {
- "name" : "display_xl",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "none",
- "inline",
- "inline-block",
- "block",
- "table",
- "table-cell",
- "table-row",
- "flex",
- "inline-flex"
- ]
- },
- {
- "name" : "display_xs",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "none",
- "inline",
- "inline-block",
- "block",
- "table",
- "table-cell",
- "table-row",
- "flex",
- "inline-flex"
- ]
- },
- {
- "name" : "footer",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "header",
- "type" : "String|Object",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "header_image",
- "type" : "String",
- "desc" : "src url of image.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "header_size",
- "type" : "Number",
- "desc" : "5) H1 or H2 etc.. 0 indicates defau",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "0",
- "1",
- "2",
- "3",
- "4",
- "5"
- ]
- },
- {
- "name" : "header_weight",
- "type" : "Number",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "primary",
- "secondary",
- "success",
- "info",
- "warning",
- "danger",
- "light",
- "dark"
- ]
- },
{
"name" : "hideMode",
"type" : "String",
},
{
"name" : "html",
- "type" : "String|Boolean",
- "desc" : "-- html contents - or just use children.. use false to hide it..",
+ "type" : "String",
+ "desc" : "contents of the element",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "margin",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "0",
- "1",
- "2",
- "3",
- "4",
- "5",
- "auto"
- ]
- },
- {
- "name" : "margin_bottom",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "0",
- "1",
- "2",
- "3",
- "4",
- "5",
- "auto"
- ]
- },
- {
- "name" : "margin_left",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "0",
- "1",
- "2",
- "3",
- "4",
- "5",
- "auto"
- ]
- },
- {
- "name" : "margin_right",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "0",
- "1",
- "2",
- "3",
- "4",
- "5",
- "auto"
- ]
- },
- {
- "name" : "margin_top",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "0",
- "1",
- "2",
- "3",
- "4",
- "5",
- "auto"
- ]
- },
- {
- "name" : "margin_x",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "0",
- "1",
- "2",
- "3",
- "4",
- "5",
- "auto"
- ]
- },
- {
- "name" : "margin_y",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "0",
- "1",
- "2",
- "3",
- "4",
- "5",
- "auto"
- ]
- },
{
"name" : "name",
"type" : "string",
"optvals" : []
},
{
- "name" : "padding",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "0",
- "1",
- "2",
- "3",
- "4",
- "5"
- ]
- },
- {
- "name" : "padding_bottom",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "0",
- "1",
- "2",
- "3",
- "4",
- "5"
- ]
- },
- {
- "name" : "padding_left",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "0",
- "1",
- "2",
- "3",
- "4",
- "5"
- ]
- },
- {
- "name" : "padding_right",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "0",
- "1",
- "2",
- "3",
- "4",
- "5"
- ]
- },
- {
- "name" : "padding_top",
- "type" : "String",
- "desc" : "5)next_to_ca",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "0",
- "1",
- "2",
- "3",
- "4",
- "5"
- ]
- },
- {
- "name" : "padding_x",
- "type" : "String",
- "desc" : "",
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
"memberOf" : "",
"isOptional" : false,
"optvals" : [
- "0",
- "1",
- "2",
- "3",
- "4",
- "5"
+ "true",
+ "false"
]
},
{
- "name" : "padding_y",
+ "name" : "role",
"type" : "String",
- "desc" : "",
+ "desc" : "default blank - set to button to force cursor pointer",
"memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "0",
- "1",
- "2",
- "3",
- "4",
- "5"
- ]
+ "optvals" : []
},
{
"name" : "style",
"optvals" : []
},
{
- "name" : "subtitle",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "title",
+ "name" : "tag",
"type" : "String",
- "desc" : "",
+ "desc" : "tag of the element",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"parent"
]
},
- {
- "name" : "weight",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "primary",
- "warning",
- "info",
- "danger",
- "secondary",
- "success",
- "light",
- "dark"
- ]
- },
{
"name" : "xattr",
"type" : "Object",
"returns" : []
},
{
- "name" : "cardover",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "When a card element is dragged over ready to drop (return false to block dropable)",
- "sig" : "function (_self, data)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Card",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "from dragdrop",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "click",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "When a element is chick",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "type" : "Roo.bootstrap.Element",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "drop",
- "type" : "function",
- "desc" : "When a element a card is dropped",
- "sig" : "function (_self, move_card, position, next_to_card)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Card",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "move_card",
- "type" : "Roo.bootstrap.Card",
- "desc" : "the card being dropped?",
- "isOptional" : false
- },
- {
- "name" : "position",
- "type" : "String",
- "desc" : "'above' or 'below'",
- "isOptional" : false
- },
- {
- "name" : "next_to_card",
- "type" : "Roo.bootstrap.Card",
- "desc" : "What card position is relative to of 'false' for empty list.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "rotate",
- "type" : "function",
- "desc" : "When a element a card is rotate",
- "sig" : "function (_self, n, rotate)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Card",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "n",
- "type" : "Roo.Element",
- "desc" : "the node being dropped?",
- "isOptional" : false
- },
- {
- "name" : "rotate",
- "type" : "Boolean",
- "desc" : "status",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
}
],
"methods" : [
- {
- "name" : "acceptCard",
- "type" : "function",
- "desc" : "accept card\n\n- card.acceptCard(move_card, info.position, info.card, info.items_n);",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "addEvents",
"type" : "function",
}
]
},
- {
- "name" : "getDropPoint",
- "type" : "function",
- "desc" : "Decide whether to drop above or below a View node.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "getEl",
"type" : "function",
}
]
},
- {
- "name" : "getTargetFromEvent",
- "type" : "function",
- "desc" : "Part of the Roo.dd.DropZone interface. If no target node is found, the\n whole Element becomes the target, and this causes the drop gesture to append.\n\n Returns an object:\n {\n \n position : 'below' or 'above'\n card : relateive to card OBJECT (or true for no cards listed)\n items_n : relative to nth item in list\n card_n : relative to nth card in list\n }",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "getVisibilityEl",
"type" : "function",
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
+ "implementations" : [
+ "Roo.bootstrap.CardFooter",
+ "Roo.bootstrap.CardHeader",
+ "Roo.bootstrap.CardImageTop",
+ "Roo.bootstrap.DropTarget"
+ ],
"tree_children" : [
"Roo.bootstrap.Alert",
"Roo.bootstrap.BezierSignature",
"Roo.bootstrap.ButtonUploader",
"Roo.bootstrap.Calendar",
"Roo.bootstrap.Card",
- "Roo.bootstrap.CardFooter",
- "Roo.bootstrap.CardHeader",
- "Roo.bootstrap.CardImageTop",
"Roo.bootstrap.Column",
"Roo.bootstrap.DocumentManager",
"Roo.bootstrap.DocumentSlider",
],
"tree_parent" : []
},
- "Roo.bootstrap.CardFooter" : {
+ "Roo.bootstrap.Graph" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "clickable",
- "type" : "Boolean",
- "desc" : "e) default fal",
- "memberOf" : "Roo.bootstrap.Element",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
{
"name" : "cls",
"type" : "String",
- "desc" : "class of the element",
- "memberOf" : "Roo.bootstrap.Element",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "g_height",
+ "type" : "number",
+ "desc" : "height of the chart (respected by all elements in the set)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "g_r",
+ "type" : "number",
+ "desc" : "radius (pie)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "g_width",
+ "type" : "number",
+ "desc" : "width of the chart (respected by all elements in the set)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "g_x",
+ "type" : "number",
+ "desc" : "coodinator | centre x (pie)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "g_y",
+ "type" : "number",
+ "desc" : "coodinator | centre y (pie)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "graphtype",
+ "type" : "String",
+ "desc" : "bar | vbar | pie",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "hideMode",
"type" : "String",
"visibility"
]
},
- {
- "name" : "html",
- "type" : "String",
- "desc" : "contents of the element",
- "memberOf" : "Roo.bootstrap.Element",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "e) default fal",
- "memberOf" : "Roo.bootstrap.Element",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "role",
- "type" : "String",
- "desc" : "default blank - set to button to force cursor pointer",
- "memberOf" : "Roo.bootstrap.Element",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "style",
"type" : "String",
"optvals" : []
},
{
- "name" : "tag",
- "type" : "String",
- "desc" : "tag of the element",
- "memberOf" : "Roo.bootstrap.Element",
+ "name" : "title",
+ "type" : "Object",
+ "desc" : "The title of the chart\n \n -{Array} values\n -opts (object) options for the chart \n o {\n o type (string) type of endings of the bar. Default: 'square'. Other options are: 'round', 'sharp', 'soft'.\n o gutter (number)(string) default '20%' (WHAT DOES IT DO?)\n o vgutter (number)\n o colors (array) colors be used repeatedly to plot the bars. If multicolumn bar is used each sequence of bars with use a different color.\n o stacked (boolean) whether or not to tread values as in a stacked bar chart\n o to\n o stretch (boolean)\n o }\n -opts (object) options for the pie\n o{\n o cut\n o startAngle (number)\n o endAngle (number)\n }",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
"name" : "click",
"type" : "function",
- "desc" : "When a element is chick",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Element",
+ "desc" : "The img click event for the img.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Element",
- "desc" : "",
- "isOptional" : false
- },
{
"name" : "e",
"type" : "Roo.EventObject",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.Alert",
- "Roo.bootstrap.BezierSignature",
- "Roo.bootstrap.Brick",
- "Roo.bootstrap.Button",
- "Roo.bootstrap.ButtonGroup",
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.Calendar",
- "Roo.bootstrap.Card",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.DocumentManager",
- "Roo.bootstrap.DocumentSlider",
- "Roo.bootstrap.DocumentViewer",
- "Roo.bootstrap.DropTarget",
- "Roo.bootstrap.Element",
- "Roo.bootstrap.Graph",
- "Roo.bootstrap.Header",
- "Roo.bootstrap.Img",
- "Roo.bootstrap.LayoutMasonry",
- "Roo.bootstrap.LayoutMasonryAuto",
- "Roo.bootstrap.Link",
- "Roo.bootstrap.LocationPicker",
- "Roo.bootstrap.MasonryBrick",
- "Roo.bootstrap.MessageBar",
- "Roo.bootstrap.Pagination",
- "Roo.bootstrap.PaginationItem",
- "Roo.bootstrap.PagingToolbar",
- "Roo.bootstrap.Progress",
- "Roo.bootstrap.ProgressBar",
- "Roo.bootstrap.Row",
- "Roo.bootstrap.Slider",
- "Roo.bootstrap.TabGroup",
- "Roo.bootstrap.TabPanel",
- "Roo.bootstrap.Table",
- "Roo.bootstrap.UploadCropbox",
- "Roo.bootstrap.breadcrumb.Nav",
- "Roo.bootstrap.dash.NumberBox",
- "Roo.bootstrap.dash.TabBox",
- "Roo.bootstrap.dash.TabPane",
- "Roo.bootstrap.form.CardUploader",
- "Roo.bootstrap.form.CheckBox",
- "Roo.bootstrap.form.ComboBox",
- "Roo.bootstrap.form.DateField",
- "Roo.bootstrap.form.DateSplitField",
- "Roo.bootstrap.form.FieldLabel",
- "Roo.bootstrap.form.Form",
- "Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.Input",
- "Roo.bootstrap.form.Markdown",
- "Roo.bootstrap.form.MoneyField",
- "Roo.bootstrap.form.MonthField",
- "Roo.bootstrap.form.NumberField",
- "Roo.bootstrap.form.Password",
- "Roo.bootstrap.form.PhoneInput",
- "Roo.bootstrap.form.Radio",
- "Roo.bootstrap.form.RadioSet",
- "Roo.bootstrap.form.SecurePass",
- "Roo.bootstrap.form.TextArea",
- "Roo.bootstrap.form.TimeField",
- "Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.nav.Group",
- "Roo.bootstrap.nav.Headerbar",
- "Roo.bootstrap.nav.ProgressBar",
- "Roo.bootstrap.nav.ProgressBarItem",
- "Roo.bootstrap.nav.Sidebar",
- "Roo.bootstrap.nav.SidebarItem",
- "Roo.bootstrap.nav.Simplebar"
- ],
- "tree_parent" : [
- "Roo.bootstrap.Card"
- ]
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.CardHeader" : {
+ "Roo.bootstrap.Header" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "clickable",
- "type" : "Boolean",
- "desc" : "e) default fal",
- "memberOf" : "Roo.bootstrap.Element",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
{
"name" : "cls",
"type" : "String",
- "desc" : "class of the element",
- "memberOf" : "Roo.bootstrap.Element",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
"name" : "html",
"type" : "String",
- "desc" : "contents of the element",
- "memberOf" : "Roo.bootstrap.Element",
+ "desc" : "content of header",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "level",
+ "type" : "Number",
+ "desc" : "6) default",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "1",
+ "2",
+ "3",
+ "4",
+ "5",
+ "6"
+ ]
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "e) default fal",
- "memberOf" : "Roo.bootstrap.Element",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "role",
- "type" : "String",
- "desc" : "default blank - set to button to force cursor pointer",
- "memberOf" : "Roo.bootstrap.Element",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "style",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "tag",
- "type" : "String",
- "desc" : "tag of the element",
- "memberOf" : "Roo.bootstrap.Element",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "tooltip",
"type" : "string",
],
"returns" : []
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "When a element is chick",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Element",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
"Roo.bootstrap.nav.SidebarItem",
"Roo.bootstrap.nav.Simplebar"
],
- "tree_parent" : [
- "Roo.bootstrap.Card"
- ]
+ "tree_parent" : []
},
- "Roo.bootstrap.CardImageTop" : {
+ "Roo.bootstrap.Img" : {
"props" : [
{
"name" : "actionMode",
"optvals" : []
},
{
- "name" : "can_build_overlaid",
+ "name" : "alt",
+ "type" : "String",
+ "desc" : "image alternative text",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "backgroundContain",
"type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "(use style background and contain image in content)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "clickable",
+ "name" : "border",
+ "type" : "String",
+ "desc" : "rounded | circle | thumbnail",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "can_build_overlaid",
"type" : "Boolean",
- "desc" : "e) default fal",
- "memberOf" : "Roo.bootstrap.Element",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
- "desc" : "class of the element",
- "memberOf" : "Roo.bootstrap.Element",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
]
},
{
- "name" : "html",
+ "name" : "href",
"type" : "String",
- "desc" : "contents of the element",
- "memberOf" : "Roo.bootstrap.Element",
+ "desc" : "a tag href",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "imgResponsive",
+ "type" : "Boolean",
+ "desc" : "false | true",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "lgUrl",
+ "type" : "String",
+ "desc" : "lg image source",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "mdUrl",
+ "type" : "String",
+ "desc" : "md image source",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "name",
"type" : "string",
"optvals" : []
},
{
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "e) default fal",
- "memberOf" : "Roo.bootstrap.Element",
+ "name" : "smUrl",
+ "type" : "String",
+ "desc" : "sm image source",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
+ "optvals" : []
},
{
- "name" : "role",
+ "name" : "src",
"type" : "String",
- "desc" : "default blank - set to button to force cursor pointer",
- "memberOf" : "Roo.bootstrap.Element",
+ "desc" : "image source",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "tag",
+ "name" : "target",
"type" : "String",
- "desc" : "tag of the element",
- "memberOf" : "Roo.bootstrap.Element",
+ "desc" : "p)target for a hre",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "_self",
+ "_blank",
+ "_parent",
+ "_top"
+ ]
},
{
"name" : "tooltip",
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
+ },
+ {
+ "name" : "xsUrl",
+ "type" : "String",
+ "desc" : "xs image source",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
"name" : "click",
"type" : "function",
- "desc" : "When a element is chick",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Element",
+ "desc" : "The img click event for the img.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Element",
- "desc" : "",
- "isOptional" : false
- },
{
"name" : "e",
"type" : "Roo.EventObject",
],
"returns" : []
},
+ {
+ "name" : "load",
+ "type" : "function",
+ "desc" : "The when any image loads",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setSrc",
+ "type" : "function",
+ "desc" : "Sets the url of the image - used to update it",
+ "sig" : "(url)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "url",
+ "type" : "String",
+ "desc" : "the url of the image",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.Alert",
- "Roo.bootstrap.BezierSignature",
- "Roo.bootstrap.Brick",
- "Roo.bootstrap.Button",
- "Roo.bootstrap.ButtonGroup",
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.Calendar",
- "Roo.bootstrap.Card",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.DocumentManager",
- "Roo.bootstrap.DocumentSlider",
- "Roo.bootstrap.DocumentViewer",
- "Roo.bootstrap.DropTarget",
- "Roo.bootstrap.Element",
- "Roo.bootstrap.Graph",
- "Roo.bootstrap.Header",
- "Roo.bootstrap.Img",
- "Roo.bootstrap.LayoutMasonry",
- "Roo.bootstrap.LayoutMasonryAuto",
- "Roo.bootstrap.Link",
- "Roo.bootstrap.LocationPicker",
- "Roo.bootstrap.MasonryBrick",
- "Roo.bootstrap.MessageBar",
- "Roo.bootstrap.Pagination",
- "Roo.bootstrap.PaginationItem",
- "Roo.bootstrap.PagingToolbar",
- "Roo.bootstrap.Progress",
- "Roo.bootstrap.ProgressBar",
- "Roo.bootstrap.Row",
- "Roo.bootstrap.Slider",
- "Roo.bootstrap.TabGroup",
- "Roo.bootstrap.TabPanel",
- "Roo.bootstrap.Table",
- "Roo.bootstrap.UploadCropbox",
- "Roo.bootstrap.breadcrumb.Nav",
- "Roo.bootstrap.dash.NumberBox",
- "Roo.bootstrap.dash.TabBox",
- "Roo.bootstrap.dash.TabPane",
- "Roo.bootstrap.form.CardUploader",
- "Roo.bootstrap.form.CheckBox",
- "Roo.bootstrap.form.ComboBox",
- "Roo.bootstrap.form.DateField",
- "Roo.bootstrap.form.DateSplitField",
- "Roo.bootstrap.form.FieldLabel",
- "Roo.bootstrap.form.Form",
- "Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.Input",
- "Roo.bootstrap.form.Markdown",
- "Roo.bootstrap.form.MoneyField",
- "Roo.bootstrap.form.MonthField",
- "Roo.bootstrap.form.NumberField",
- "Roo.bootstrap.form.Password",
- "Roo.bootstrap.form.PhoneInput",
- "Roo.bootstrap.form.Radio",
- "Roo.bootstrap.form.RadioSet",
- "Roo.bootstrap.form.SecurePass",
- "Roo.bootstrap.form.TextArea",
- "Roo.bootstrap.form.TimeField",
- "Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.nav.Group",
- "Roo.bootstrap.nav.Headerbar",
- "Roo.bootstrap.nav.ProgressBar",
- "Roo.bootstrap.nav.ProgressBarItem",
- "Roo.bootstrap.nav.Sidebar",
- "Roo.bootstrap.nav.SidebarItem",
- "Roo.bootstrap.nav.Simplebar"
- ],
- "tree_parent" : [
- "Roo.bootstrap.Card"
- ]
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.Column" : {
+ "Roo.bootstrap.LayoutMasonry" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "alert",
- "type" : "String",
- "desc" : "r) type alert (changes background / border..",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "success",
- "info",
- "warning",
- "danger"
- ]
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "alternativePadWidth",
+ "type" : "Number",
+ "desc" : "padding below box..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "boxHeight",
+ "type" : "Number",
+ "desc" : "- 0 for square, or fix it at a certian height",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "boxWidth",
+ "type" : "Number",
+ "desc" : "width of the columns",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"optvals" : []
},
{
- "name" : "fa",
- "type" : "String",
- "desc" : ".) font awesome ic",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "ban",
- "check",
- "..."
- ]
- },
- {
- "name" : "fasize",
+ "name" : "gutter",
"type" : "Number",
- "desc" : ".) font awsome si",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "1",
- "2",
- "...."
- ]
- },
- {
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "e) hide the eleme",
+ "desc" : "gutter width..",
"memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
+ "optvals" : []
},
{
"name" : "hideMode",
]
},
{
- "name" : "html",
- "type" : "String",
- "desc" : "content of column.",
+ "name" : "isAutoInitial",
+ "type" : "Boolean",
+ "desc" : "defalut true",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "icon",
- "type" : "String",
- "desc" : ".) glyphicon na",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "info-sign",
- "check",
- "..."
- ]
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens or 0 for hidden",
+ "name" : "isHorizontal",
+ "type" : "Boolean",
+ "desc" : "defalut false",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "lgoff",
- "type" : "Number",
- "desc" : "colspan offset out of 12 for large computer-sized screens or 0 for hidden",
+ "name" : "isLayoutInstant",
+ "type" : "Boolean",
+ "desc" : "= no animation?",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"optvals" : []
},
{
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens or 0 for hidden",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "mdoff",
+ "name" : "maxCols",
"type" : "Number",
- "desc" : "colspan offset out of 12 for computer-sized screens or 0 for hidden",
+ "desc" : "maximum number of columns",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"optvals" : []
},
{
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens or 0 for hidden",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "smoff",
+ "name" : "padWidth",
"type" : "Number",
- "desc" : "colspan offset out of 12 for tablet-sized screens or 0 for hidden",
+ "desc" : "padding below box..",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens or 0 for hidden",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "xsoff",
- "type" : "Number",
- "desc" : "colspan offset out of 12 for mobile-sized screens or 0 for hidden",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
}
],
"events" : [
],
"returns" : []
},
+ {
+ "name" : "layout",
+ "type" : "function",
+ "desc" : "Fire after layout the items",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.LayoutMasonry",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
}
],
"methods" : [
+ {
+ "name" : "_processVerticalLayoutQueue",
+ "type" : "function",
+ "desc" : "Sets position of item in DOM",
+ "sig" : "(item, x, y, isInstant)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "item",
+ "type" : "Element",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "- horizontal position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "- vertical position",
+ "isOptional" : false
+ },
+ {
+ "name" : "isInstant",
+ "type" : "Boolean",
+ "desc" : "- disables transitions",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "addBrick",
+ "type" : "function",
+ "desc" : "adds a Masonry Brick",
+ "sig" : "(the)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "Roo.bootstrap.MasonryBrick",
+ "desc" : "masonry brick to add",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "addEvents",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "clearAll",
+ "type" : "function",
+ "desc" : "clear all the Masonry Brick",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "get",
+ "type" : "function",
+ "desc" : "fetch a Masonry Layout based on the masonry layout ID",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "string",
+ "desc" : "masonry layout to add",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "register",
+ "type" : "function",
+ "desc" : "register a Masonry Brick",
+ "sig" : "(the)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "Roo.bootstrap.MasonryBrick",
+ "desc" : "masonry brick to add",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "register",
+ "type" : "function",
+ "desc" : "register a Masonry Layout",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "Roo.bootstrap.LayoutMasonry",
+ "desc" : "masonry layout to add",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "releaseCapture",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "removeBrick",
+ "type" : "function",
+ "desc" : "remove a Masonry Brick",
+ "sig" : "(the)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "Roo.bootstrap.MasonryBrick",
+ "desc" : "masonry brick to remove",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "removeListener",
"type" : "function",
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.bootstrap.TabGroup"
- ],
+ "implementations" : [],
"tree_children" : [
- "Roo.bootstrap.Alert",
- "Roo.bootstrap.BezierSignature",
- "Roo.bootstrap.Brick",
- "Roo.bootstrap.Button",
- "Roo.bootstrap.ButtonGroup",
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.Calendar",
- "Roo.bootstrap.Card",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.DocumentManager",
- "Roo.bootstrap.DocumentSlider",
- "Roo.bootstrap.DocumentViewer",
- "Roo.bootstrap.DropTarget",
"Roo.bootstrap.Element",
- "Roo.bootstrap.Graph",
- "Roo.bootstrap.Header",
+ "Roo.bootstrap.DropTarget",
"Roo.bootstrap.Img",
- "Roo.bootstrap.LayoutMasonry",
- "Roo.bootstrap.LayoutMasonryAuto",
- "Roo.bootstrap.Link",
- "Roo.bootstrap.LocationPicker",
- "Roo.bootstrap.MasonryBrick",
- "Roo.bootstrap.MessageBar",
- "Roo.bootstrap.Pagination",
- "Roo.bootstrap.PaginationItem",
- "Roo.bootstrap.PagingToolbar",
- "Roo.bootstrap.Progress",
- "Roo.bootstrap.ProgressBar",
- "Roo.bootstrap.Row",
- "Roo.bootstrap.Slider",
- "Roo.bootstrap.TabGroup",
- "Roo.bootstrap.TabPanel",
- "Roo.bootstrap.Table",
- "Roo.bootstrap.UploadCropbox",
- "Roo.bootstrap.breadcrumb.Nav",
- "Roo.bootstrap.dash.NumberBox",
- "Roo.bootstrap.dash.TabBox",
- "Roo.bootstrap.dash.TabPane",
- "Roo.bootstrap.form.CardUploader",
- "Roo.bootstrap.form.CheckBox",
- "Roo.bootstrap.form.ComboBox",
- "Roo.bootstrap.form.DateField",
- "Roo.bootstrap.form.DateSplitField",
- "Roo.bootstrap.form.FieldLabel",
- "Roo.bootstrap.form.Form",
- "Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.Input",
- "Roo.bootstrap.form.Markdown",
- "Roo.bootstrap.form.MoneyField",
- "Roo.bootstrap.form.MonthField",
- "Roo.bootstrap.form.NumberField",
- "Roo.bootstrap.form.Password",
- "Roo.bootstrap.form.PhoneInput",
- "Roo.bootstrap.form.Radio",
- "Roo.bootstrap.form.RadioSet",
- "Roo.bootstrap.form.SecurePass",
- "Roo.bootstrap.form.TextArea",
- "Roo.bootstrap.form.TimeField",
- "Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.nav.Group",
- "Roo.bootstrap.nav.Headerbar",
- "Roo.bootstrap.nav.ProgressBar",
- "Roo.bootstrap.nav.ProgressBarItem",
- "Roo.bootstrap.nav.Sidebar",
- "Roo.bootstrap.nav.SidebarItem",
- "Roo.bootstrap.nav.Simplebar"
+ "Roo.bootstrap.MasonryBrick"
],
"tree_parent" : []
},
- "Roo.bootstrap.Component" : {
+ "Roo.bootstrap.LayoutMasonryAuto" : {
"props" : [
{
"name" : "actionMode",
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
"name" : "cls",
"type" : "String",
"desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "columnWidth",
+ "type" : "Number",
+ "desc" : "width of the columns",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
"visibility"
]
},
+ {
+ "name" : "isAutoInitial",
+ "type" : "Boolean",
+ "desc" : "defalut true",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "isFitWidth",
+ "type" : "Boolean",
+ "desc" : "- resize the width..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "isLayoutInstant",
+ "type" : "Boolean",
+ "desc" : "= no animation?",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "isOriginLeft",
+ "type" : "Boolean",
+ "desc" : "= left align?",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "isOriginTop",
+ "type" : "Boolean",
+ "desc" : "= top align?",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "isResizingContainer",
+ "type" : "Boolean",
+ "desc" : "= not sure if this is used..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "maxCols",
+ "type" : "Number",
+ "desc" : "maximum number of columns",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "padHeight",
+ "type" : "Number",
+ "desc" : "padding below box..",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
"name" : "visibilityEl",
"type" : "string|object",
"desc" : "t) What element to use for visibility (@see getVisibilityEl(",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : [
"el",
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
}
"type" : "function",
"desc" : "Fires when the children have been rendered..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
}
],
"methods" : [
+ {
+ "name" : "_getColGroup",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "(colSpan)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "colSpan",
+ "type" : "Number",
+ "desc" : "- number of columns the element spans",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "_postLayout",
+ "type" : "function",
+ "desc" : "Any logic you want to do after each layout,\ni.e. size the container",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "_processLayoutQueue",
+ "type" : "function",
+ "desc" : "Sets position of item in DOM",
+ "sig" : "(item, x, y, isInstant)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "item",
+ "type" : "Element",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "- horizontal position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "- vertical position",
+ "isOptional" : false
+ },
+ {
+ "name" : "isInstant",
+ "type" : "Boolean",
+ "desc" : "- disables transitions",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "addEvents",
"type" : "function",
"desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Get the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Hide a component - adds 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Initialize Events for the element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Set the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Show a component - removes 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Fetch the element to display the tooltip on.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
}
],
- "isAbstract" : true,
+ "isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.bootstrap.Alert",
- "Roo.bootstrap.BezierSignature",
- "Roo.bootstrap.Body",
- "Roo.bootstrap.Brick",
- "Roo.bootstrap.Button",
- "Roo.bootstrap.ButtonGroup",
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.Calendar",
- "Roo.bootstrap.Card",
- "Roo.bootstrap.CardFooter",
- "Roo.bootstrap.CardHeader",
- "Roo.bootstrap.CardImageTop",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.Container",
- "Roo.bootstrap.DocumentManager",
- "Roo.bootstrap.DocumentSlider",
- "Roo.bootstrap.DocumentViewer",
- "Roo.bootstrap.DropTarget",
- "Roo.bootstrap.Element",
- "Roo.bootstrap.Graph",
- "Roo.bootstrap.Header",
- "Roo.bootstrap.Img",
- "Roo.bootstrap.LayoutMasonry",
- "Roo.bootstrap.LayoutMasonryAuto",
- "Roo.bootstrap.Link",
- "Roo.bootstrap.LocationPicker",
- "Roo.bootstrap.MasonryBrick",
- "Roo.bootstrap.MessageBar",
- "Roo.bootstrap.Modal",
- "Roo.bootstrap.Pagination",
- "Roo.bootstrap.PaginationItem",
- "Roo.bootstrap.PagingToolbar",
- "Roo.bootstrap.Popover",
- "Roo.bootstrap.PopoverNav",
- "Roo.bootstrap.Progress",
- "Roo.bootstrap.ProgressBar",
- "Roo.bootstrap.Row",
- "Roo.bootstrap.Slider",
- "Roo.bootstrap.TabGroup",
- "Roo.bootstrap.TabPanel",
- "Roo.bootstrap.Table",
- "Roo.bootstrap.TableBody",
- "Roo.bootstrap.TableCell",
- "Roo.bootstrap.TableRow",
- "Roo.bootstrap.UploadCropbox",
- "Roo.bootstrap.breadcrumb.Item",
- "Roo.bootstrap.breadcrumb.Nav",
- "Roo.bootstrap.dash.NumberBox",
- "Roo.bootstrap.dash.TabBox",
- "Roo.bootstrap.dash.TabPane",
- "Roo.bootstrap.form.CardUploader",
- "Roo.bootstrap.form.CheckBox",
- "Roo.bootstrap.form.ComboBox",
- "Roo.bootstrap.form.DateField",
- "Roo.bootstrap.form.DateSplitField",
- "Roo.bootstrap.form.FieldLabel",
- "Roo.bootstrap.form.Form",
- "Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.HtmlEditorToolbar.Standard",
- "Roo.bootstrap.form.Input",
- "Roo.bootstrap.form.Markdown",
- "Roo.bootstrap.form.MoneyField",
- "Roo.bootstrap.form.MonthField",
- "Roo.bootstrap.form.NumberField",
- "Roo.bootstrap.form.Password",
- "Roo.bootstrap.form.PhoneInput",
- "Roo.bootstrap.form.Radio",
- "Roo.bootstrap.form.RadioSet",
- "Roo.bootstrap.form.SecurePass",
- "Roo.bootstrap.form.TextArea",
- "Roo.bootstrap.form.TimeField",
- "Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.layout.Border",
- "Roo.bootstrap.layout.Manager",
- "Roo.bootstrap.menu.Item",
- "Roo.bootstrap.menu.Menu",
- "Roo.bootstrap.menu.Separator",
- "Roo.bootstrap.nav.Bar",
- "Roo.bootstrap.nav.Group",
- "Roo.bootstrap.nav.Headerbar",
- "Roo.bootstrap.nav.Item",
- "Roo.bootstrap.nav.ProgressBar",
- "Roo.bootstrap.nav.ProgressBarItem",
- "Roo.bootstrap.nav.Sidebar",
- "Roo.bootstrap.nav.SidebarItem",
- "Roo.bootstrap.nav.Simplebar"
- ],
- "tree_children" : [
- "Roo.bootstrap.Alert",
- "Roo.bootstrap.BezierSignature",
- "Roo.bootstrap.Brick",
- "Roo.bootstrap.Button",
- "Roo.bootstrap.ButtonGroup",
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.Calendar",
- "Roo.bootstrap.Card",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.DocumentManager",
- "Roo.bootstrap.DocumentSlider",
- "Roo.bootstrap.DocumentViewer",
- "Roo.bootstrap.DropTarget",
- "Roo.bootstrap.Element",
- "Roo.bootstrap.Graph",
- "Roo.bootstrap.Header",
- "Roo.bootstrap.Img",
- "Roo.bootstrap.LayoutMasonry",
- "Roo.bootstrap.LayoutMasonryAuto",
- "Roo.bootstrap.Link",
- "Roo.bootstrap.LocationPicker",
- "Roo.bootstrap.MasonryBrick",
- "Roo.bootstrap.MessageBar",
- "Roo.bootstrap.Pagination",
- "Roo.bootstrap.PaginationItem",
- "Roo.bootstrap.PagingToolbar",
- "Roo.bootstrap.Progress",
- "Roo.bootstrap.ProgressBar",
- "Roo.bootstrap.Row",
- "Roo.bootstrap.Slider",
- "Roo.bootstrap.TabGroup",
- "Roo.bootstrap.TabPanel",
- "Roo.bootstrap.Table",
- "Roo.bootstrap.UploadCropbox",
- "Roo.bootstrap.breadcrumb.Nav",
- "Roo.bootstrap.dash.NumberBox",
- "Roo.bootstrap.dash.TabBox",
- "Roo.bootstrap.dash.TabPane",
- "Roo.bootstrap.form.CardUploader",
- "Roo.bootstrap.form.CheckBox",
- "Roo.bootstrap.form.ComboBox",
- "Roo.bootstrap.form.DateField",
- "Roo.bootstrap.form.DateSplitField",
- "Roo.bootstrap.form.FieldLabel",
- "Roo.bootstrap.form.Form",
- "Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.Input",
- "Roo.bootstrap.form.Markdown",
- "Roo.bootstrap.form.MoneyField",
- "Roo.bootstrap.form.MonthField",
- "Roo.bootstrap.form.NumberField",
- "Roo.bootstrap.form.Password",
- "Roo.bootstrap.form.PhoneInput",
- "Roo.bootstrap.form.Radio",
- "Roo.bootstrap.form.RadioSet",
- "Roo.bootstrap.form.SecurePass",
- "Roo.bootstrap.form.TextArea",
- "Roo.bootstrap.form.TimeField",
- "Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.nav.Group",
- "Roo.bootstrap.nav.Headerbar",
- "Roo.bootstrap.nav.ProgressBar",
- "Roo.bootstrap.nav.ProgressBarItem",
- "Roo.bootstrap.nav.Sidebar",
- "Roo.bootstrap.nav.SidebarItem",
- "Roo.bootstrap.nav.Simplebar"
- ],
+ "implementations" : [],
+ "tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.Container" : {
+ "Roo.bootstrap.Link" : {
"props" : [
{
"name" : "actionMode",
"optvals" : []
},
{
- "name" : "alert",
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "alt",
"type" : "String",
- "desc" : "r) type alert (changes background / border..",
+ "desc" : "image alternative text",
"memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "success",
- "info",
- "warning",
- "danger"
- ]
+ "optvals" : []
},
{
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
+ "name" : "anchor",
+ "type" : "String",
+ "desc" : "name for the anchor link",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "clickable",
- "type" : "Boolean",
- "desc" : "e) default fal",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
{
"name" : "cls",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "expandable",
- "type" : "Boolean",
- "desc" : "e) default fal",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "expanded",
- "type" : "Boolean",
- "desc" : "e) default tr",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
{
"name" : "fa",
"type" : "String",
- "desc" : "font awesome icon",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "footer",
- "type" : "String",
- "desc" : "content of footer (for panel)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "header",
- "type" : "String",
- "desc" : "content of header (for panel)",
+ "desc" : "- favicon",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "e) hide the eleme",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
{
"name" : "hideMode",
"type" : "String",
]
},
{
- "name" : "html",
+ "name" : "href",
"type" : "String",
- "desc" : "content of element",
+ "desc" : "a tag href",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "icon",
+ "name" : "html",
"type" : "String",
- "desc" : ".) glyphicon na",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "info-sign",
- "check",
- "..."
- ]
- },
- {
- "name" : "jumbotron",
- "type" : "Boolean",
- "desc" : "is it a jumbotron element",
+ "desc" : "the content of the link.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"optvals" : []
},
{
- "name" : "panel",
- "type" : "String",
- "desc" : "r) render as panel - type - primary/success...",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "default",
- "primary",
- "success",
- "info",
- "warning",
- "danger"
- ]
- },
- {
- "name" : "rheader",
- "type" : "String",
- "desc" : "contet on the right of header",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "sticky",
- "type" : "String",
- "desc" : "h) block to use as footer or body- needs css-bootstrap/sticky-footer.c",
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
"memberOf" : "",
"isOptional" : false,
"optvals" : [
- "footer",
- "wrap",
- "push"
+ "true",
+ "false"
]
},
{
"optvals" : []
},
{
- "name" : "tag",
+ "name" : "target",
"type" : "String",
- "desc" : "n) type of HTML ta",
+ "desc" : "p) target for a hre",
"memberOf" : "",
"isOptional" : false,
"optvals" : [
- "header",
- "aside",
- "section"
+ "_self",
+ "_blank",
+ "_parent",
+ "_top"
]
},
{
"parent"
]
},
- {
- "name" : "well",
- "type" : "String",
- "desc" : "d) a well, large, small or mediu",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "lg",
- "sm",
- "md"
- ]
- },
{
"name" : "xattr",
"type" : "Object",
{
"name" : "click",
"type" : "function",
- "desc" : "When a element is chick",
- "sig" : "function (_self, e)\n{\n\n}",
+ "desc" : "The img click event for the img.",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Container",
- "desc" : "",
- "isOptional" : false
- },
{
"name" : "e",
"type" : "Roo.EventObject",
],
"returns" : []
},
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "After the panel has been collapsed",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Container",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "After the panel has been expand",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Container",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
"Roo.bootstrap.nav.SidebarItem",
"Roo.bootstrap.nav.Simplebar"
],
- "tree_parent" : [
- "builder"
- ]
+ "tree_parent" : []
},
- "Roo.bootstrap.DocumentManager" : {
+ "Roo.bootstrap.LocationPicker" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "boxes",
- "type" : "Number",
- "desc" : "number of boxes, 0 is no limit.. default 0",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"optvals" : []
},
{
- "name" : "editable",
+ "name" : "disableDoubleClickZoom",
"type" : "Boolean",
- "desc" : "e) allow edit when upload a image default tr",
+ "desc" : "default false",
"memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
+ "optvals" : []
},
{
- "name" : "fieldLabel",
- "type" : "String",
- "desc" : "",
+ "name" : "draggable",
+ "type" : "Boolean",
+ "desc" : "default true",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableAutocomplete",
+ "type" : "Boolean",
+ "desc" : "default false",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableReverseGeocode",
+ "type" : "Boolean",
+ "desc" : "default true",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
]
},
{
- "name" : "labelAlign",
- "type" : "String",
- "desc" : "p) default le",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "left",
- "top"
- ]
- },
- {
- "name" : "labelWidth",
+ "name" : "latitude",
"type" : "Number",
- "desc" : "default 4",
+ "desc" : "Position when init default 0",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
+ "name" : "locationName",
+ "type" : "String",
+ "desc" : "",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "labelsm",
+ "name" : "longitude",
"type" : "Number",
- "desc" : "set the width of label (1-12)",
+ "desc" : "Position when init default 0",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
+ "name" : "mapTypeControl",
+ "type" : "Boolean",
+ "desc" : "default false",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "method",
+ "name" : "mapTypeId",
"type" : "String",
- "desc" : "default POST",
+ "desc" : "default google.maps.MapTypeId.ROADMAP",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "multiple",
- "type" : "Boolean",
- "desc" : "multiple upload default true",
+ "name" : "markerTitle",
+ "type" : "String",
+ "desc" : "",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"optvals" : []
},
{
- "name" : "paramName",
- "type" : "String",
- "desc" : "default 'imageUpload'",
+ "name" : "radius",
+ "type" : "Number",
+ "desc" : "default 0",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "scrollwheel",
+ "type" : "Boolean",
+ "desc" : "default true",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "thumbSize",
- "type" : "Number",
- "desc" : "default 300",
+ "name" : "streetViewControl",
+ "type" : "Boolean",
+ "desc" : "default false",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "toolTipName",
+ "name" : "style",
"type" : "String",
- "desc" : "default 'filename'",
- "memberOf" : "",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "url",
- "type" : "String",
- "desc" : "action url",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "visibilityEl",
"type" : "string|object",
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
+ },
+ {
+ "name" : "zoom",
+ "type" : "Number",
+ "desc" : "default 15",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
- "name" : "afterupload",
+ "name" : "OverlayViewDraw",
"type" : "function",
- "desc" : "Fire when xhr load exception",
- "sig" : "function (_self, xhr)\n{\n\n}",
+ "desc" : "Fires when OverlayView Draw",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.DocumentManager",
+ "type" : "Roo.bootstrap.LocationPicker",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "OverlayViewHide",
+ "type" : "function",
+ "desc" : "Fires when OverlayView Draw",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.LocationPicker",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "OverlayViewOnAdd",
+ "type" : "function",
+ "desc" : "Fires when OverlayView Draw",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.LocationPicker",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "OverlayViewOnRemove",
+ "type" : "function",
+ "desc" : "Fires when OverlayView Draw",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.LocationPicker",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "OverlayViewShow",
+ "type" : "function",
+ "desc" : "Fires when OverlayView Draw",
+ "sig" : "function (_self, cpx)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.LocationPicker",
"desc" : "",
"isOptional" : false
},
{
- "name" : "xhr",
- "type" : "XMLHttpRequest",
+ "name" : "cpx",
+ "type" : "Pixel",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "beforeselectfile",
- "type" : "function",
- "desc" : "Fire before select file",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DocumentManager",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforeshow",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "Fire after click the image",
- "sig" : "function (_self, file)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DocumentManager",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "file",
- "type" : "Object",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "edit",
- "type" : "function",
- "desc" : "Fire when upload a image and editable set to true",
- "sig" : "function (_self, file)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DocumentManager",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "file",
- "type" : "Object",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
"returns" : []
},
{
- "name" : "exception",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fire when xhr load exception",
- "sig" : "function (_self, xhr)\n{\n\n}",
+ "desc" : "Fires when the map hide.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.DocumentManager",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "xhr",
- "type" : "XMLHttpRequest",
+ "type" : "Roo.bootstrap.LocationPicker",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "hide",
+ "name" : "initial",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when the picker initialized.",
+ "sig" : "function (_self, location)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.LocationPicker",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "location",
+ "type" : "Google Location",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "initial",
+ "name" : "loadexception",
"type" : "function",
- "desc" : "Fire when initial the DocumentManager",
+ "desc" : "Fires when load google lib failed.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.DocumentManager",
+ "type" : "Roo.bootstrap.LocationPicker",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "inspect",
+ "name" : "mapClick",
"type" : "function",
- "desc" : "inspect selected file",
- "sig" : "function (_self, file)\n{\n\n}",
+ "desc" : "Fires when click the map.",
+ "sig" : "function (_self, e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.DocumentManager",
+ "type" : "Roo.bootstrap.LocationPicker",
"desc" : "",
"isOptional" : false
},
{
- "name" : "file",
- "type" : "File",
+ "name" : "e",
+ "type" : "Map event",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "prepare",
+ "name" : "mapRightClick",
"type" : "function",
- "desc" : "prepare the form data",
- "sig" : "function (_self, formData)\n{\n\n}",
+ "desc" : "Fires when right click the map.",
+ "sig" : "function (_self, e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.DocumentManager",
+ "type" : "Roo.bootstrap.LocationPicker",
"desc" : "",
"isOptional" : false
},
{
- "name" : "formData",
- "type" : "Object",
+ "name" : "e",
+ "type" : "Map event",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "previewrendered",
+ "name" : "markerClick",
"type" : "function",
- "desc" : "Fire when preview rendered",
- "sig" : "function (_self, file)\n{\n\n}",
+ "desc" : "Fires when click the marker.",
+ "sig" : "function (_self, e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.DocumentManager",
+ "type" : "Roo.bootstrap.LocationPicker",
"desc" : "",
"isOptional" : false
},
{
- "name" : "file",
- "type" : "Object",
+ "name" : "e",
+ "type" : "Map event",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "process",
+ "name" : "markerRightClick",
"type" : "function",
- "desc" : "Fire before process file",
- "sig" : "function (_self, file)\n{\n\n}",
+ "desc" : "Fires when right click the marker.",
+ "sig" : "function (_self, e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.DocumentManager",
+ "type" : "Roo.bootstrap.LocationPicker",
"desc" : "",
"isOptional" : false
},
{
- "name" : "file",
- "type" : "Object",
+ "name" : "e",
+ "type" : "Map event",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "refresh",
+ "name" : "positionchanged",
"type" : "function",
- "desc" : "Fire after refresh the file",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Fires when the picker position changed.",
+ "sig" : "function (_self, location)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.DocumentManager",
+ "type" : "Roo.bootstrap.LocationPicker",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "location",
+ "type" : "Google Location",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "remove",
+ "name" : "render",
"type" : "function",
- "desc" : "Fire when remove the file",
- "sig" : "function (_self, file)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.DocumentManager",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "file",
- "type" : "Object",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "render",
+ "name" : "resize",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
+ "desc" : "Fires when the map resize.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.LocationPicker",
"desc" : "",
"isOptional" : false
}
{
"name" : "show",
"type" : "function",
- "desc" : "Fires after the component is shown.",
+ "desc" : "Fires when the map show.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.LocationPicker",
"desc" : "",
"isOptional" : false
}
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.DocumentSlider" : {
+ "Roo.bootstrap.MasonryBrick" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "bgimage",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"visibility"
]
},
+ {
+ "name" : "href",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "defalut false",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "isFitContainer",
+ "type" : "Boolean",
+ "desc" : "defalut true",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "placetitle",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "center",
+ "bottom"
+ ]
+ },
+ {
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "defalut false",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "size",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "xs",
+ "sm",
+ "md",
+ "md-left",
+ "md-right",
+ "tall",
+ "wide"
+ ]
+ },
{
"name" : "style",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tooltip",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "videourl",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
{
"name" : "click",
"type" : "function",
- "desc" : "Fire after click",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "When a MasonryBrick is clcik",
+ "sig" : "function (_self, e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.DocumentSlider",
+ "type" : "Roo.bootstrap.MasonryBrick",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "initial",
- "type" : "function",
- "desc" : "Fire after initEvent",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DocumentSlider",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "update",
- "type" : "function",
- "desc" : "Fire after update",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DocumentSlider",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"methods" : [
}
]
},
+ {
+ "name" : "get",
+ "type" : "function",
+ "desc" : "fetch a masonry brick based on the masonry brick ID",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "string",
+ "desc" : "masonry brick to add",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "register",
+ "type" : "function",
+ "desc" : "register a Masonry Brick",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "Roo.bootstrap.MasonryBrick",
+ "desc" : "masonry brick to add",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "releaseCapture",
"type" : "function",
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.DocumentViewer" : {
+ "Roo.bootstrap.MessageBar" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "beforeClass",
+ "type" : "String",
+ "desc" : "insert the bar before the given class",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "closable",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "cls",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "fixed",
+ "type" : "Boolean",
+ "desc" : "e) default false, fix the bar at the t",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "hideMode",
"type" : "String",
"visibility"
]
},
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "contents of the MessageBar",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "showDownload",
- "type" : "Boolean",
- "desc" : "e) show download button (default tru",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "showTrash",
- "type" : "Boolean",
- "desc" : "e) show trash button (default tru",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
{
"name" : "style",
"type" : "String",
"parent"
]
},
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "r) default in",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "info",
+ "success",
+ "warning",
+ "danger"
+ ]
+ },
{
"name" : "xattr",
"type" : "Object",
],
"returns" : []
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "Fire after click",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DocumentViewer",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "download",
- "type" : "function",
- "desc" : "Fire after download button",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DocumentViewer",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "initial",
- "type" : "function",
- "desc" : "Fire after initEvent",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DocumentViewer",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "trash",
- "type" : "function",
- "desc" : "Fire after trash button",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DocumentViewer",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"methods" : [
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.DropTarget" : {
+ "Roo.bootstrap.MessageBox" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "alert",
+ "type" : "function",
+ "desc" : "Displays a standard read-only message box with an OK button (comparable to the basic JavaScript Window.alert).\nIf a callback function is passed it will be called after the user clicks the button, and the\nid of the button that was clicked will be passed as the only parameter to the callback\n(could also be the top-right close button).",
+ "sig" : "(title, msg, fn, scope)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title bar text",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The message box body text",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "(optional) The callback function invoked after the message box is closed",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the callback function",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
+ },
+ {
+ "name" : "confirm",
+ "type" : "function",
+ "desc" : "Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's Window.confirm).\nIf a callback function is passed it will be called after the user clicks either button, and the id of the\nbutton that was clicked will be passed as the only parameter to the callback (could also be the top-right close button).",
+ "sig" : "(title, msg, fn, scope)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title bar text",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The message box body text",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "(optional) The callback function invoked after the message box is closed",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the callback function",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
+ },
+ {
+ "name" : "getDialog",
+ "type" : "function",
+ "desc" : "Returns a reference to the underlying {@link Roo.BasicDialog} element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.BasicDialog",
+ "desc" : "The BasicDialog element"
+ }
+ ]
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Hides the message box if it is displayed",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if the message box is currently displayed",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the message box is visible, else false"
+ }
+ ]
+ },
+ {
+ "name" : "progress",
+ "type" : "function",
+ "desc" : "Displays a message box with a progress bar. This message box has no buttons and is not closeable by\nthe user. You are responsible for updating the progress bar as needed via {@link Roo.MessageBox#updateProgress}\nand closing the message box when the process is complete.",
+ "sig" : "(title, msg)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title bar text",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The message box body text",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
+ },
+ {
+ "name" : "prompt",
+ "type" : "function",
+ "desc" : "Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to\nJavaScript's Window.prompt). The prompt can be a single-line or multi-line textbox. If a callback function\nis passed it will be called after the user clicks either button, and the id of the button that was clicked\n(could also be the top-right close button) and the text that was entered will be passed as the two\nparameters to the callback.",
+ "sig" : "(title, msg, fn, scope, multiline)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title bar text",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The message box body text",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "(optional) The callback function invoked after the message box is closed",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the callback function",
+ "isOptional" : false
+ },
+ {
+ "name" : "multiline",
+ "type" : "Boolean/Number",
+ "desc" : "(optional) True to create a multiline textbox using the defaultTextHeight\nproperty, or the height in pixels to create the textbox (defaults to false / single-line)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Displays a new message box, or reinitializes an existing message box, based on the config options\npassed in. All functions (e.g. prompt, alert, etc) on MessageBox call this function internally.\nThe following config object properties are supported:\n<pre>\nProperty Type Description\n---------- --------------- ------------------------------------------------------------------------------------\nanimEl String/Element An id or Element from which the message box should animate as it opens and\n closes (defaults to undefined)\nbuttons Object/Boolean A button config object (e.g., Roo.MessageBox.OKCANCEL or {ok:'Foo',\n cancel:'Bar'}), or false to not show any buttons (defaults to false)\nclosable Boolean False to hide the top-right close button (defaults to true). Note that\n progress and wait dialogs will ignore this property and always hide the\n close button as they can only be closed programmatically.\ncls String A custom CSS class to apply to the message box element\ndefaultTextHeight Number The default height in pixels of the message box's multiline textarea if\n displayed (defaults to 75)\nfn Function A callback function to execute after closing the dialog. The arguments to the\n function will be btn (the name of the button that was clicked, if applicable,\n e.g. \"ok\"), and text (the value of the active text field, if applicable).\n Progress and wait dialogs will ignore this option since they do not respond to\n user actions and can only be closed programmatically, so any required function\n should be called by the same code after it closes the dialog.\nicon String A CSS class that provides a background image to be used as an icon for\n the dialog (e.g., Roo.MessageBox.WARNING or 'custom-class', defaults to '')\nmaxWidth Number The maximum width in pixels of the message box (defaults to 600)\nminWidth Number The minimum width in pixels of the message box (defaults to 100)\nmodal Boolean False to allow user interaction with the page while the message box is\n displayed (defaults to true)\nmsg String A string that will replace the existing message box body text (defaults\n to the XHTML-compliant non-breaking space character ' ')\nmultiline Boolean True to prompt the user to enter multi-line text (defaults to false)\nprogress Boolean True to display a progress bar (defaults to false)\nprogressText String The text to display inside the progress bar if progress = true (defaults to '')\nprompt Boolean True to prompt the user to enter single-line text (defaults to false)\nproxyDrag Boolean True to display a lightweight proxy while dragging (defaults to false)\ntitle String The title text\nvalue String The string value to set into the active textbox element if displayed\nwait Boolean True to display a progress bar (defaults to false)\nwidth Number The width of the dialog in pixels\n</pre>\n\nExample usage:\n<pre><code>\nRoo.Msg.show({\n title: 'Address',\n msg: 'Please enter your address:',\n width: 300,\n buttons: Roo.MessageBox.OKCANCEL,\n multiline: true,\n fn: saveAddress,\n animEl: 'addAddressBtn'\n});\n</code></pre>",
+ "sig" : "(config)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
+ },
+ {
+ "name" : "updateProgress",
+ "type" : "function",
+ "desc" : "Updates a progress-style message box's text and progress bar. Only relevant on message boxes\ninitiated via {@link Roo.MessageBox#progress} or by calling {@link Roo.MessageBox#show} with progress: true.",
+ "sig" : "(value, text)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Number",
+ "desc" : "Any number between 0 and 1 (e.g., .5)",
+ "isOptional" : false
+ },
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "(optional) If defined, the message box's body text is replaced with the specified string (defaults to undefined)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
+ },
+ {
+ "name" : "updateText",
+ "type" : "function",
+ "desc" : "Updates the message box body text",
+ "sig" : "(text)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "(optional) Replaces the message box element's innerHTML with the specified string (defaults to\nthe XHTML-compliant non-breaking space character '&#160;')",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
+ },
+ {
+ "name" : "wait",
+ "type" : "function",
+ "desc" : "Displays a message box with an infinitely auto-updating progress bar. This can be used to block user\ninteraction while waiting for a long-running process to complete that does not have defined intervals.\nYou are responsible for closing the message box when the process is complete.",
+ "sig" : "(msg, title)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The message box body text",
+ "isOptional" : false
+ },
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "(optional) The title bar text",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.Modal" : {
"props" : [
{
"name" : "actionMode",
"optvals" : []
},
{
- "name" : "can_build_overlaid",
+ "name" : "allow_close",
"type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "default true",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "clickable",
+ "name" : "animate",
"type" : "Boolean",
- "desc" : "e) default fal",
- "memberOf" : "Roo.bootstrap.Element",
+ "desc" : "default true",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "bodyOverflow",
+ "type" : "Boolean",
+ "desc" : "should the body element have overflow auto added default false",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "buttonPosition",
+ "type" : "String",
+ "desc" : "r) default right (DEPRICATED) - use mr-auto on buttons to put them on the le",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : [
- "true",
- "false"
+ "left",
+ "right",
+ "center"
]
},
+ {
+ "name" : "buttons[]",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "Array of buttons or standard button set..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "cls",
"type" : "String",
- "desc" : "class of the element",
- "memberOf" : "Roo.bootstrap.Element",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "editableTitle",
+ "type" : "Boolean",
+ "desc" : "can the title be edited",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fitwindow",
+ "type" : "Boolean",
+ "desc" : "default false",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "fixed height - usefull for chrome extension only really.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "hideMode",
"type" : "String",
{
"name" : "html",
"type" : "String",
- "desc" : "contents of the element",
- "memberOf" : "Roo.bootstrap.Element",
+ "desc" : "- the body of the dialog (for simple ones) - you can also use template..",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "max_width",
+ "type" : "Number",
+ "desc" : "set the max width of modal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "name",
"type" : "string",
- "desc" : "dropable name",
- "memberOf" : "",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "e) default fal",
- "memberOf" : "Roo.bootstrap.Element",
+ "name" : "size",
+ "type" : "String",
+ "desc" : "l) default emp",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : [
- "true",
- "false"
+ "sm",
+ "lg",
+ "xl"
]
},
{
- "name" : "role",
- "type" : "String",
- "desc" : "default blank - set to button to force cursor pointer",
- "memberOf" : "Roo.bootstrap.Element",
+ "name" : "specificTitle",
+ "type" : "Boolean",
+ "desc" : "default false",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "tag",
+ "name" : "title",
"type" : "String",
- "desc" : "tag of the element",
- "memberOf" : "Roo.bootstrap.Element",
+ "desc" : "Title of dialog",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tmpl",
+ "type" : "Roo.Template",
+ "desc" : "- a template with variables. to use it, add a handler in show:method adn",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"parent"
]
},
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "fixed width - usefull for chrome extension only really.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "xattr",
"type" : "Object",
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "btnclick",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "The raw btnclick event for the button",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "click",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "When a element is chick",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "resize",
+ "type" : "function",
+ "desc" : "Fire when dialog resize",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Modal",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "titlechanged",
+ "type" : "function",
+ "desc" : "Fire when the editable title has been changed",
+ "sig" : "function (_self, value)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Modal",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
],
"returns" : []
},
+ {
+ "name" : "applyBody",
+ "type" : "function",
+ "desc" : "Set the body of the Dialog using the template",
+ "sig" : "(data)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "data",
+ "type" : "Obj",
+ "desc" : "- apply this data to the template and replace the body contents.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setBody",
+ "type" : "function",
+ "desc" : "Set the body of the Dialog",
+ "sig" : "(str)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "str",
+ "type" : "String",
+ "desc" : "new Title",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setTitle",
+ "type" : "function",
+ "desc" : "Set the title of the Dialog",
+ "sig" : "(str)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "str",
+ "type" : "String",
+ "desc" : "new Title",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.layout.Border",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : [
+ "none",
+ "builder"
+ ]
},
- "Roo.bootstrap.Element" : {
+ "Roo.bootstrap.Pagination" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "clickable",
- "type" : "Boolean",
- "desc" : "e) default fal",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
{
"name" : "cls",
"type" : "String",
- "desc" : "class of the element",
- "memberOf" : "",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
]
},
{
- "name" : "html",
- "type" : "String",
- "desc" : "contents of the element",
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"optvals" : []
},
{
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "e) default fal",
+ "name" : "size",
+ "type" : "String",
+ "desc" : "",
"memberOf" : "",
"isOptional" : false,
"optvals" : [
- "true",
- "false"
+ "xs",
+ "sm",
+ "md",
+ "lg",
+ "xl"
]
},
- {
- "name" : "role",
- "type" : "String",
- "desc" : "default blank - set to button to force cursor pointer",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "style",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "tag",
- "type" : "String",
- "desc" : "tag of the element",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "tooltip",
"type" : "string",
],
"returns" : []
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "When a element is chick",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.bootstrap.CardFooter",
- "Roo.bootstrap.CardHeader",
- "Roo.bootstrap.CardImageTop",
- "Roo.bootstrap.DropTarget"
- ],
+ "implementations" : [],
"tree_children" : [
- "Roo.bootstrap.Alert",
- "Roo.bootstrap.BezierSignature",
- "Roo.bootstrap.Brick",
- "Roo.bootstrap.Button",
- "Roo.bootstrap.ButtonGroup",
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.Calendar",
- "Roo.bootstrap.Card",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.DocumentManager",
- "Roo.bootstrap.DocumentSlider",
- "Roo.bootstrap.DocumentViewer",
- "Roo.bootstrap.DropTarget",
- "Roo.bootstrap.Element",
- "Roo.bootstrap.Graph",
- "Roo.bootstrap.Header",
- "Roo.bootstrap.Img",
- "Roo.bootstrap.LayoutMasonry",
- "Roo.bootstrap.LayoutMasonryAuto",
- "Roo.bootstrap.Link",
- "Roo.bootstrap.LocationPicker",
- "Roo.bootstrap.MasonryBrick",
- "Roo.bootstrap.MessageBar",
- "Roo.bootstrap.Pagination",
- "Roo.bootstrap.PaginationItem",
- "Roo.bootstrap.PagingToolbar",
- "Roo.bootstrap.Progress",
- "Roo.bootstrap.ProgressBar",
- "Roo.bootstrap.Row",
- "Roo.bootstrap.Slider",
- "Roo.bootstrap.TabGroup",
- "Roo.bootstrap.TabPanel",
- "Roo.bootstrap.Table",
- "Roo.bootstrap.UploadCropbox",
- "Roo.bootstrap.breadcrumb.Nav",
- "Roo.bootstrap.dash.NumberBox",
- "Roo.bootstrap.dash.TabBox",
- "Roo.bootstrap.dash.TabPane",
- "Roo.bootstrap.form.CardUploader",
- "Roo.bootstrap.form.CheckBox",
- "Roo.bootstrap.form.ComboBox",
- "Roo.bootstrap.form.DateField",
- "Roo.bootstrap.form.DateSplitField",
- "Roo.bootstrap.form.FieldLabel",
- "Roo.bootstrap.form.Form",
- "Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.Input",
- "Roo.bootstrap.form.Markdown",
- "Roo.bootstrap.form.MoneyField",
- "Roo.bootstrap.form.MonthField",
- "Roo.bootstrap.form.NumberField",
- "Roo.bootstrap.form.Password",
- "Roo.bootstrap.form.PhoneInput",
- "Roo.bootstrap.form.Radio",
- "Roo.bootstrap.form.RadioSet",
- "Roo.bootstrap.form.SecurePass",
- "Roo.bootstrap.form.TextArea",
- "Roo.bootstrap.form.TimeField",
- "Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.nav.Group",
- "Roo.bootstrap.nav.Headerbar",
- "Roo.bootstrap.nav.ProgressBar",
- "Roo.bootstrap.nav.ProgressBarItem",
- "Roo.bootstrap.nav.Sidebar",
- "Roo.bootstrap.nav.SidebarItem",
- "Roo.bootstrap.nav.Simplebar"
+ "Roo.bootstrap.Pagination"
],
"tree_parent" : []
},
- "Roo.bootstrap.Graph" : {
+ "Roo.bootstrap.PaginationItem" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "active",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"optvals" : []
},
{
- "name" : "g_height",
- "type" : "number",
- "desc" : "height of the chart (respected by all elements in the set)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "g_r",
- "type" : "number",
- "desc" : "radius (pie)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "g_width",
- "type" : "number",
- "desc" : "width of the chart (respected by all elements in the set)",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "default false",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "g_x",
- "type" : "number",
- "desc" : "coodinator | centre x (pie)",
- "memberOf" : "",
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "g_y",
- "type" : "number",
- "desc" : "coodinator | centre y (pie)",
+ "name" : "href",
+ "type" : "String",
+ "desc" : "the link",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "graphtype",
+ "name" : "html",
"type" : "String",
- "desc" : "bar | vbar | pie",
+ "desc" : "text",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
- },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "e) default tr",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "style",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "title",
- "type" : "Object",
- "desc" : "The title of the chart\n \n -{Array} values\n -opts (object) options for the chart \n o {\n o type (string) type of endings of the bar. Default: 'square'. Other options are: 'round', 'sharp', 'soft'.\n o gutter (number)(string) default '20%' (WHAT DOES IT DO?)\n o vgutter (number)\n o colors (array) colors be used repeatedly to plot the bars. If multicolumn bar is used each sequence of bars with use a different color.\n o stacked (boolean) whether or not to tread values as in a stacked bar chart\n o to\n o stretch (boolean)\n o }\n -opts (object) options for the pie\n o{\n o cut\n o startAngle (number)\n o endAngle (number)\n }",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "tooltip",
"type" : "string",
{
"name" : "click",
"type" : "function",
- "desc" : "The img click event for the img.",
+ "desc" : "The raw click event for the entire grid.",
"sig" : "function (e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.Header" : {
+ "Roo.bootstrap.PagingToolbar" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) alignme",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "arrangement",
+ "type" : "Boolean",
+ "desc" : "stacked | justified",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "buttons[]",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "Buttons for the toolbar",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "container The id or element that will contain the toolbar",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "container_method",
"type" : "string",
"optvals" : []
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
+ "name" : "displayInfo",
+ "type" : "Boolean",
+ "desc" : "True to display the displayMsg (defaults to false)",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
+ "optvals" : []
},
{
- "name" : "html",
+ "name" : "displayMsg",
"type" : "String",
- "desc" : "content of header",
+ "desc" : "The paging status message to display (defaults to \"Displaying {start} - {end} of {total}\")",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "level",
- "type" : "Number",
- "desc" : "6) default",
+ "name" : "emptyMsg",
+ "type" : "String",
+ "desc" : "The message to display when no records are found (defaults to \"No data to display\")",
"memberOf" : "",
"isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
"optvals" : [
- "1",
- "2",
- "3",
- "4",
- "5",
- "6"
+ "display",
+ "visibility"
]
},
+ {
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "is inverted color",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "e) loadMask on the b",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "main",
+ "type" : "Boolean",
+ "desc" : "e) main nav bar? default fal",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "name",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "pageSize",
+ "type" : "Number",
+ "desc" : "The number of records to display per page (defaults to 20)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The underlying data store providing the paged data",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "style",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "v) default is n",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "header",
+ "footer",
+ "nav",
+ "div"
+ ]
+ },
{
"name" : "tooltip",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "type",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "nav",
+ "pills",
+ "tabs"
+ ]
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"parent"
]
},
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "e) default is ligh",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "light",
+ "primary",
+ "secondary",
+ "success",
+ "danger",
+ "warning",
+ "info",
+ "dark",
+ "white"
+ ]
+ },
{
"name" : "xattr",
"type" : "Object",
],
"returns" : []
},
+ {
+ "name" : "beforetoggle",
+ "type" : "function",
+ "desc" : "Fire before toggle the menu",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "bind",
+ "type" : "function",
+ "desc" : "Binds the paging toolbar to the specified {@link Roo.data.Store}",
+ "sig" : "(store)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to bind",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Collapse the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expand the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "unbind",
+ "type" : "function",
+ "desc" : "Unbinds the paging toolbar from the specified {@link Roo.data.Store}",
+ "sig" : "(store)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to unbind",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.Alert",
- "Roo.bootstrap.BezierSignature",
- "Roo.bootstrap.Brick",
- "Roo.bootstrap.Button",
- "Roo.bootstrap.ButtonGroup",
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.Calendar",
- "Roo.bootstrap.Card",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.DocumentManager",
- "Roo.bootstrap.DocumentSlider",
- "Roo.bootstrap.DocumentViewer",
- "Roo.bootstrap.DropTarget",
- "Roo.bootstrap.Element",
- "Roo.bootstrap.Graph",
- "Roo.bootstrap.Header",
- "Roo.bootstrap.Img",
- "Roo.bootstrap.LayoutMasonry",
- "Roo.bootstrap.LayoutMasonryAuto",
- "Roo.bootstrap.Link",
- "Roo.bootstrap.LocationPicker",
- "Roo.bootstrap.MasonryBrick",
- "Roo.bootstrap.MessageBar",
- "Roo.bootstrap.Pagination",
- "Roo.bootstrap.PaginationItem",
- "Roo.bootstrap.PagingToolbar",
- "Roo.bootstrap.Progress",
- "Roo.bootstrap.ProgressBar",
- "Roo.bootstrap.Row",
- "Roo.bootstrap.Slider",
- "Roo.bootstrap.TabGroup",
- "Roo.bootstrap.TabPanel",
- "Roo.bootstrap.Table",
- "Roo.bootstrap.UploadCropbox",
- "Roo.bootstrap.breadcrumb.Nav",
- "Roo.bootstrap.dash.NumberBox",
- "Roo.bootstrap.dash.TabBox",
- "Roo.bootstrap.dash.TabPane",
- "Roo.bootstrap.form.CardUploader",
- "Roo.bootstrap.form.CheckBox",
- "Roo.bootstrap.form.ComboBox",
- "Roo.bootstrap.form.DateField",
- "Roo.bootstrap.form.DateSplitField",
- "Roo.bootstrap.form.FieldLabel",
- "Roo.bootstrap.form.Form",
- "Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.Input",
- "Roo.bootstrap.form.Markdown",
- "Roo.bootstrap.form.MoneyField",
- "Roo.bootstrap.form.MonthField",
- "Roo.bootstrap.form.NumberField",
- "Roo.bootstrap.form.Password",
- "Roo.bootstrap.form.PhoneInput",
- "Roo.bootstrap.form.Radio",
- "Roo.bootstrap.form.RadioSet",
- "Roo.bootstrap.form.SecurePass",
- "Roo.bootstrap.form.TextArea",
- "Roo.bootstrap.form.TimeField",
- "Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.nav.Group",
- "Roo.bootstrap.nav.Headerbar",
- "Roo.bootstrap.nav.ProgressBar",
- "Roo.bootstrap.nav.ProgressBarItem",
- "Roo.bootstrap.nav.Sidebar",
- "Roo.bootstrap.nav.SidebarItem",
- "Roo.bootstrap.nav.Simplebar"
- ],
+ "tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.Img" : {
+ "Roo.bootstrap.Popover" : {
"props" : [
{
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
+ "name" : "(right|top|bottom|left|auto)",
+ "type" : "String|function",
+ "desc" : "placement how it is placed",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "alt",
- "type" : "String",
- "desc" : "image alternative text",
+ "name" : "add",
+ "type" : "String|Boolean|Roo.Element",
+ "desc" : "click hander to trigger show over what element\n - if false and it has a 'parent' then it will be automatically added to that element\n - if string - Roo.get will be called",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "backgroundContain",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "(use style background and contain image in content)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "border",
- "type" : "String",
- "desc" : "rounded | circle | thumbnail",
- "memberOf" : "",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "delay",
+ "type" : "Number",
+ "desc" : "- delay before showing",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "disableClass",
"type" : "String",
]
},
{
- "name" : "href",
- "type" : "String",
- "desc" : "a tag href",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "imgResponsive",
- "type" : "Boolean",
- "desc" : "false | true",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "lgUrl",
+ "name" : "html",
"type" : "String",
- "desc" : "lg image source",
+ "desc" : "contents of the popover (or false to use children..)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"optvals" : []
},
{
- "name" : "mdUrl",
- "type" : "String",
- "desc" : "md image source",
+ "name" : "modal",
+ "type" : "Boolean",
+ "desc" : "- popovers that are modal will mask the screen, and must be closed with another event.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"optvals" : []
},
{
- "name" : "smUrl",
+ "name" : "style",
"type" : "String",
- "desc" : "sm image source",
- "memberOf" : "",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "src",
+ "name" : "title",
"type" : "String",
- "desc" : "image source",
+ "desc" : "of popover (or false to hide)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "target",
+ "name" : "trigger",
"type" : "String",
- "desc" : "p)target for a hre",
+ "desc" : "click || hover (or false to trigger manually)",
"memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "_self",
- "_blank",
- "_parent",
- "_top"
- ]
- },
- {
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
"optvals" : []
},
{
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
- },
- {
- "name" : "xsUrl",
- "type" : "String",
- "desc" : "xs image source",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
}
],
"events" : [
],
"returns" : []
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "The img click event for the img.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
{
"name" : "hide",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "After the popover hide",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "load",
- "type" : "function",
- "desc" : "The when any image loads",
- "sig" : "function (e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.bootstrap.Popover",
"desc" : "",
"isOptional" : false
}
{
"name" : "show",
"type" : "function",
- "desc" : "Fires after the component is shown.",
+ "desc" : "After the popover show",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.Popover",
"desc" : "",
"isOptional" : false
}
}
]
},
+ {
+ "name" : "doAlign",
+ "type" : "function",
+ "desc" : "update the position of the dialog\nnormally this is needed if the popover get's bigger - due to a Table reload etc..",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "enable",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setContent",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "(the)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "string",
+ "desc" : "body content",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
"returns" : []
},
{
- "name" : "setSrc",
+ "name" : "setTitle",
"type" : "function",
- "desc" : "Sets the url of the image - used to update it",
- "sig" : "(url)",
+ "desc" : "",
+ "sig" : "(the)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "url",
- "type" : "String",
- "desc" : "the url of the image",
+ "name" : "the",
+ "type" : "string",
+ "desc" : "title",
"isOptional" : false
}
],
{
"name" : "show",
"type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
+ "desc" : "Show the popover",
+ "sig" : "(-, (left|right|top|bottom))",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "-",
+ "type" : "Roo.Element|string|Boolean",
+ "desc" : "element to align and point to. (set align to [ pos, offset ])",
+ "isOptional" : false
+ },
+ {
+ "name" : "(left|right|top|bottom)",
+ "type" : "string",
+ "desc" : "position",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
}
],
"returns" : []
+ },
+ {
+ "name" : "updatePosition",
+ "type" : "function",
+ "desc" : "fire this manually after loading a grid in the table for example",
+ "sig" : "((left|right|top|bottom), try)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "(left|right|top|bottom)",
+ "type" : "string",
+ "desc" : "where to try and put it (use false to use the last one)",
+ "isOptional" : false
+ },
+ {
+ "name" : "try",
+ "type" : "Boolean",
+ "desc" : "and move it if we cant get right position.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.PopoverNav",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : [
+ "none",
+ "builder"
+ ]
},
- "Roo.bootstrap.LayoutMasonry" : {
+ "Roo.bootstrap.PopoverNav" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) alignme",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"optvals" : []
},
{
- "name" : "alternativePadWidth",
- "type" : "Number",
- "desc" : "padding below box..",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "boxHeight",
- "type" : "Number",
- "desc" : "- 0 for square, or fix it at a certian height",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "boxWidth",
- "type" : "Number",
- "desc" : "width of the columns",
- "memberOf" : "",
+ "name" : "arrangement",
+ "type" : "Boolean",
+ "desc" : "stacked | justified",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "gutter",
- "type" : "Number",
- "desc" : "gutter width..",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "hideMode",
"type" : "String",
]
},
{
- "name" : "isAutoInitial",
- "type" : "Boolean",
- "desc" : "defalut true",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "isHorizontal",
- "type" : "Boolean",
- "desc" : "defalut false",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "isLayoutInstant",
+ "name" : "inverse",
"type" : "Boolean",
- "desc" : "= no animation?",
- "memberOf" : "",
+ "desc" : "is inverted color",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "maxCols",
- "type" : "Number",
- "desc" : "maximum number of columns",
- "memberOf" : "",
+ "name" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "e) loadMask on the b",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "main",
+ "type" : "Boolean",
+ "desc" : "e) main nav bar? default fal",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "name",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "padWidth",
- "type" : "Number",
- "desc" : "padding below box..",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "style",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "v) default is n",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "header",
+ "footer",
+ "nav",
+ "div"
+ ]
+ },
{
"name" : "tooltip",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "type",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "nav",
+ "pills",
+ "tabs"
+ ]
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"parent"
]
},
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "e) default is ligh",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "light",
+ "primary",
+ "secondary",
+ "success",
+ "danger",
+ "warning",
+ "info",
+ "dark",
+ "white"
+ ]
+ },
{
"name" : "xattr",
"type" : "Object",
],
"returns" : []
},
+ {
+ "name" : "beforetoggle",
+ "type" : "function",
+ "desc" : "Fire before toggle the menu",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "layout",
- "type" : "function",
- "desc" : "Fire after layout the items",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.LayoutMasonry",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
}
],
"methods" : [
- {
- "name" : "_processVerticalLayoutQueue",
- "type" : "function",
- "desc" : "Sets position of item in DOM",
- "sig" : "(item, x, y, isInstant)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "item",
- "type" : "Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "- horizontal position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "- vertical position",
- "isOptional" : false
- },
- {
- "name" : "isInstant",
- "type" : "Boolean",
- "desc" : "- disables transitions",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "addBrick",
- "type" : "function",
- "desc" : "adds a Masonry Brick",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.MasonryBrick",
- "desc" : "masonry brick to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "clearAll",
+ "name" : "collapse",
"type" : "function",
- "desc" : "clear all the Masonry Brick",
+ "desc" : "Collapse the navbar pulldown",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expand the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
}
]
},
- {
- "name" : "get",
- "type" : "function",
- "desc" : "fetch a Masonry Layout based on the masonry layout ID",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "string",
- "desc" : "masonry layout to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "getChildContainer",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "register",
- "type" : "function",
- "desc" : "register a Masonry Brick",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.MasonryBrick",
- "desc" : "masonry brick to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "register",
- "type" : "function",
- "desc" : "register a Masonry Layout",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.LayoutMasonry",
- "desc" : "masonry layout to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "releaseCapture",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "removeBrick",
- "type" : "function",
- "desc" : "remove a Masonry Brick",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.MasonryBrick",
- "desc" : "masonry brick to remove",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "removeListener",
"type" : "function",
"isBuilderTop" : false,
"implementations" : [],
"tree_children" : [
- "Roo.bootstrap.Element",
- "Roo.bootstrap.DropTarget",
- "Roo.bootstrap.Img",
- "Roo.bootstrap.MasonryBrick"
+ "Roo.bootstrap.nav.Group"
],
- "tree_parent" : []
+ "tree_parent" : [
+ "Roo.bootstrap.Popover"
+ ]
},
- "Roo.bootstrap.LayoutMasonryAuto" : {
+ "Roo.bootstrap.Progress" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "active",
+ "type" : "Boolean",
+ "desc" : "animated of the progress bar",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "columnWidth",
- "type" : "Number",
- "desc" : "width of the columns",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "container_method",
"type" : "string",
"visibility"
]
},
- {
- "name" : "isAutoInitial",
- "type" : "Boolean",
- "desc" : "defalut true",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "isFitWidth",
- "type" : "Boolean",
- "desc" : "- resize the width..",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "isLayoutInstant",
- "type" : "Boolean",
- "desc" : "= no animation?",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "isOriginLeft",
- "type" : "Boolean",
- "desc" : "= left align?",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "isOriginTop",
- "type" : "Boolean",
- "desc" : "= top align?",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "isResizingContainer",
- "type" : "Boolean",
- "desc" : "= not sure if this is used..",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "maxCols",
- "type" : "Number",
- "desc" : "maximum number of columns",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "name",
"type" : "string",
"optvals" : []
},
{
- "name" : "padHeight",
- "type" : "Number",
- "desc" : "padding below box..",
+ "name" : "striped",
+ "type" : "Boolean",
+ "desc" : "striped of the progress bar",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
}
],
"methods" : [
- {
- "name" : "_getColGroup",
- "type" : "function",
- "desc" : "",
- "sig" : "(colSpan)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "colSpan",
- "type" : "Number",
- "desc" : "- number of columns the element spans",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "_postLayout",
- "type" : "function",
- "desc" : "Any logic you want to do after each layout,\ni.e. size the container",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "_processLayoutQueue",
- "type" : "function",
- "desc" : "Sets position of item in DOM",
- "sig" : "(item, x, y, isInstant)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "item",
- "type" : "Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "- horizontal position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "- vertical position",
- "isOptional" : false
- },
- {
- "name" : "isInstant",
- "type" : "Boolean",
- "desc" : "- disables transitions",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "addEvents",
"type" : "function",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [],
+ "tree_children" : [
+ "Roo.bootstrap.ProgressBar"
+ ],
"tree_parent" : []
},
- "Roo.bootstrap.Link" : {
+ "Roo.bootstrap.ProgressBar" : {
"props" : [
{
"name" : "actionMode",
"optvals" : []
},
{
- "name" : "alt",
- "type" : "String",
- "desc" : "image alternative text",
+ "name" : "aria_valuemax",
+ "type" : "Number",
+ "desc" : "aria-value max",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "anchor",
- "type" : "String",
- "desc" : "name for the anchor link",
+ "name" : "aria_valuemin",
+ "type" : "Number",
+ "desc" : "aria-value min",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "aria_valuenow",
+ "type" : "Number",
+ "desc" : "aria-value now",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "fa",
- "type" : "String",
- "desc" : "- favicon",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "hideMode",
"type" : "String",
]
},
{
- "name" : "href",
- "type" : "String",
- "desc" : "a tag href",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "html",
+ "name" : "label",
"type" : "String",
- "desc" : "the content of the link.",
+ "desc" : "label for the progress bar",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"optvals" : []
},
{
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "e) default fal",
+ "name" : "panel",
+ "type" : "String",
+ "desc" : "",
"memberOf" : "",
"isOptional" : false,
"optvals" : [
- "true",
- "false"
+ "success",
+ "info",
+ "warning",
+ "danger"
]
},
{
- "name" : "style",
+ "name" : "role",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "role of the progress bar",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "target",
+ "name" : "sr_only",
"type" : "String",
- "desc" : "p) target for a hre",
+ "desc" : "text",
"memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "_self",
- "_blank",
- "_parent",
- "_top"
- ]
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
],
"returns" : []
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "The img click event for the img.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.Alert",
- "Roo.bootstrap.BezierSignature",
- "Roo.bootstrap.Brick",
- "Roo.bootstrap.Button",
- "Roo.bootstrap.ButtonGroup",
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.Calendar",
- "Roo.bootstrap.Card",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.DocumentManager",
- "Roo.bootstrap.DocumentSlider",
- "Roo.bootstrap.DocumentViewer",
- "Roo.bootstrap.DropTarget",
- "Roo.bootstrap.Element",
- "Roo.bootstrap.Graph",
- "Roo.bootstrap.Header",
- "Roo.bootstrap.Img",
- "Roo.bootstrap.LayoutMasonry",
- "Roo.bootstrap.LayoutMasonryAuto",
- "Roo.bootstrap.Link",
- "Roo.bootstrap.LocationPicker",
- "Roo.bootstrap.MasonryBrick",
- "Roo.bootstrap.MessageBar",
- "Roo.bootstrap.Pagination",
- "Roo.bootstrap.PaginationItem",
- "Roo.bootstrap.PagingToolbar",
- "Roo.bootstrap.Progress",
- "Roo.bootstrap.ProgressBar",
- "Roo.bootstrap.Row",
- "Roo.bootstrap.Slider",
- "Roo.bootstrap.TabGroup",
- "Roo.bootstrap.TabPanel",
- "Roo.bootstrap.Table",
- "Roo.bootstrap.UploadCropbox",
- "Roo.bootstrap.breadcrumb.Nav",
- "Roo.bootstrap.dash.NumberBox",
- "Roo.bootstrap.dash.TabBox",
- "Roo.bootstrap.dash.TabPane",
- "Roo.bootstrap.form.CardUploader",
- "Roo.bootstrap.form.CheckBox",
- "Roo.bootstrap.form.ComboBox",
- "Roo.bootstrap.form.DateField",
- "Roo.bootstrap.form.DateSplitField",
- "Roo.bootstrap.form.FieldLabel",
- "Roo.bootstrap.form.Form",
- "Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.Input",
- "Roo.bootstrap.form.Markdown",
- "Roo.bootstrap.form.MoneyField",
- "Roo.bootstrap.form.MonthField",
- "Roo.bootstrap.form.NumberField",
- "Roo.bootstrap.form.Password",
- "Roo.bootstrap.form.PhoneInput",
- "Roo.bootstrap.form.Radio",
- "Roo.bootstrap.form.RadioSet",
- "Roo.bootstrap.form.SecurePass",
- "Roo.bootstrap.form.TextArea",
- "Roo.bootstrap.form.TimeField",
- "Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.nav.Group",
- "Roo.bootstrap.nav.Headerbar",
- "Roo.bootstrap.nav.ProgressBar",
- "Roo.bootstrap.nav.ProgressBarItem",
- "Roo.bootstrap.nav.Sidebar",
- "Roo.bootstrap.nav.SidebarItem",
- "Roo.bootstrap.nav.Simplebar"
- ],
+ "tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.LocationPicker" : {
+ "Roo.bootstrap.Row" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "disableDoubleClickZoom",
- "type" : "Boolean",
- "desc" : "default false",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "draggable",
- "type" : "Boolean",
- "desc" : "default true",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "enableAutocomplete",
- "type" : "Boolean",
- "desc" : "default false",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "enableReverseGeocode",
- "type" : "Boolean",
- "desc" : "default true",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "hideMode",
"type" : "String",
"visibility"
]
},
- {
- "name" : "latitude",
- "type" : "Number",
- "desc" : "Position when init default 0",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "locationName",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "longitude",
- "type" : "Number",
- "desc" : "Position when init default 0",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "mapTypeControl",
- "type" : "Boolean",
- "desc" : "default false",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "mapTypeId",
- "type" : "String",
- "desc" : "default google.maps.MapTypeId.ROADMAP",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "markerTitle",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "name",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "radius",
- "type" : "Number",
- "desc" : "default 0",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "scrollwheel",
- "type" : "Boolean",
- "desc" : "default true",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "streetViewControl",
- "type" : "Boolean",
- "desc" : "default false",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "style",
"type" : "String",
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
- },
- {
- "name" : "zoom",
- "type" : "Number",
- "desc" : "default 15",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
}
],
"events" : [
- {
- "name" : "OverlayViewDraw",
- "type" : "function",
- "desc" : "Fires when OverlayView Draw",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "OverlayViewHide",
- "type" : "function",
- "desc" : "Fires when OverlayView Draw",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "OverlayViewOnAdd",
- "type" : "function",
- "desc" : "Fires when OverlayView Draw",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "OverlayViewOnRemove",
- "type" : "function",
- "desc" : "Fires when OverlayView Draw",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "OverlayViewShow",
- "type" : "function",
- "desc" : "Fires when OverlayView Draw",
- "sig" : "function (_self, cpx)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "cpx",
- "type" : "Pixel",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforedestroy",
"type" : "function",
{
"name" : "hide",
"type" : "function",
- "desc" : "Fires when the map hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "initial",
- "type" : "function",
- "desc" : "Fires when the picker initialized.",
- "sig" : "function (_self, location)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "location",
- "type" : "Google Location",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "loadexception",
- "type" : "function",
- "desc" : "Fires when load google lib failed.",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "mapClick",
- "type" : "function",
- "desc" : "Fires when click the map.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Map event",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "mapRightClick",
- "type" : "function",
- "desc" : "Fires when right click the map.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Map event",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "markerClick",
- "type" : "function",
- "desc" : "Fires when click the marker.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Map event",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "markerRightClick",
- "type" : "function",
- "desc" : "Fires when right click the marker.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Map event",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "positionchanged",
- "type" : "function",
- "desc" : "Fires when the picker position changed.",
- "sig" : "function (_self, location)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "location",
- "type" : "Google Location",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "resize",
- "type" : "function",
- "desc" : "Fires when the map resize.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
- "desc" : "Fires when the map show.",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [],
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
"tree_parent" : []
},
- "Roo.bootstrap.MasonryBrick" : {
+ "Roo.bootstrap.Slider" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "bgimage",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
{
"name" : "cls",
"type" : "String",
- "desc" : "",
- "memberOf" : "",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
"visibility"
]
},
- {
- "name" : "href",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "html",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "defalut false",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "isFitContainer",
- "type" : "Boolean",
- "desc" : "defalut true",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "placetitle",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "center",
- "bottom"
- ]
- },
- {
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "defalut false",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "size",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "xs",
- "sm",
- "md",
- "md-left",
- "md-right",
- "tall",
- "wide"
- ]
- },
{
"name" : "style",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "title",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "tooltip",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "videourl",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "visibilityEl",
"type" : "string|object",
],
"returns" : []
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "When a MasonryBrick is clcik",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.MasonryBrick",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "get",
- "type" : "function",
- "desc" : "fetch a masonry brick based on the masonry brick ID",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "string",
- "desc" : "masonry brick to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "getChildContainer",
"type" : "function",
"returns" : []
},
{
- "name" : "register",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "register a Masonry Brick",
- "sig" : "(the)",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
"static" : true,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "the",
- "type" : "Roo.bootstrap.MasonryBrick",
- "desc" : "masonry brick to add",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
"memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "render",
"type" : "function",
- "desc" : "Removes a listener",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setVisibilityEl",
+ "type" : "function",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
+ }
+ ]
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
}
],
"returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.SplitBar" : {
+ "props" : [
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforeresize",
+ "type" : "function",
+ "desc" : "Fires before the splitter is dragged",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.SplitBar",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "render",
+ "name" : "moved",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Fires when the splitter is moved",
+ "sig" : "function (_self, newSize)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.SplitBar",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "the new width or height",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "resize",
+ "type" : "function",
+ "desc" : "Fires when the splitter is moved (alias for {@link #event-moved})",
+ "sig" : "function (_self, newSize)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.SplitBar",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "the new width or height",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setVisibilityEl",
+ "name" : "capture",
"type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Destroy this splitbar.",
+ "sig" : "(removeEl)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "removeEl",
+ "type" : "Boolean",
+ "desc" : "True to remove the element",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "show",
+ "name" : "getAdapter",
"type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
+ "desc" : "Get the adapter this SplitBar uses",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "",
+ "desc" : "The adapter object"
+ }
+ ]
},
{
- "name" : "tooltipEl",
+ "name" : "getMaximumSize",
"type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
+ "desc" : "Gets the maximum size for the resizing element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Number",
+ "desc" : "The maximum size"
+ }
+ ]
+ },
+ {
+ "name" : "getMinimumSize",
+ "type" : "function",
+ "desc" : "Gets the minimum size for the resizing element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The minimum size"
+ }
+ ]
+ },
+ {
+ "name" : "hasListener",
+ "type" : "function",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
+ {
+ "name" : "on",
+ "type" : "function",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setAdapter",
+ "type" : "function",
+ "desc" : "Set the adapter this SplitBar uses",
+ "sig" : "(adapter)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "adapter",
+ "type" : "Object",
+ "desc" : "A SplitBar adapter object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setCurrentSize",
+ "type" : "function",
+ "desc" : "Sets the initialize size for the resizing element",
+ "sig" : "(size)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "size",
+ "type" : "Number",
+ "desc" : "The initial size",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setMaximumSize",
+ "type" : "function",
+ "desc" : "Sets the maximum size for the resizing element",
+ "sig" : "(maxSize)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "maxSize",
+ "type" : "Number",
+ "desc" : "The maximum size",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setMinimumSize",
+ "type" : "function",
+ "desc" : "Sets the minimum size for the resizing element",
+ "sig" : "(minSize)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "minSize",
+ "type" : "Number",
+ "desc" : "The minimum size",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "un",
"type" : "function",
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.MessageBar" : {
+ "Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "getElementSize",
+ "type" : "function",
+ "desc" : "Called before drag operations to get the current size of the resizing element.",
+ "sig" : "(s)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "s",
+ "type" : "Roo.bootstrap.SplitBar",
+ "desc" : "The SplitBar using this adapter",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setElementSize",
+ "type" : "function",
+ "desc" : "Called after drag operations to set the size of the resizing element.",
+ "sig" : "(s, newSize, onComplete)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "s",
+ "type" : "Roo.bootstrap.SplitBar",
+ "desc" : "The SplitBar using this adapter",
+ "isOptional" : false
+ },
+ {
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new size to set",
+ "isOptional" : false
+ },
+ {
+ "name" : "onComplete",
+ "type" : "Function",
+ "desc" : "A function to be invoked when resizing is complete",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.SplitBar.BasicLayoutAdapter" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "getElementSize",
+ "type" : "function",
+ "desc" : "Called before drag operations to get the current size of the resizing element.",
+ "sig" : "(s)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "s",
+ "type" : "Roo.bootstrap.SplitBar",
+ "desc" : "The SplitBar using this adapter",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setElementSize",
+ "type" : "function",
+ "desc" : "Called after drag operations to set the size of the resizing element.",
+ "sig" : "(s, newSize, onComplete)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "s",
+ "type" : "Roo.bootstrap.SplitBar",
+ "desc" : "The SplitBar using this adapter",
+ "isOptional" : false
+ },
+ {
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new size to set",
+ "isOptional" : false
+ },
+ {
+ "name" : "onComplete",
+ "type" : "Function",
+ "desc" : "A function to be invoked when resizing is complete",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.TabGroup" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "alert",
+ "type" : "String",
+ "desc" : "r) type alert (changes background / border..",
+ "memberOf" : "Roo.bootstrap.Column",
+ "isOptional" : false,
+ "optvals" : [
+ "success",
+ "info",
+ "warning",
+ "danger"
+ ]
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"optvals" : []
},
{
- "name" : "beforeClass",
- "type" : "String",
- "desc" : "insert the bar before the given class",
+ "name" : "autoslide",
+ "type" : "Boolean",
+ "desc" : "e) auto slide .. default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "bullets",
+ "type" : "Boolean",
+ "desc" : "show bullets for the panels",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"optvals" : []
},
{
- "name" : "closable",
+ "name" : "carousel",
"type" : "Boolean",
- "desc" : "e) default fal",
+ "desc" : "true to make the group behave like a carousel",
"memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
+ "optvals" : []
},
{
"name" : "cls",
"optvals" : []
},
{
- "name" : "fixed",
+ "name" : "fa",
+ "type" : "String",
+ "desc" : ".) font awesome ic",
+ "memberOf" : "Roo.bootstrap.Column",
+ "isOptional" : false,
+ "optvals" : [
+ "ban",
+ "check",
+ "..."
+ ]
+ },
+ {
+ "name" : "fasize",
+ "type" : "Number",
+ "desc" : ".) font awsome si",
+ "memberOf" : "Roo.bootstrap.Column",
+ "isOptional" : false,
+ "optvals" : [
+ "1",
+ "2",
+ "...."
+ ]
+ },
+ {
+ "name" : "hidden",
"type" : "Boolean",
- "desc" : "e) default false, fix the bar at the t",
- "memberOf" : "",
+ "desc" : "e) hide the eleme",
+ "memberOf" : "Roo.bootstrap.Column",
"isOptional" : false,
"optvals" : [
"true",
{
"name" : "html",
"type" : "String",
- "desc" : "contents of the MessageBar",
- "memberOf" : "",
+ "desc" : "content of column.",
+ "memberOf" : "Roo.bootstrap.Column",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "icon",
+ "type" : "String",
+ "desc" : ".) glyphicon na",
+ "memberOf" : "Roo.bootstrap.Column",
+ "isOptional" : false,
+ "optvals" : [
+ "info-sign",
+ "check",
+ "..."
+ ]
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens or 0 for hidden",
+ "memberOf" : "Roo.bootstrap.Column",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "lgoff",
+ "type" : "Number",
+ "desc" : "colspan offset out of 12 for large computer-sized screens or 0 for hidden",
+ "memberOf" : "Roo.bootstrap.Column",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens or 0 for hidden",
+ "memberOf" : "Roo.bootstrap.Column",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "mdoff",
+ "type" : "Number",
+ "desc" : "colspan offset out of 12 for computer-sized screens or 0 for hidden",
+ "memberOf" : "Roo.bootstrap.Column",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "name",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "navId",
+ "type" : "String",
+ "desc" : "the navigation id (for use with navbars) - will be auto generated if it does not exist..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "showarrow",
+ "type" : "Boolean",
+ "desc" : "e) show arrow default tr",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens or 0 for hidden",
+ "memberOf" : "Roo.bootstrap.Column",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "smoff",
+ "type" : "Number",
+ "desc" : "colspan offset out of 12 for tablet-sized screens or 0 for hidden",
+ "memberOf" : "Roo.bootstrap.Column",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "style",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "timer",
+ "type" : "Number",
+ "desc" : "auto slide timer .. default 0 millisecond",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tooltip",
"type" : "string",
"parent"
]
},
- {
- "name" : "weight",
- "type" : "String",
- "desc" : "r) default in",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "info",
- "success",
- "warning",
- "danger"
- ]
- },
{
"name" : "xattr",
"type" : "Object",
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens or 0 for hidden",
+ "memberOf" : "Roo.bootstrap.Column",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "xsoff",
+ "type" : "Number",
+ "desc" : "colspan offset out of 12 for mobile-sized screens or 0 for hidden",
+ "memberOf" : "Roo.bootstrap.Column",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
}
]
},
+ {
+ "name" : "get",
+ "type" : "function",
+ "desc" : "fetch a Navigation Group based on the navigation ID\nif one does not exist , it will get created.",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "string",
+ "desc" : "navgroup to add",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "register",
+ "type" : "function",
+ "desc" : "register a Navigation item",
+ "sig" : "(the)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "Roo.bootstrap.nav.Item",
+ "desc" : "navitem to add",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "register",
+ "type" : "function",
+ "desc" : "register a Navigation Group",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "Roo.bootstrap.nav.Group",
+ "desc" : "navgroup to add",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "releaseCapture",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "showPanel",
+ "type" : "function",
+ "desc" : "show a specific panel",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Roo.bootstrap.TabPanel|number|string",
+ "desc" : "to change to (use the tabId to specify a specific one)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "boolean",
+ "desc" : "false if panel was not shown (invalid entry or beforedeactivate fails.)"
+ }
+ ]
+ },
{
"name" : "tooltipEl",
"type" : "function",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [],
+ "tree_children" : [
+ "Roo.bootstrap.TabPanel"
+ ],
"tree_parent" : []
},
- "Roo.bootstrap.MessageBox" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ "Roo.bootstrap.TabPanel" : {
+ "props" : [
{
- "name" : "alert",
- "type" : "function",
- "desc" : "Displays a standard read-only message box with an OK button (comparable to the basic JavaScript Window.alert).\nIf a callback function is passed it will be called after the user clicks the button, and the\nid of the button that was clicked will be passed as the only parameter to the callback\n(could also be the top-right close button).",
- "sig" : "(title, msg, fn, scope)",
- "static" : false,
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "active",
+ "type" : "Boolean",
+ "desc" : "panel active",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "title",
- "type" : "String",
- "desc" : "The title bar text",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The message box body text",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "(optional) The callback function invoked after the message box is closed",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the callback function",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
- },
- {
- "name" : "confirm",
- "type" : "function",
- "desc" : "Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's Window.confirm).\nIf a callback function is passed it will be called after the user clicks either button, and the id of the\nbutton that was clicked will be passed as the only parameter to the callback (could also be the top-right close button).",
- "sig" : "(title, msg, fn, scope)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "title",
- "type" : "String",
- "desc" : "The title bar text",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The message box body text",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "(optional) The callback function invoked after the message box is closed",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the callback function",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
- },
- {
- "name" : "getDialog",
- "type" : "function",
- "desc" : "Returns a reference to the underlying {@link Roo.BasicDialog} element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.BasicDialog",
- "desc" : "The BasicDialog element"
- }
- ]
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Hides the message box if it is displayed",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if the message box is currently displayed",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the message box is visible, else false"
- }
- ]
- },
- {
- "name" : "progress",
- "type" : "function",
- "desc" : "Displays a message box with a progress bar. This message box has no buttons and is not closeable by\nthe user. You are responsible for updating the progress bar as needed via {@link Roo.MessageBox#updateProgress}\nand closing the message box when the process is complete.",
- "sig" : "(title, msg)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "title",
- "type" : "String",
- "desc" : "The title bar text",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The message box body text",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
- },
- {
- "name" : "prompt",
- "type" : "function",
- "desc" : "Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to\nJavaScript's Window.prompt). The prompt can be a single-line or multi-line textbox. If a callback function\nis passed it will be called after the user clicks either button, and the id of the button that was clicked\n(could also be the top-right close button) and the text that was entered will be passed as the two\nparameters to the callback.",
- "sig" : "(title, msg, fn, scope, multiline)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "title",
- "type" : "String",
- "desc" : "The title bar text",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The message box body text",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "(optional) The callback function invoked after the message box is closed",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the callback function",
- "isOptional" : false
- },
- {
- "name" : "multiline",
- "type" : "Boolean/Number",
- "desc" : "(optional) True to create a multiline textbox using the defaultTextHeight\nproperty, or the height in pixels to create the textbox (defaults to false / single-line)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Displays a new message box, or reinitializes an existing message box, based on the config options\npassed in. All functions (e.g. prompt, alert, etc) on MessageBox call this function internally.\nThe following config object properties are supported:\n<pre>\nProperty Type Description\n---------- --------------- ------------------------------------------------------------------------------------\nanimEl String/Element An id or Element from which the message box should animate as it opens and\n closes (defaults to undefined)\nbuttons Object/Boolean A button config object (e.g., Roo.MessageBox.OKCANCEL or {ok:'Foo',\n cancel:'Bar'}), or false to not show any buttons (defaults to false)\nclosable Boolean False to hide the top-right close button (defaults to true). Note that\n progress and wait dialogs will ignore this property and always hide the\n close button as they can only be closed programmatically.\ncls String A custom CSS class to apply to the message box element\ndefaultTextHeight Number The default height in pixels of the message box's multiline textarea if\n displayed (defaults to 75)\nfn Function A callback function to execute after closing the dialog. The arguments to the\n function will be btn (the name of the button that was clicked, if applicable,\n e.g. \"ok\"), and text (the value of the active text field, if applicable).\n Progress and wait dialogs will ignore this option since they do not respond to\n user actions and can only be closed programmatically, so any required function\n should be called by the same code after it closes the dialog.\nicon String A CSS class that provides a background image to be used as an icon for\n the dialog (e.g., Roo.MessageBox.WARNING or 'custom-class', defaults to '')\nmaxWidth Number The maximum width in pixels of the message box (defaults to 600)\nminWidth Number The minimum width in pixels of the message box (defaults to 100)\nmodal Boolean False to allow user interaction with the page while the message box is\n displayed (defaults to true)\nmsg String A string that will replace the existing message box body text (defaults\n to the XHTML-compliant non-breaking space character ' ')\nmultiline Boolean True to prompt the user to enter multi-line text (defaults to false)\nprogress Boolean True to display a progress bar (defaults to false)\nprogressText String The text to display inside the progress bar if progress = true (defaults to '')\nprompt Boolean True to prompt the user to enter single-line text (defaults to false)\nproxyDrag Boolean True to display a lightweight proxy while dragging (defaults to false)\ntitle String The title text\nvalue String The string value to set into the active textbox element if displayed\nwait Boolean True to display a progress bar (defaults to false)\nwidth Number The width of the dialog in pixels\n</pre>\n\nExample usage:\n<pre><code>\nRoo.Msg.show({\n title: 'Address',\n msg: 'Please enter your address:',\n width: 300,\n buttons: Roo.MessageBox.OKCANCEL,\n multiline: true,\n fn: saveAddress,\n animEl: 'addAddressBtn'\n});\n</code></pre>",
- "sig" : "(config)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "config",
- "type" : "Object",
- "desc" : "Configuration options",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
- },
- {
- "name" : "updateProgress",
- "type" : "function",
- "desc" : "Updates a progress-style message box's text and progress bar. Only relevant on message boxes\ninitiated via {@link Roo.MessageBox#progress} or by calling {@link Roo.MessageBox#show} with progress: true.",
- "sig" : "(value, text)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Number",
- "desc" : "Any number between 0 and 1 (e.g., .5)",
- "isOptional" : false
- },
- {
- "name" : "text",
- "type" : "String",
- "desc" : "(optional) If defined, the message box's body text is replaced with the specified string (defaults to undefined)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
- },
- {
- "name" : "updateText",
- "type" : "function",
- "desc" : "Updates the message box body text",
- "sig" : "(text)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "text",
- "type" : "String",
- "desc" : "(optional) Replaces the message box element's innerHTML with the specified string (defaults to\nthe XHTML-compliant non-breaking space character '&#160;')",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
- },
- {
- "name" : "wait",
- "type" : "function",
- "desc" : "Displays a message box with an infinitely auto-updating progress bar. This can be used to block user\ninteraction while waiting for a long-running process to complete that does not have defined intervals.\nYou are responsible for closing the message box when the process is complete.",
- "sig" : "(msg, title)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The message box body text",
- "isOptional" : false
- },
- {
- "name" : "title",
- "type" : "String",
- "desc" : "(optional) The title bar text",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.bootstrap.Modal" : {
- "props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "allow_close",
- "type" : "Boolean",
- "desc" : "default true",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "animate",
- "type" : "Boolean",
- "desc" : "default true",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "bodyOverflow",
- "type" : "Boolean",
- "desc" : "should the body element have overflow auto added default false",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "buttonPosition",
- "type" : "String",
- "desc" : "r) default right (DEPRICATED) - use mr-auto on buttons to put them on the le",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "left",
- "right",
- "center"
- ]
- },
- {
- "name" : "buttons[]",
- "type" : "Roo.bootstrap.Button",
- "desc" : "Array of buttons or standard button set..",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "editableTitle",
- "type" : "Boolean",
- "desc" : "can the title be edited",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fitwindow",
- "type" : "Boolean",
- "desc" : "default false",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "fixed height - usefull for chrome extension only really.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "hideMode",
"type" : "String",
"visibility"
]
},
+ {
+ "name" : "href",
+ "type" : "String",
+ "desc" : "click to link..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "html",
"type" : "String",
- "desc" : "- the body of the dialog (for simple ones) - you can also use template..",
+ "desc" : "panel content",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "max_width",
- "type" : "Number",
- "desc" : "set the max width of modal",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "name",
"type" : "string",
"optvals" : []
},
{
- "name" : "size",
+ "name" : "navId",
"type" : "String",
- "desc" : "l) default emp",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "sm",
- "lg",
- "xl"
- ]
- },
- {
- "name" : "specificTitle",
- "type" : "Boolean",
- "desc" : "default false",
+ "desc" : "The Roo.bootstrap.nav.Group which triggers show hide ()",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"optvals" : []
},
{
- "name" : "title",
+ "name" : "tabId",
"type" : "String",
- "desc" : "Title of dialog",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "tmpl",
- "type" : "Roo.Template",
- "desc" : "- a template with variables. to use it, add a handler in show:method adn",
+ "desc" : "unique tab ID (will be autogenerated if not set. - used to match TabItem to Panel)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "touchSlide",
+ "type" : "Boolean",
+ "desc" : "if swiping slides tab to next panel (default off)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"parent"
]
},
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "fixed width - usefull for chrome extension only really.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "xattr",
"type" : "Object",
}
],
"events" : [
+ {
+ "name" : "beforedeactivate",
+ "type" : "function",
+ "desc" : "Fires before a tab is de-activated - can be used to do validation on a form.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.TabPanel",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "false if there is an error"
+ }
+ ]
+ },
{
"name" : "beforedestroy",
"type" : "function",
"returns" : []
},
{
- "name" : "btnclick",
+ "name" : "changed",
"type" : "function",
- "desc" : "The raw btnclick event for the button",
- "sig" : "function (e)\n{\n\n}",
+ "desc" : "Fires when the active status changes",
+ "sig" : "function (_self, state)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.bootstrap.TabPanel",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "the new state",
+ "isOptional" : false
}
],
"returns" : []
],
"returns" : []
},
- {
- "name" : "resize",
- "type" : "function",
- "desc" : "Fire when dialog resize",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Modal",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "titlechanged",
- "type" : "function",
- "desc" : "Fire when the editable title has been changed",
- "sig" : "function (_self, value)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Modal",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "value",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"methods" : [
],
"returns" : []
},
- {
- "name" : "applyBody",
- "type" : "function",
- "desc" : "Set the body of the Dialog using the template",
- "sig" : "(data)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "data",
- "type" : "Obj",
- "desc" : "- apply this data to the template and replace the body contents.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setBody",
- "type" : "function",
- "desc" : "Set the body of the Dialog",
- "sig" : "(str)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "str",
- "type" : "String",
- "desc" : "new Title",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setTitle",
- "type" : "function",
- "desc" : "Set the title of the Dialog",
- "sig" : "(str)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "str",
- "type" : "String",
- "desc" : "new Title",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
"Roo.bootstrap.form.TextArea",
"Roo.bootstrap.form.TimeField",
"Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.layout.Border",
"Roo.bootstrap.nav.Group",
"Roo.bootstrap.nav.Headerbar",
"Roo.bootstrap.nav.ProgressBar",
"Roo.bootstrap.nav.SidebarItem",
"Roo.bootstrap.nav.Simplebar"
],
- "tree_parent" : [
- "none",
- "builder"
- ]
+ "tree_parent" : []
},
- "Roo.bootstrap.Pagination" : {
+ "Roo.bootstrap.Table" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "auto_hide_footer",
+ "type" : "Boolean",
+ "desc" : "auto hide footer if only one page (default false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "bordered",
+ "type" : "boolean",
+ "desc" : "Add borders to the table",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "cellSelection",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "table class",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cm[]",
+ "type" : "Roo.grid.ColumnModel",
+ "desc" : "A column for the grid.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "condensed",
+ "type" : "boolean",
+ "desc" : "Format condensed",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "disableAutoSize",
+ "type" : "Boolean",
+ "desc" : "disable autoSize() and initCSS()",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "disableClass",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "empty_results",
+ "type" : "string",
+ "desc" : "Text to display for no results",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableColumnResize",
+ "type" : "Boolean",
+ "desc" : "default true if columns can be resized = needs scrollBody to be set to work (drag/drop)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "footer",
+ "type" : "Roo.bootstrap.PagingToolbar",
+ "desc" : "a paging toolbar",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "footerRow",
+ "type" : "Boolean",
+ "desc" : "e) generate tfoot with columns of values, default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "footerShow",
+ "type" : "Boolean",
+ "desc" : "e) generate tfoot, default tr",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "headerShow",
+ "type" : "Boolean",
+ "desc" : "e) generate thead, default tr",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "hideMode",
"type" : "String",
]
},
{
- "name" : "inverse",
+ "name" : "hover",
+ "type" : "boolean",
+ "desc" : "Add hover highlighting",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "lazyLoad",
"type" : "Boolean",
- "desc" : "",
+ "desc" : "auto load data while scrolling to the end (default false)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "minColumnWidth",
+ "type" : "Number",
+ "desc" : "default 50 pixels minimum column width",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "name",
"type" : "string",
"optvals" : []
},
{
- "name" : "size",
- "type" : "String",
- "desc" : "",
+ "name" : "responsive",
+ "type" : "boolean",
+ "desc" : "default false - if this is on, columns are rendered with col-xs-4 etc. classes, otherwise columns will be sized by CSS,\n also adds table-responsive (see bootstrap docs for details)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "rowSelection",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
"memberOf" : "",
"isOptional" : false,
"optvals" : [
- "xs",
- "sm",
- "md",
- "lg",
- "xl"
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "scrollBody",
+ "type" : "Boolean",
+ "desc" : "e) default false - body scrolled / fixed header (with resizable column",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
]
},
+ {
+ "name" : "sm",
+ "type" : "Roo.grid.AbstractSelectionModel",
+ "desc" : "The selection model to use (cell selection is not supported yet)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to use",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "striped",
+ "type" : "boolean",
+ "desc" : "Should the rows be alternative striped",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "style",
"type" : "String",
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "cellclick",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "Fires when a cell is clicked",
+ "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "el",
+ "type" : "Roo.Element",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "cellcontextmenu",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a cell is right clicked",
+ "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "cellIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "disable",
+ "name" : "celldblclick",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a cell is double clicked",
+ "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "el",
+ "type" : "Roo.Element",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "enable",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
+ "desc" : "Fires when the children have been rendered..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "hide",
+ "name" : "contextmenu",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "The raw contextmenu event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "render",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
+ "desc" : "Fires after the component is destroyed.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
],
"returns" : []
},
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "headercontextmenu",
+ "type" : "function",
+ "desc" : "Fires when a header is right clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "mousedown",
+ "type" : "function",
+ "desc" : "The raw mousedown event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "mouseout",
+ "type" : "function",
+ "desc" : "Fires when a mouseout occur",
+ "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "el",
+ "type" : "Roo.Element",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "mouseover",
+ "type" : "function",
+ "desc" : "Fires when a mouseover occur",
+ "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "el",
+ "type" : "Roo.Element",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "rowclass",
+ "type" : "function",
+ "desc" : "Fires when a row is rendered, so you can change add a style to it.",
+ "sig" : "function (_self, rowcfg)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowcfg",
+ "type" : "Object",
+ "desc" : "contains record rowIndex colIndex and rowClass - set rowClass to add a style.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "rowclick",
+ "type" : "function",
+ "desc" : "Fires when a row is clicked",
+ "sig" : "function (_self, el, rowIndex, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "el",
+ "type" : "Roo.Element",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "rowcontextmenu",
+ "type" : "function",
+ "desc" : "Fires when a row is right clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "rowdblclick",
+ "type" : "function",
+ "desc" : "Fires when a row is double clicked",
+ "sig" : "function (_self, el, rowIndex, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "el",
+ "type" : "Roo.Element",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "rowsrendered",
+ "type" : "function",
+ "desc" : "Fires when all the rows have been rendered",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "Forces a resize - used by panel.Grid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Element",
+ "desc" : "The element"
+ }
+ ]
+ },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "clear",
+ "type" : "function",
+ "desc" : "Remove all rows",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "ensureVisible",
+ "type" : "function",
+ "desc" : "Scrolls the specified cell into view",
+ "sig" : "(row, col, hscroll)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "row",
+ "type" : "Number",
+ "desc" : "The row index",
+ "isOptional" : false
+ },
+ {
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ },
+ {
+ "name" : "hscroll",
+ "type" : "Boolean",
+ "desc" : "false to disable horizontal scrolling",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
}
]
},
+ {
+ "name" : "focusCell",
+ "type" : "function",
+ "desc" : "Focuses the specified cell.",
+ "sig" : "(row, col, hscroll)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "row",
+ "type" : "Number",
+ "desc" : "The row index",
+ "isOptional" : false
+ },
+ {
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ },
+ {
+ "name" : "hscroll",
+ "type" : "Boolean",
+ "desc" : "false to disable horizontal scrolling",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "focusRow",
+ "type" : "function",
+ "desc" : "Focuses the specified row.",
+ "sig" : "(row)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "row",
+ "type" : "Number",
+ "desc" : "The row index",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "getCellIndex",
+ "type" : "function",
+ "desc" : "get the Column Index from a dom element. (using regex on x-hcol-{colid})",
+ "sig" : "(cell)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "cell",
+ "type" : "domElement",
+ "desc" : "to look for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
}
]
},
+ {
+ "name" : "getGridEl",
+ "type" : "function",
+ "desc" : "Returns the grid's underlying element = used by panel.Grid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Element",
+ "desc" : "The element"
+ }
+ ]
+ },
+ {
+ "name" : "getHeaderIndex",
+ "type" : "function",
+ "desc" : "get the header TH element for columnIndex",
+ "sig" : "(columnIndex)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "getId",
"type" : "function",
}
]
},
+ {
+ "name" : "getRowIndex",
+ "type" : "function",
+ "desc" : "get the Row Index from a dom element.",
+ "sig" : "(row)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "row",
+ "type" : "Roo.Element",
+ "desc" : "The row to look for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setRowVisibility",
+ "type" : "function",
+ "desc" : "Show or hide a row.",
+ "sig" : "(rowIndex, state)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "to show or hide",
+ "isOptional" : false
+ },
+ {
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "hide",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
"isBuilderTop" : false,
"implementations" : [],
"tree_children" : [
- "Roo.bootstrap.Pagination"
+ "Roo.bootstrap.TableBody"
],
"tree_parent" : []
},
- "Roo.bootstrap.PaginationItem" : {
+ "Roo.bootstrap.TableBody" : {
"props" : [
{
"name" : "actionMode",
"optvals" : []
},
{
- "name" : "active",
- "type" : "Boolean",
- "desc" : "e) default fal",
+ "name" : "align",
+ "type" : "String",
+ "desc" : "Aligns the content inside the element",
"memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
+ "optvals" : []
},
{
"name" : "allowDomMove",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "charoff",
+ "type" : "Number",
+ "desc" : "Sets the number of characters the content inside the element will be aligned from the character specified by the char attribute",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "element class",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "default false",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "hideMode",
"type" : "String",
"visibility"
]
},
- {
- "name" : "href",
- "type" : "String",
- "desc" : "the link",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "html",
- "type" : "String",
- "desc" : "text",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "e) default tr",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
{
"name" : "style",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "element tag (thead|tbody|tfoot) default tbody",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tooltip",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "valign",
+ "type" : "String",
+ "desc" : "Vertical aligns the content inside the <tbody> element",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
],
"returns" : []
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
+ "tree_children" : [
+ "Roo.bootstrap.TableRow"
+ ],
+ "tree_parent" : [
+ "Roo.bootstrap.Table"
+ ]
},
- "Roo.bootstrap.PagingToolbar" : {
+ "Roo.bootstrap.TableCell" : {
"props" : [
+ {
+ "name" : "abbr",
+ "type" : "String",
+ "desc" : "Specifies an abbreviated version of the content in a cell",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "actionMode",
"type" : "String",
{
"name" : "align",
"type" : "String",
- "desc" : "t) alignme",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "desc" : "Aligns the content in a cell",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "left",
- "right"
- ]
+ "optvals" : []
},
{
"name" : "allowDomMove",
"optvals" : []
},
{
- "name" : "arrangement",
- "type" : "Boolean",
- "desc" : "stacked | justified",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "name" : "axis",
+ "type" : "String",
+ "desc" : "Categorizes cells",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "buttons[]",
- "type" : "Roo.bootstrap.Button",
- "desc" : "Buttons for the toolbar",
+ "name" : "bgcolor",
+ "type" : "String",
+ "desc" : "Specifies the background color of a cell",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "charoff",
+ "type" : "Number",
+ "desc" : "Sets the number of characters the content will be aligned from the character specified by the char attribute",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "cell class",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "container The id or element that will contain the toolbar",
+ "name" : "colspan",
+ "type" : "Number",
+ "desc" : "Specifies the number of columns a cell should span",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"optvals" : []
},
{
- "name" : "displayInfo",
- "type" : "Boolean",
- "desc" : "True to display the displayMsg (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "displayMsg",
+ "name" : "headers",
"type" : "String",
- "desc" : "The paging status message to display (defaults to \"Displaying {start} - {end} of {total}\")",
+ "desc" : "Specifies one or more header cells a cell is related to",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "emptyMsg",
- "type" : "String",
- "desc" : "The message to display when no records are found (defaults to \"No data to display\")",
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "Sets the height of a cell",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
]
},
{
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "is inverted color",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "name" : "html",
+ "type" : "String",
+ "desc" : "cell contain text",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "loadMask",
- "type" : "Boolean",
- "desc" : "e) loadMask on the b",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "main",
- "type" : "Boolean",
- "desc" : "e) main nav bar? default fal",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
{
"name" : "name",
"type" : "string",
"optvals" : []
},
{
- "name" : "pageSize",
+ "name" : "nowrap",
+ "type" : "String",
+ "desc" : "Specifies that the content inside a cell should not wrap",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "rowspan",
"type" : "Number",
- "desc" : "The number of records to display per page (defaults to 20)",
+ "desc" : "Sets the number of rows a cell should span",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The underlying data store providing the paged data",
+ "name" : "scope",
+ "type" : "String",
+ "desc" : "Defines a way to associate header cells and data cells in a table",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
{
"name" : "tag",
"type" : "String",
- "desc" : "v) default is n",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "desc" : "cell tag (td|th) default td",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "header",
- "footer",
- "nav",
- "div"
- ]
+ "optvals" : []
},
{
"name" : "tooltip",
"optvals" : []
},
{
- "name" : "type",
+ "name" : "valign",
"type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "desc" : "Vertical aligns the content in a cell",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "nav",
- "pills",
- "tabs"
- ]
+ "optvals" : []
},
{
"name" : "visibilityEl",
]
},
{
- "name" : "weight",
- "type" : "String",
- "desc" : "e) default is ligh",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "Specifies the width of a cell",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "light",
- "primary",
- "secondary",
- "success",
- "danger",
- "warning",
- "info",
- "dark",
- "white"
- ]
+ "optvals" : []
},
{
"name" : "xattr",
],
"returns" : []
},
- {
- "name" : "beforetoggle",
- "type" : "function",
- "desc" : "Fire before toggle the menu",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.nav.Bar",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "bind",
- "type" : "function",
- "desc" : "Binds the paging toolbar to the specified {@link Roo.data.Store}",
- "sig" : "(store)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to bind",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Collapse the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.nav.Bar",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expand the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.nav.Bar",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "fireEvent",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "unbind",
- "type" : "function",
- "desc" : "Unbinds the paging toolbar from the specified {@link Roo.data.Store}",
- "sig" : "(store)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to unbind",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : [
+ "Roo.bootstrap.TableRow"
+ ]
},
- "Roo.bootstrap.Popover" : {
+ "Roo.bootstrap.TableRow" : {
"props" : [
- {
- "name" : "(right|top|bottom|left|auto)",
- "type" : "String|function",
- "desc" : "placement how it is placed",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "actionMode",
"type" : "String",
"optvals" : []
},
{
- "name" : "add",
- "type" : "String|Boolean|Roo.Element",
- "desc" : "click hander to trigger show over what element\n - if false and it has a 'parent' then it will be automatically added to that element\n - if string - Roo.get will be called",
+ "name" : "align",
+ "type" : "String",
+ "desc" : "Aligns the content in a table row",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "bgcolor",
+ "type" : "String",
+ "desc" : "Specifies a background color for a table row",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "charoff",
+ "type" : "Number",
+ "desc" : "Sets the number of characters the content will be aligned from the character specified by the char attribute",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "row class",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "delay",
- "type" : "Number",
- "desc" : "- delay before showing",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "disableClass",
"type" : "String",
"visibility"
]
},
- {
- "name" : "html",
- "type" : "String",
- "desc" : "contents of the popover (or false to use children..)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "modal",
- "type" : "Boolean",
- "desc" : "- popovers that are modal will mask the screen, and must be closed with another event.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "name",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "title",
- "type" : "String",
- "desc" : "of popover (or false to hide)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "tooltip",
"type" : "string",
"optvals" : []
},
{
- "name" : "trigger",
+ "name" : "valign",
"type" : "String",
- "desc" : "click || hover (or false to trigger manually)",
+ "desc" : "Vertical aligns the content in a table row",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
{
"name" : "hide",
"type" : "function",
- "desc" : "After the popover hide",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Popover",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
{
"name" : "show",
"type" : "function",
- "desc" : "After the popover show",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Popover",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
}
]
},
- {
- "name" : "doAlign",
- "type" : "function",
- "desc" : "update the position of the dialog\nnormally this is needed if the popover get's bigger - due to a Table reload etc..",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setContent",
- "type" : "function",
- "desc" : "",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "string",
- "desc" : "body content",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setTitle",
- "type" : "function",
- "desc" : "",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "string",
- "desc" : "title",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
{
"name" : "show",
"type" : "function",
- "desc" : "Show the popover",
- "sig" : "(-, (left|right|top|bottom))",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "-",
- "type" : "Roo.Element|string|Boolean",
- "desc" : "element to align and point to. (set align to [ pos, offset ])",
- "isOptional" : false
- },
- {
- "name" : "(left|right|top|bottom)",
- "type" : "string",
- "desc" : "position",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
}
],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [
+ "Roo.bootstrap.TableCell"
+ ],
+ "tree_parent" : [
+ "Roo.bootstrap.TableBody"
+ ]
+ },
+ "Roo.bootstrap.Tooltip" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "updatePosition",
+ "name" : "currentEl",
"type" : "function",
- "desc" : "fire this manually after loading a grid in the table for example",
- "sig" : "((left|right|top|bottom), try)",
- "static" : false,
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "(left|right|top|bottom)",
- "type" : "string",
- "desc" : "where to try and put it (use false to use the last one)",
- "isOptional" : false
- },
- {
- "name" : "try",
- "type" : "Boolean",
- "desc" : "and move it if we cant get right position.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.Alert",
- "Roo.bootstrap.BezierSignature",
- "Roo.bootstrap.Brick",
- "Roo.bootstrap.Button",
- "Roo.bootstrap.ButtonGroup",
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.Calendar",
- "Roo.bootstrap.Card",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.DocumentManager",
- "Roo.bootstrap.DocumentSlider",
- "Roo.bootstrap.DocumentViewer",
- "Roo.bootstrap.DropTarget",
- "Roo.bootstrap.Element",
- "Roo.bootstrap.Graph",
- "Roo.bootstrap.Header",
- "Roo.bootstrap.Img",
- "Roo.bootstrap.LayoutMasonry",
- "Roo.bootstrap.LayoutMasonryAuto",
- "Roo.bootstrap.Link",
- "Roo.bootstrap.LocationPicker",
- "Roo.bootstrap.MasonryBrick",
- "Roo.bootstrap.MessageBar",
- "Roo.bootstrap.Pagination",
- "Roo.bootstrap.PaginationItem",
- "Roo.bootstrap.PagingToolbar",
- "Roo.bootstrap.PopoverNav",
- "Roo.bootstrap.Progress",
- "Roo.bootstrap.ProgressBar",
- "Roo.bootstrap.Row",
- "Roo.bootstrap.Slider",
- "Roo.bootstrap.TabGroup",
- "Roo.bootstrap.TabPanel",
- "Roo.bootstrap.Table",
- "Roo.bootstrap.UploadCropbox",
- "Roo.bootstrap.breadcrumb.Nav",
- "Roo.bootstrap.dash.NumberBox",
- "Roo.bootstrap.dash.TabBox",
- "Roo.bootstrap.dash.TabPane",
- "Roo.bootstrap.form.CardUploader",
- "Roo.bootstrap.form.CheckBox",
- "Roo.bootstrap.form.ComboBox",
- "Roo.bootstrap.form.DateField",
- "Roo.bootstrap.form.DateSplitField",
- "Roo.bootstrap.form.FieldLabel",
- "Roo.bootstrap.form.Form",
- "Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.Input",
- "Roo.bootstrap.form.Markdown",
- "Roo.bootstrap.form.MoneyField",
- "Roo.bootstrap.form.MonthField",
- "Roo.bootstrap.form.NumberField",
- "Roo.bootstrap.form.Password",
- "Roo.bootstrap.form.PhoneInput",
- "Roo.bootstrap.form.Radio",
- "Roo.bootstrap.form.RadioSet",
- "Roo.bootstrap.form.SecurePass",
- "Roo.bootstrap.form.TextArea",
- "Roo.bootstrap.form.TimeField",
- "Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.nav.Group",
- "Roo.bootstrap.nav.Headerbar",
- "Roo.bootstrap.nav.ProgressBar",
- "Roo.bootstrap.nav.ProgressBarItem",
- "Roo.bootstrap.nav.Sidebar",
- "Roo.bootstrap.nav.SidebarItem",
- "Roo.bootstrap.nav.Simplebar"
- ],
- "tree_parent" : [
- "none",
- "builder"
- ]
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.PopoverNav" : {
+ "Roo.bootstrap.UploadCropbox" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) alignme",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
- "isOptional" : false,
- "optvals" : [
- "left",
- "right"
- ]
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"optvals" : []
},
{
- "name" : "arrangement",
- "type" : "Boolean",
- "desc" : "stacked | justified",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "name" : "buttons",
+ "type" : "Array",
+ "desc" : "default ['rotateLeft', 'pictureBtn', 'rotateRight']",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "emptyText",
+ "type" : "String",
+ "desc" : "show when image has been loaded",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "errorTimeout",
+ "type" : "Number",
+ "desc" : "default 3000",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "hideMode",
"type" : "String",
]
},
{
- "name" : "inverse",
+ "name" : "isDocument",
"type" : "Boolean",
- "desc" : "is inverted color",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "desc" : "e) default fal",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "listeners",
{
"name" : "loadMask",
"type" : "Boolean",
- "desc" : "e) loadMask on the b",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "desc" : "e) default tr",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : [
"true",
]
},
{
- "name" : "main",
+ "name" : "loadingText",
"type" : "Boolean",
- "desc" : "e) main nav bar? default fal",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "desc" : "default 'Loading...'",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
+ "optvals" : []
+ },
+ {
+ "name" : "method",
+ "type" : "String",
+ "desc" : "default POST",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minHeight",
+ "type" : "Number",
+ "desc" : "default 300",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minWidth",
+ "type" : "Number",
+ "desc" : "default 300",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"optvals" : []
},
{
- "name" : "style",
+ "name" : "paramName",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "default 'imageUpload'",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tag",
+ "name" : "rotateNotify",
"type" : "String",
- "desc" : "v) default is n",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "desc" : "show when image too small to rotate",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "header",
- "footer",
- "nav",
- "div"
- ]
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"optvals" : []
},
{
- "name" : "type",
+ "name" : "url",
"type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "desc" : "action url",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "nav",
- "pills",
- "tabs"
- ]
+ "optvals" : []
},
{
"name" : "visibilityEl",
"parent"
]
},
- {
- "name" : "weight",
- "type" : "String",
- "desc" : "e) default is ligh",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
- "isOptional" : false,
- "optvals" : [
- "light",
- "primary",
- "secondary",
- "success",
- "danger",
- "warning",
- "info",
- "dark",
- "white"
- ]
- },
{
"name" : "xattr",
"type" : "Object",
}
],
"events" : [
+ {
+ "name" : "arrange",
+ "type" : "function",
+ "desc" : "Fire when arrange the file data",
+ "sig" : "function (_self, formData)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "formData",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "beforeloadcanvas",
+ "type" : "function",
+ "desc" : "Fire before load the canvas",
+ "sig" : "function (_self, src)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "src",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforerender",
"type" : "function",
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "beforeselectfile",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "desc" : "Fire before select file",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.UploadCropbox",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforetoggle",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Fire before toggle the menu",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.nav.Bar",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "crop",
+ "type" : "function",
+ "desc" : "Fire after initEvent",
+ "sig" : "function (_self, data)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "download",
+ "type" : "function",
+ "desc" : "Fire when download the image",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "enable",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "exception",
+ "type" : "function",
+ "desc" : "Fire when get exception",
+ "sig" : "function (_self, xhr)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "xhr",
+ "type" : "XMLHttpRequest",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "footerbuttonclick",
+ "type" : "function",
+ "desc" : "Fire when footerbuttonclick",
+ "sig" : "function (_self, type)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "type",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "initial",
+ "type" : "function",
+ "desc" : "Fire after initEvent",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "inspect",
+ "type" : "function",
+ "desc" : "Fire when inspect the file",
+ "sig" : "function (_self, file)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "file",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "prepare",
+ "type" : "function",
+ "desc" : "Fire when preparing the file data",
+ "sig" : "function (_self, file)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "file",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "resize",
+ "type" : "function",
+ "desc" : "Fire when resize",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "rotate",
+ "type" : "function",
+ "desc" : "Fire when rotate the image",
+ "sig" : "function (_self, pos)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "pos",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "trash",
+ "type" : "function",
+ "desc" : "Fire when trash image",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "upload",
+ "type" : "function",
+ "desc" : "Fire when xhr upload the file",
+ "sig" : "function (_self, data)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
],
"returns" : []
},
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Collapse the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.nav.Bar",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expand the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.nav.Bar",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "fireEvent",
"type" : "function",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.nav.Group"
- ],
- "tree_parent" : [
- "Roo.bootstrap.Popover"
- ]
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.Progress" : {
+ "Roo.bootstrap.breadcrumb" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.breadcrumb.Item" : {
"props" : [
{
"name" : "actionMode",
{
"name" : "active",
"type" : "Boolean",
- "desc" : "animated of the progress bar",
+ "desc" : "is it active",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"visibility"
]
},
+ {
+ "name" : "href",
+ "type" : "String",
+ "desc" : "where it links to if '#' is used the link will be handled by onClick.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "the content of the link.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "striped",
- "type" : "Boolean",
- "desc" : "striped of the progress bar",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "style",
"type" : "String",
],
"returns" : []
},
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "The img click event for the img.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
"isBuilderTop" : false,
"implementations" : [],
"tree_children" : [
- "Roo.bootstrap.ProgressBar"
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
],
- "tree_parent" : []
+ "tree_parent" : [
+ "Roo.bootstrap.breadcrumb.Nav"
+ ]
},
- "Roo.bootstrap.ProgressBar" : {
+ "Roo.bootstrap.breadcrumb.Nav" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "aria_valuemax",
- "type" : "Number",
- "desc" : "aria-value max",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "aria_valuemin",
- "type" : "Number",
- "desc" : "aria-value min",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "aria_valuenow",
- "type" : "Number",
- "desc" : "aria-value now",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"visibility"
]
},
- {
- "name" : "label",
- "type" : "String",
- "desc" : "label for the progress bar",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "panel",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "success",
- "info",
- "warning",
- "danger"
- ]
- },
- {
- "name" : "role",
- "type" : "String",
- "desc" : "role of the progress bar",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "sr_only",
- "type" : "String",
- "desc" : "text",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "style",
"type" : "String",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
+ "tree_children" : [
+ "Roo.bootstrap.breadcrumb.Item"
+ ],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.dash" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.Row" : {
+ "Roo.bootstrap.dash.NumberBox" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "content",
+ "type" : "String",
+ "desc" : "Box content",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "dataId",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "fhref",
+ "type" : "String",
+ "desc" : "Footer href",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "footer",
+ "type" : "String",
+ "desc" : "Footer text",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "headline",
+ "type" : "String",
+ "desc" : "Box headline",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "hideMode",
"type" : "String",
"visibility"
]
},
+ {
+ "name" : "icon",
+ "type" : "String",
+ "desc" : "Box icon",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.Alert",
- "Roo.bootstrap.BezierSignature",
- "Roo.bootstrap.Brick",
- "Roo.bootstrap.Button",
- "Roo.bootstrap.ButtonGroup",
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.Calendar",
- "Roo.bootstrap.Card",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.DocumentManager",
- "Roo.bootstrap.DocumentSlider",
- "Roo.bootstrap.DocumentViewer",
- "Roo.bootstrap.DropTarget",
- "Roo.bootstrap.Element",
- "Roo.bootstrap.Graph",
- "Roo.bootstrap.Header",
- "Roo.bootstrap.Img",
- "Roo.bootstrap.LayoutMasonry",
- "Roo.bootstrap.LayoutMasonryAuto",
- "Roo.bootstrap.Link",
- "Roo.bootstrap.LocationPicker",
- "Roo.bootstrap.MasonryBrick",
- "Roo.bootstrap.MessageBar",
- "Roo.bootstrap.Pagination",
- "Roo.bootstrap.PaginationItem",
- "Roo.bootstrap.PagingToolbar",
- "Roo.bootstrap.Progress",
- "Roo.bootstrap.ProgressBar",
- "Roo.bootstrap.Row",
- "Roo.bootstrap.Slider",
- "Roo.bootstrap.TabGroup",
- "Roo.bootstrap.TabPanel",
- "Roo.bootstrap.Table",
- "Roo.bootstrap.UploadCropbox",
- "Roo.bootstrap.breadcrumb.Nav",
- "Roo.bootstrap.dash.NumberBox",
- "Roo.bootstrap.dash.TabBox",
- "Roo.bootstrap.dash.TabPane",
- "Roo.bootstrap.form.CardUploader",
- "Roo.bootstrap.form.CheckBox",
- "Roo.bootstrap.form.ComboBox",
- "Roo.bootstrap.form.DateField",
- "Roo.bootstrap.form.DateSplitField",
- "Roo.bootstrap.form.FieldLabel",
- "Roo.bootstrap.form.Form",
- "Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.Input",
- "Roo.bootstrap.form.Markdown",
- "Roo.bootstrap.form.MoneyField",
- "Roo.bootstrap.form.MonthField",
- "Roo.bootstrap.form.NumberField",
- "Roo.bootstrap.form.Password",
- "Roo.bootstrap.form.PhoneInput",
- "Roo.bootstrap.form.Radio",
- "Roo.bootstrap.form.RadioSet",
- "Roo.bootstrap.form.SecurePass",
- "Roo.bootstrap.form.TextArea",
- "Roo.bootstrap.form.TimeField",
- "Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.nav.Group",
- "Roo.bootstrap.nav.Headerbar",
- "Roo.bootstrap.nav.ProgressBar",
- "Roo.bootstrap.nav.ProgressBarItem",
- "Roo.bootstrap.nav.Sidebar",
- "Roo.bootstrap.nav.SidebarItem",
- "Roo.bootstrap.nav.Simplebar"
- ],
+ "tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.Slider" : {
+ "Roo.bootstrap.dash.TabBox" : {
"props" : [
{
"name" : "actionMode",
"visibility"
]
},
+ {
+ "name" : "icon",
+ "type" : "String",
+ "desc" : "Icon of the TabBox",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "showtabs",
+ "type" : "Boolean",
+ "desc" : "e) show the tabs default tr",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "style",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "tabScrollable",
+ "type" : "Boolean",
+ "desc" : "e) tab scrollable when mobile view default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "Title of the TabBox",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tooltip",
"type" : "string",
}
],
"events" : [
+ {
+ "name" : "activatepane",
+ "type" : "function",
+ "desc" : "When a pane is activated",
+ "sig" : "function (pane)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "pane",
+ "type" : "Roo.bootstrap.dash.TabPane",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "addpane",
+ "type" : "function",
+ "desc" : "When a pane is added",
+ "sig" : "function (pane)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "pane",
+ "type" : "Roo.bootstrap.dash.TabPane",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setTitle",
+ "type" : "function",
+ "desc" : "Updates the box title",
+ "sig" : "(html)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "to set the title to.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [],
+ "tree_children" : [
+ "Roo.bootstrap.dash.TabPane"
+ ],
"tree_parent" : []
},
- "Roo.bootstrap.SplitBar" : {
+ "Roo.bootstrap.dash.TabPane" : {
"props" : [
+ {
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "active",
+ "type" : "Boolean",
+ "desc" : "e) Default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "false",
+ "true"
+ ]
+ },
+ {
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
{
"name" : "listeners",
"type" : "Object",
"memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
+ },
+ {
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "title of panel",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
- "name" : "beforeresize",
+ "name" : "activate",
"type" : "function",
- "desc" : "Fires before the splitter is dragged",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "When a pane is activated",
+ "sig" : "function (pane)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "params" : [
+ {
+ "name" : "pane",
+ "type" : "Roo.bootstrap.dash.TabPane",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforedestroy",
+ "type" : "function",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.SplitBar",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "moved",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Fires when the splitter is moved",
- "sig" : "function (_self, newSize)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.SplitBar",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforerender",
+ "type" : "function",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "the new width or height",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resize",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Fires when the splitter is moved (alias for {@link #event-moved})",
- "sig" : "function (_self, newSize)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.SplitBar",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "the new width or height",
+ "name" : "this",
+ "type" : "Roo.bootstrap.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
{
"name" : "destroy",
"type" : "function",
- "desc" : "Destroy this splitbar.",
- "sig" : "(removeEl)",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "removeEl",
- "type" : "Boolean",
- "desc" : "True to remove the element",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "fireEvent",
]
},
{
- "name" : "getAdapter",
+ "name" : "focus",
"type" : "function",
- "desc" : "Get the adapter this SplitBar uses",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "getChildContainer",
+ "type" : "function",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "",
- "desc" : "The adapter object"
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
{
- "name" : "getMaximumSize",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Gets the maximum size for the resizing element",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "The maximum size"
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "getMinimumSize",
+ "name" : "getId",
"type" : "function",
- "desc" : "Gets the minimum size for the resizing element",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "The minimum size"
+ "type" : "String",
+ "desc" : ""
}
]
},
+ {
+ "name" : "getVisibilityEl",
+ "type" : "function",
+ "desc" : "Get the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "hasListener",
"type" : "function",
}
]
},
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Hide a component - adds 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "initEvents",
+ "type" : "function",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
"returns" : []
},
{
- "name" : "setAdapter",
+ "name" : "render",
"type" : "function",
- "desc" : "Set the adapter this SplitBar uses",
- "sig" : "(adapter)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "adapter",
- "type" : "Object",
- "desc" : "A SplitBar adapter object",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setCurrentSize",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Sets the initialize size for the resizing element",
- "sig" : "(size)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "size",
- "type" : "Number",
- "desc" : "The initial size",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setMaximumSize",
+ "name" : "setTitle",
"type" : "function",
- "desc" : "Sets the maximum size for the resizing element",
- "sig" : "(maxSize)",
+ "desc" : "Updates the tab title",
+ "sig" : "(html)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "maxSize",
- "type" : "Number",
- "desc" : "The maximum size",
+ "name" : "html",
+ "type" : "String",
+ "desc" : "to set the title to.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setMinimumSize",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Sets the minimum size for the resizing element",
- "sig" : "(minSize)",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "minSize",
- "type" : "Number",
- "desc" : "The minimum size",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "un",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter" : {
- "props" : [],
- "events" : [],
- "methods" : [
- {
- "name" : "getElementSize",
- "type" : "function",
- "desc" : "Called before drag operations to get the current size of the resizing element.",
- "sig" : "(s)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ "returns" : [
{
- "name" : "s",
- "type" : "Roo.bootstrap.SplitBar",
- "desc" : "The SplitBar using this adapter",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setElementSize",
+ "name" : "show",
"type" : "function",
- "desc" : "Called after drag operations to set the size of the resizing element.",
- "sig" : "(s, newSize, onComplete)",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "s",
- "type" : "Roo.bootstrap.SplitBar",
- "desc" : "The SplitBar using this adapter",
- "isOptional" : false
- },
- {
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new size to set",
- "isOptional" : false
- },
- {
- "name" : "onComplete",
- "type" : "Function",
- "desc" : "A function to be invoked when resizing is complete",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.bootstrap.SplitBar.BasicLayoutAdapter" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "getElementSize",
+ "name" : "tooltipEl",
"type" : "function",
- "desc" : "Called before drag operations to get the current size of the resizing element.",
- "sig" : "(s)",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "s",
- "type" : "Roo.bootstrap.SplitBar",
- "desc" : "The SplitBar using this adapter",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setElementSize",
+ "name" : "un",
"type" : "function",
- "desc" : "Called after drag operations to set the size of the resizing element.",
- "sig" : "(s, newSize, onComplete)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "s",
- "type" : "Roo.bootstrap.SplitBar",
- "desc" : "The SplitBar using this adapter",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new size to set",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "onComplete",
- "type" : "Function",
- "desc" : "A function to be invoked when resizing is complete",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter"
+ "implementations" : [],
+ "tree_children" : [
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.TabGroup"
],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.form" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.TabGroup" : {
+ "Roo.bootstrap.form.CardUploader" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "alert",
- "type" : "String",
- "desc" : "r) type alert (changes background / border..",
- "memberOf" : "Roo.bootstrap.Column",
- "isOptional" : false,
- "optvals" : [
- "success",
- "info",
- "warning",
- "danger"
- ]
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"optvals" : []
},
{
- "name" : "autoslide",
- "type" : "Boolean",
- "desc" : "e) auto slide .. default fal",
- "memberOf" : "",
+ "name" : "badge",
+ "type" : "String",
+ "desc" : "text for badge",
+ "memberOf" : "Roo.bootstrap.Button",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
+ "optvals" : []
},
{
- "name" : "bullets",
- "type" : "Boolean",
- "desc" : "show bullets for the panels",
- "memberOf" : "",
+ "name" : "badge_weight",
+ "type" : "String",
+ "desc" : "k) default (same as butto",
+ "memberOf" : "Roo.bootstrap.Button",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "default",
+ "primary",
+ "secondary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "link",
+ "light",
+ "dark"
+ ]
},
{
"name" : "can_build_overlaid",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "carousel",
- "type" : "Boolean",
- "desc" : "true to make the group behave like a carousel",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "cls",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "default false;",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "errorTimeout",
+ "type" : "Number",
+ "desc" : "default 3000",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "fa",
"type" : "String",
- "desc" : ".) font awesome ic",
- "memberOf" : "Roo.bootstrap.Column",
+ "desc" : "fontawesome icon - eg. 'comment' - without the fa/fas etc..",
+ "memberOf" : "Roo.bootstrap.Button",
"isOptional" : false,
- "optvals" : [
- "ban",
- "check",
- "..."
- ]
+ "optvals" : []
},
{
- "name" : "fasize",
- "type" : "Number",
- "desc" : ".) font awsome si",
- "memberOf" : "Roo.bootstrap.Column",
+ "name" : "glyphicon",
+ "type" : "String",
+ "desc" : "depricated - use fa",
+ "memberOf" : "Roo.bootstrap.Button",
"isOptional" : false,
- "optvals" : [
- "1",
- "2",
- "...."
- ]
+ "optvals" : []
},
{
- "name" : "hidden",
+ "name" : "grpup",
"type" : "Boolean",
- "desc" : "e) hide the eleme",
- "memberOf" : "Roo.bootstrap.Column",
+ "desc" : "if parent is a btn group - then it turns it into a toogleGroup.",
+ "memberOf" : "Roo.bootstrap.Button",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
+ "optvals" : []
},
{
"name" : "hideMode",
]
},
{
- "name" : "html",
+ "name" : "href",
"type" : "String",
- "desc" : "content of column.",
- "memberOf" : "Roo.bootstrap.Column",
+ "desc" : "empty or href",
+ "memberOf" : "Roo.bootstrap.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "icon",
- "type" : "String",
- "desc" : ".) glyphicon na",
- "memberOf" : "Roo.bootstrap.Column",
+ "name" : "html",
+ "type" : "Array",
+ "desc" : "The button text.",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "info-sign",
- "check",
- "..."
- ]
+ "optvals" : []
},
{
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column",
+ "name" : "images",
+ "type" : "Array",
+ "desc" : "an array of ?? Img objects ??? when loading existing files..",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "lgoff",
- "type" : "Number",
- "desc" : "colspan offset out of 12 for large computer-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column",
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "dark themed version",
+ "memberOf" : "Roo.bootstrap.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
+ "name" : "isClose",
+ "type" : "Boolean",
+ "desc" : "default false;",
+ "memberOf" : "Roo.bootstrap.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "mdoff",
- "type" : "Number",
- "desc" : "colspan offset out of 12 for computer-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column",
+ "name" : "menu",
+ "type" : "Roo.bootstrap.menu.Menu",
+ "desc" : "a Menu",
+ "memberOf" : "Roo.bootstrap.Button",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "navId",
+ "name" : "offtext",
"type" : "String",
- "desc" : "the navigation id (for use with navbars) - will be auto generated if it does not exist..",
- "memberOf" : "",
+ "desc" : "text for off slidy toggle state",
+ "memberOf" : "Roo.bootstrap.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "showarrow",
+ "name" : "ontext",
+ "type" : "String",
+ "desc" : "text for on slidy toggle state",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "outline",
"type" : "Boolean",
- "desc" : "e) show arrow default tr",
- "memberOf" : "",
+ "desc" : "default false (except for weight=default which emulates old behaveiour with an outline)",
+ "memberOf" : "Roo.bootstrap.Button",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
+ "optvals" : []
},
{
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column",
+ "name" : "pressed",
+ "type" : "Boolean",
+ "desc" : "default null - if the button ahs active state",
+ "memberOf" : "Roo.bootstrap.Button",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "smoff",
- "type" : "Number",
- "desc" : "colspan offset out of 12 for tablet-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column",
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "default true (stop click event triggering the URL if it's a link.)",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "removeClass",
+ "type" : "Boolean",
+ "desc" : "remove the standard class..",
+ "memberOf" : "Roo.bootstrap.Button",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "size",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : [
+ "lg",
+ "sm",
+ "xs"
+ ]
+ },
{
"name" : "style",
"type" : "String",
"optvals" : []
},
{
- "name" : "timer",
- "type" : "Number",
- "desc" : "auto slide timer .. default 0 millisecond",
- "memberOf" : "",
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : [
+ "a",
+ "input",
+ "submit"
+ ]
+ },
+ {
+ "name" : "target",
+ "type" : "String",
+ "desc" : "r) target for a hre",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : [
+ "_self",
+ "_blank",
+ "_parent",
+ "_top",
+ "other"
+ ]
+ },
+ {
+ "name" : "theme",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : [
+ "default",
+ "glow"
+ ]
+ },
+ {
+ "name" : "toggle",
+ "type" : "Boolean",
+ "desc" : "is it a slidy toggle button",
+ "memberOf" : "Roo.bootstrap.Button",
"isOptional" : false,
"optvals" : []
},
"parent"
]
},
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "k) defau",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : [
+ "default",
+ "primary",
+ "secondary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "link",
+ "light",
+ "dark"
+ ]
+ },
{
"name" : "xattr",
"type" : "Object",
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "xsoff",
- "type" : "Number",
- "desc" : "colspan offset out of 12 for mobile-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column",
- "isOptional" : false,
- "optvals" : []
}
],
"events" : [
],
"returns" : []
},
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "When a button is pressed",
+ "sig" : "function (btn, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Button",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "btn",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "dblclick",
+ "type" : "function",
+ "desc" : "When a button is double clicked",
+ "sig" : "function (btn, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Button",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "btn",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "download",
+ "type" : "function",
+ "desc" : "When a the download link is clicked",
+ "sig" : "function (_self, The)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Card",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "The",
+ "type" : "Object",
+ "desc" : "image information data contains",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "enable",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "preview",
+ "type" : "function",
+ "desc" : "When a image is clicked on - and needs to display a slideshow or similar..",
+ "sig" : "function (_self, The)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Card",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "The",
+ "type" : "Object",
+ "desc" : "image information data",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "toggle",
+ "type" : "function",
+ "desc" : "After the button has been toggles",
+ "sig" : "function (btn, e, pressed)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Button",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "btn",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "pressed",
+ "type" : "boolean",
+ "desc" : "(also available as button.pressed)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
+ {
+ "name" : "addCard",
+ "type" : "function",
+ "desc" : "addCard - add an Attachment to the uploader",
+ "sig" : "(data)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "data",
+ "type" : "",
+ "desc" : "- the data about the image to upload\n\n{\n id : 123\n title : \"Title of file\",\n is_uploaded : false,\n src : \"http://.....\",\n srcfile : { the File upload object },\n mimetype : file.type,\n preview : false,\n is_deleted : 0\n .. any other data...\n }",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "addEvents",
"type" : "function",
{
"name" : "disable",
"type" : "function",
- "desc" : "Disable this component.",
+ "desc" : "Disable this button",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
"name" : "enable",
"type" : "function",
- "desc" : "Enable this component.",
+ "desc" : "Enables this button",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
"name" : "fireEvent",
}
]
},
- {
- "name" : "get",
- "type" : "function",
- "desc" : "fetch a Navigation Group based on the navigation ID\nif one does not exist , it will get created.",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "string",
- "desc" : "navgroup to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "getChildContainer",
"type" : "function",
}
]
},
+ {
+ "name" : "getText",
+ "type" : "function",
+ "desc" : "get the text of the first selected button",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Button",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "isActive",
+ "type" : "function",
+ "desc" : "get the current active state",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Button",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "boolean",
+ "desc" : "true if it's active"
+ }
+ ]
+ },
{
"name" : "isVisible",
"type" : "function",
"returns" : []
},
{
- "name" : "register",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "register a Navigation item",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "the",
- "type" : "Roo.bootstrap.nav.Item",
- "desc" : "navitem to add",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "register",
- "type" : "function",
- "desc" : "register a Navigation Group",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.nav.Group",
- "desc" : "navgroup to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "removeListener",
+ "name" : "removeListener",
"type" : "function",
"desc" : "Removes a listener",
"sig" : "(eventName, handler, scope)",
],
"returns" : []
},
+ {
+ "name" : "setActive",
+ "type" : "function",
+ "desc" : "sets the active state on/off,",
+ "sig" : "(state)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Button",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "(optional) Force a particular state",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setText",
+ "type" : "function",
+ "desc" : "set the text of the first selected button",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Button",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
"returns" : []
},
{
- "name" : "showPanel",
+ "name" : "toggleActive",
"type" : "function",
- "desc" : "show a specific panel",
- "sig" : "(panel)",
+ "desc" : "toggles the current active state",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Roo.bootstrap.TabPanel|number|string",
- "desc" : "to change to (use the tabId to specify a specific one)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "boolean",
- "desc" : "false if panel was not shown (invalid entry or beforedeactivate fails.)"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
"name" : "tooltipEl",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.TabPanel"
- ],
+ "tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.TabPanel" : {
+ "Roo.bootstrap.form.CheckBox" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
+ },
{
"name" : "actionMode",
"type" : "String",
"optvals" : []
},
{
- "name" : "active",
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ {
+ "name" : "allowBlank",
"type" : "Boolean",
- "desc" : "panel active",
- "memberOf" : "",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "autocomplete",
+ "type" : "String",
+ "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "boxLabel",
+ "type" : "String",
+ "desc" : "The text that appears beside the checkbox",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "user",
+ "camera"
+ ]
+ },
+ {
+ "name" : "checked",
+ "type" : "Boolean",
+ "desc" : "initnal the element",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "cls",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default fal",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "groupId",
+ "type" : "String",
+ "desc" : "the checkbox group id // normal just use for checkbox",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default tr",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "hideMode",
"type" : "String",
]
},
{
- "name" : "href",
+ "name" : "indicatorpos",
"type" : "String",
- "desc" : "click to link..",
+ "desc" : "t) default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
+ },
+ {
+ "name" : "inline",
+ "type" : "Boolean",
+ "desc" : "inline the element (default false)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "html",
+ "name" : "inputType",
"type" : "String",
- "desc" : "panel content",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "button",
+ "checkbox",
+ "email",
+ "file",
+ "hidden",
+ "image",
+ "number",
+ "password",
+ "radio",
+ "range",
+ "reset",
+ "search",
+ "submit",
+ "text"
+ ]
+ },
+ {
+ "name" : "inputValue",
+ "type" : "String",
+ "desc" : "The value that should go into the generated input element's value when checked.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "left"
+ ]
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "placeholder",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "navId",
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regexText",
"type" : "String",
- "desc" : "The Roo.bootstrap.nav.Group which triggers show hide ()",
- "memberOf" : "",
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "tabId",
+ "name" : "tooltip",
"type" : "String",
- "desc" : "unique tab ID (will be autogenerated if not set. - used to match TabItem to Panel)",
+ "desc" : "label tooltip",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "touchSlide",
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validateOnBlur",
"type" : "Boolean",
- "desc" : "if swiping slides tab to next panel (default off)",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "valueOff",
+ "type" : "String",
+ "desc" : "The value that should go into the generated input element's value when unchecked.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"parent"
]
},
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "s) The text that appears beside the checkb",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "primary",
+ "warning",
+ "info",
+ "danger",
+ "success"
+ ]
+ },
{
"name" : "xattr",
"type" : "Object",
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
- "name" : "beforedeactivate",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fires before a tab is de-activated - can be used to do validation on a form.",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.TabPanel",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "false if there is an error"
- }
- ]
+ "returns" : []
},
{
- "name" : "beforedestroy",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "beforehide",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "blur",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "desc" : "Fires when this field loses input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "changed",
+ "name" : "change",
"type" : "function",
- "desc" : "Fires when the active status changes",
- "sig" : "function (_self, state)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.TabPanel",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
},
{
- "name" : "state",
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "check",
+ "type" : "function",
+ "desc" : "Fires when the element is checked or unchecked.",
+ "sig" : "function (_self, checked)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.CheckBox",
+ "desc" : "This input",
+ "isOptional" : false
+ },
+ {
+ "name" : "checked",
"type" : "Boolean",
- "desc" : "the new state",
+ "desc" : "The new checked value",
"isOptional" : false
}
],
],
"returns" : []
},
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "Fires when the element is click.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.CheckBox",
+ "desc" : "This input",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "paste",
+ "type" : "function",
+ "desc" : "Fires after the user pastes into input",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "get",
+ "type" : "function",
+ "desc" : "fetch a CheckBox Group based on the group ID",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "string",
+ "desc" : "group ID",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "name The name field"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "isVisible",
"type" : "function",
"returns" : []
},
{
- "name" : "on",
+ "name" : "markInvalid",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "on",
+ "type" : "function",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
"type" : "String",
"desc" : "The type of event to listen for",
"isOptional" : false
"params" : [],
"returns" : []
},
+ {
+ "name" : "register",
+ "type" : "function",
+ "desc" : "register a CheckBox Group",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "Roo.bootstrap.form.CheckBox",
+ "desc" : "CheckBox to add",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "releaseCapture",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.Alert",
- "Roo.bootstrap.BezierSignature",
- "Roo.bootstrap.Brick",
- "Roo.bootstrap.Button",
- "Roo.bootstrap.ButtonGroup",
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.Calendar",
- "Roo.bootstrap.Card",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.DocumentManager",
- "Roo.bootstrap.DocumentSlider",
- "Roo.bootstrap.DocumentViewer",
- "Roo.bootstrap.DropTarget",
- "Roo.bootstrap.Element",
- "Roo.bootstrap.Graph",
- "Roo.bootstrap.Header",
- "Roo.bootstrap.Img",
- "Roo.bootstrap.LayoutMasonry",
- "Roo.bootstrap.LayoutMasonryAuto",
- "Roo.bootstrap.Link",
- "Roo.bootstrap.LocationPicker",
- "Roo.bootstrap.MasonryBrick",
- "Roo.bootstrap.MessageBar",
- "Roo.bootstrap.Pagination",
- "Roo.bootstrap.PaginationItem",
- "Roo.bootstrap.PagingToolbar",
- "Roo.bootstrap.Progress",
- "Roo.bootstrap.ProgressBar",
- "Roo.bootstrap.Row",
- "Roo.bootstrap.Slider",
- "Roo.bootstrap.TabGroup",
- "Roo.bootstrap.TabPanel",
- "Roo.bootstrap.Table",
- "Roo.bootstrap.UploadCropbox",
- "Roo.bootstrap.breadcrumb.Nav",
- "Roo.bootstrap.dash.NumberBox",
- "Roo.bootstrap.dash.TabBox",
- "Roo.bootstrap.dash.TabPane",
- "Roo.bootstrap.form.CardUploader",
- "Roo.bootstrap.form.CheckBox",
- "Roo.bootstrap.form.ComboBox",
- "Roo.bootstrap.form.DateField",
- "Roo.bootstrap.form.DateSplitField",
- "Roo.bootstrap.form.FieldLabel",
- "Roo.bootstrap.form.Form",
- "Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.Input",
- "Roo.bootstrap.form.Markdown",
- "Roo.bootstrap.form.MoneyField",
- "Roo.bootstrap.form.MonthField",
- "Roo.bootstrap.form.NumberField",
- "Roo.bootstrap.form.Password",
- "Roo.bootstrap.form.PhoneInput",
- "Roo.bootstrap.form.Radio",
- "Roo.bootstrap.form.RadioSet",
- "Roo.bootstrap.form.SecurePass",
- "Roo.bootstrap.form.TextArea",
- "Roo.bootstrap.form.TimeField",
- "Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.nav.Group",
- "Roo.bootstrap.nav.Headerbar",
- "Roo.bootstrap.nav.ProgressBar",
- "Roo.bootstrap.nav.ProgressBarItem",
- "Roo.bootstrap.nav.Sidebar",
- "Roo.bootstrap.nav.SidebarItem",
- "Roo.bootstrap.nav.Simplebar"
- ],
+ "tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.Table" : {
+ "Roo.bootstrap.form.ComboBox" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
+ },
{
"name" : "actionMode",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ {
+ "name" : "allQuery",
+ "type" : "String",
+ "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"optvals" : []
},
{
- "name" : "auto_hide_footer",
+ "name" : "alwaysQuery",
"type" : "Boolean",
- "desc" : "auto hide footer if only one page (default false)",
+ "desc" : "Disable caching of results, and always send query",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "bordered",
- "type" : "boolean",
- "desc" : "Add borders to the table",
+ "name" : "animate",
+ "type" : "Boolean",
+ "desc" : "default true",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "can_build_overlaid",
+ "name" : "append",
"type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "autoCreate",
+ "type" : "Boolean/Object",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "cellSelection",
+ "name" : "autoFocus",
"type" : "Boolean",
- "desc" : "e) default fal",
+ "desc" : "e) auto focus the first item, default tr",
"memberOf" : "",
"isOptional" : false,
"optvals" : [
]
},
{
- "name" : "cls",
+ "name" : "autocomplete",
"type" : "String",
- "desc" : "table class",
- "memberOf" : "",
+ "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "cm[]",
- "type" : "Roo.grid.ColumnModel",
- "desc" : "A column for the grid.",
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "blockFocus",
+ "type" : "Boolean",
+ "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "condensed",
- "type" : "boolean",
- "desc" : "Format condensed",
+ "name" : "btnPosition",
+ "type" : "String",
+ "desc" : "set the position of the trigger button (left | right) default right",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "user",
+ "camera"
+ ]
+ },
+ {
+ "name" : "caret",
+ "type" : "String",
+ "desc" : "r) BS3 only - carat fa na",
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : [
+ "search",
+ "calendar"
+ ]
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "container_method",
"type" : "string",
"optvals" : []
},
{
- "name" : "disableAutoSize",
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClear",
"type" : "Boolean",
- "desc" : "disable autoSize() and initCSS()",
+ "desc" : "Disable showing of clear button.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disableClass",
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "displayField",
"type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
+ "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "empty_results",
- "type" : "string",
- "desc" : "Text to display for no results",
+ "name" : "editable",
+ "type" : "Boolean",
+ "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "enableColumnResize",
+ "name" : "emptyResultText",
"type" : "Boolean",
- "desc" : "default true if columns can be resized = needs scrollBody to be set to work (drag/drop)",
+ "desc" : "only for touch device",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "footer",
- "type" : "Roo.bootstrap.PagingToolbar",
- "desc" : "a paging toolbar",
+ "name" : "emptyTitle",
+ "type" : "String",
+ "desc" : "default ''",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "footerRow",
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "forceFeedback",
"type" : "Boolean",
- "desc" : "e) generate tfoot with columns of values, default fal",
- "memberOf" : "",
+ "desc" : "e) Default fal",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : [
"true",
]
},
{
- "name" : "footerShow",
+ "name" : "forceSelection",
"type" : "Boolean",
- "desc" : "e) generate tfoot, default tr",
+ "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
"memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
+ "optvals" : []
},
{
- "name" : "headerShow",
+ "name" : "grow",
"type" : "Boolean",
- "desc" : "e) generate thead, default tr",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMax",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "handleHeight",
+ "type" : "Number",
+ "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
"memberOf" : "",
"isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default tr",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
"optvals" : [
"true",
"false"
]
},
+ {
+ "name" : "hiddenName",
+ "type" : "String",
+ "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "hideMode",
"type" : "String",
]
},
{
- "name" : "hover",
- "type" : "boolean",
- "desc" : "Add hover highlighting",
+ "name" : "hideTrigger",
+ "type" : "Boolean",
+ "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "button",
+ "checkbox",
+ "email",
+ "file",
+ "hidden",
+ "image",
+ "number",
+ "password",
+ "radio",
+ "range",
+ "reset",
+ "search",
+ "submit",
+ "text"
+ ]
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - uses BS4 is-valid now",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "lazyLoad",
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "left"
+ ]
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "lazyRender",
"type" : "Boolean",
- "desc" : "auto load data while scrolling to the end (default false)",
+ "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listAlign",
+ "type" : "String",
+ "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listWidth",
+ "type" : "Number",
+ "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"optvals" : []
},
{
- "name" : "loadMask",
- "type" : "Boolean",
- "desc" : "e) default fal",
+ "name" : "loadingText",
+ "type" : "String",
+ "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
"memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
+ "optvals" : []
},
{
- "name" : "minColumnWidth",
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxHeight",
"type" : "Number",
- "desc" : "default 50 pixels minimum column width",
+ "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "responsive",
- "type" : "boolean",
- "desc" : "default false - if this is on, columns are rendered with col-xs-4 etc. classes, otherwise columns will be sized by CSS,\n also adds table-responsive (see bootstrap docs for details)",
+ "name" : "maxLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minChars",
+ "type" : "Number",
+ "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "rowSelection",
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minListWidth",
+ "type" : "Number",
+ "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "mobileTouchView",
"type" : "Boolean",
- "desc" : "e) default fal",
+ "desc" : "e) show mobile touch view when using a mobile default tr",
"memberOf" : "",
"isOptional" : false,
"optvals" : [
]
},
{
- "name" : "scrollBody",
+ "name" : "mobile_restrict_height",
"type" : "Boolean",
- "desc" : "e) default false - body scrolled / fixed header (with resizable column",
+ "desc" : "e) restrict height for touch vi",
"memberOf" : "",
"isOptional" : false,
"optvals" : [
]
},
{
- "name" : "sm",
- "type" : "Roo.grid.AbstractSelectionModel",
- "desc" : "The selection model to use (cell selection is not supported yet)",
+ "name" : "modalTitle",
+ "type" : "String",
+ "desc" : "The title of the dialog that pops up on mobile views.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to use",
+ "name" : "mode",
+ "type" : "String",
+ "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "striped",
- "type" : "boolean",
- "desc" : "Should the rows be alternative striped",
+ "name" : "multiple",
+ "type" : "Boolean",
+ "desc" : "e) ComboBobArray, default fal",
"memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "style",
+ "name" : "name",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tooltip",
+ "name" : "pageSize",
+ "type" : "Number",
+ "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "placeholder",
"type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
- "optvals" : [
- "el",
- "parent"
- ]
+ "optvals" : []
},
{
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "queryDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
- }
- ],
- "events" : [
+ },
{
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "queryParam",
+ "type" : "String",
+ "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "cellclick",
- "type" : "function",
- "desc" : "Fires when a cell is clicked",
- "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
+ "name" : "removable",
+ "type" : "Boolean",
+ "desc" : "e) special filter default fal",
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "resizable",
+ "type" : "Boolean",
+ "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
"memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "el",
- "type" : "Roo.Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "cellcontextmenu",
- "type" : "function",
- "desc" : "Fires when a cell is right clicked",
- "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
"memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "selectedClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "shadow",
+ "type" : "Boolean/String",
+ "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "showToggleBtn",
+ "type" : "Boolean",
+ "desc" : "show toggle button or not (true|false) default true",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "specialFilter",
+ "type" : "Boolean",
+ "desc" : "e) special filter default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to which this combo is bound (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tickable",
+ "type" : "Boolean",
+ "desc" : "ComboBox with tickable selections (true|false), default false",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tpl",
+ "type" : "String/Roo.Template",
+ "desc" : "The template to use to render the output default is '<a class=\"dropdown-item\" href=\"#\">{' + this.displayField + '}</a>'",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "triggerAction",
+ "type" : "String",
+ "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "triggerClass",
+ "type" : "String",
+ "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "triggerList",
+ "type" : "Boolean",
+ "desc" : "trigger show the list or not (true|false) default true",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "triggerText",
+ "type" : "String",
+ "desc" : "multiple combobox trigger button text default 'Select'",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "typeAhead",
+ "type" : "Boolean",
+ "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "typeAheadDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "useNativeIOS",
+ "type" : "Boolean",
+ "desc" : "e) render it as classic select for ios, not support dynamic load data (default fals",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - uses BS4 is-valid now",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "valueField",
+ "type" : "String",
+ "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "valueNotFoundText",
+ "type" : "String",
+ "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "fixed with? experimental",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "add",
+ "type" : "function",
+ "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "afterremove",
+ "type" : "function",
+ "desc" : "Fires when the remove value from the combobox array",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforedestroy",
+ "type" : "function",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Table",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforehide",
+ "type" : "function",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "rowIndex",
- "type" : "Number",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforequery",
+ "type" : "function",
+ "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
+ "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
},
{
- "name" : "cellIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "query",
+ "type" : "String",
+ "desc" : "The query",
+ "isOptional" : false
+ },
+ {
+ "name" : "forceAll",
+ "type" : "Boolean",
+ "desc" : "true to force \"all\" query",
+ "isOptional" : false
+ },
+ {
+ "name" : "cancel",
+ "type" : "Boolean",
+ "desc" : "true to cancel the query",
"isOptional" : false
},
{
"name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "type" : "Object",
+ "desc" : "The query event object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "celldblclick",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires when a cell is double clicked",
- "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Table",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeselect",
+ "type" : "function",
+ "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
+ "sig" : "function (combo, record, index)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
},
{
- "name" : "el",
- "type" : "Roo.Element",
- "desc" : "",
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The data record returned from the underlying store",
"isOptional" : false
},
{
- "name" : "rowIndex",
+ "name" : "index",
"type" : "Number",
+ "desc" : "The index of the selected item in the dropdown list",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "columnIndex",
- "type" : "Number",
+ "name" : "this",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
}
],
"returns" : []
"returns" : []
},
{
- "name" : "contextmenu",
+ "name" : "collapse",
"type" : "function",
- "desc" : "The raw contextmenu event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
+ "desc" : "Fires when the dropdown list is collapsed",
+ "sig" : "function (combo)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
}
],
],
"returns" : []
},
+ {
+ "name" : "edit",
+ "type" : "function",
+ "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo, record)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record|false",
+ "desc" : "The data record returned from the underlying store (or false on nothing selected)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "enable",
"type" : "function",
"returns" : []
},
{
- "name" : "headercontextmenu",
+ "name" : "expand",
"type" : "function",
- "desc" : "Fires when a header is right clicked",
- "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "desc" : "Fires when the dropdown list is expanded",
+ "sig" : "function (combo)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "mousedown",
+ "name" : "invalid",
"type" : "function",
- "desc" : "The raw mousedown event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "mouseout",
+ "name" : "keyup",
"type" : "function",
- "desc" : "Fires when a mouseout occur",
- "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "el",
- "type" : "Roo.Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
},
{
"name" : "e",
"type" : "Roo.EventObject",
- "desc" : "",
+ "desc" : "The event Object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "mouseover",
+ "name" : "paste",
"type" : "function",
- "desc" : "Fires when a mouseover occur",
- "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the user pastes into input",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "el",
- "type" : "Roo.Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
},
{
"name" : "e",
"type" : "Roo.EventObject",
- "desc" : "",
+ "desc" : "The event Object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "remove",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when the remove value from the combobox array",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "rowclass",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires when a row is rendered, so you can change add a style to it.",
- "sig" : "function (_self, rowcfg)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Table",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "rowcfg",
- "type" : "Object",
- "desc" : "contains record rowIndex colIndex and rowClass - set rowClass to add a style.",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "rowclick",
+ "name" : "select",
"type" : "function",
- "desc" : "Fires when a row is clicked",
- "sig" : "function (_self, el, rowIndex, e)\n{\n\n}",
+ "desc" : "Fires when a list item is selected",
+ "sig" : "function (combo, record, index)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
},
{
- "name" : "el",
- "type" : "Roo.Element",
- "desc" : "",
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The data record returned from the underlying store (or false on clear)",
"isOptional" : false
},
{
- "name" : "rowIndex",
+ "name" : "index",
"type" : "Number",
- "desc" : "",
+ "desc" : "The index of the selected item in the dropdown list",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "rowcontextmenu",
+ "name" : "specialfilter",
"type" : "function",
- "desc" : "Fires when a row is right clicked",
- "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "desc" : "Fires when specialfilter",
+ "sig" : "function (combo)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "rowIndex",
- "type" : "Number",
+ "name" : "this",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
},
{
"name" : "e",
"type" : "Roo.EventObject",
- "desc" : "",
+ "desc" : "The event object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "rowdblclick",
+ "name" : "tick",
"type" : "function",
- "desc" : "Fires when a row is double clicked",
- "sig" : "function (_self, el, rowIndex, e)\n{\n\n}",
+ "desc" : "Fires when tick the element",
+ "sig" : "function (combo)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "el",
- "type" : "Roo.Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "rowsrendered",
+ "name" : "touchviewdisplay",
"type" : "function",
- "desc" : "Fires when all the rows have been rendered",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Fires when touch view require special display (default is using displayField)",
+ "sig" : "function (combo, cfg)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "cfg",
+ "type" : "Object",
+ "desc" : "set html .",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "valid",
"type" : "function",
- "desc" : "Fires after the component is shown.",
+ "desc" : "Fires after the field has been validated with no errors.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
{
"name" : "autoSize",
"type" : "function",
- "desc" : "Forces a resize - used by panel.Grid",
+ "desc" : "",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Element",
- "desc" : "The element"
- }
- ]
+ "returns" : []
},
{
"name" : "capture",
"returns" : []
},
{
- "name" : "clear",
+ "name" : "clearInvalid",
"type" : "function",
- "desc" : "Remove all rows",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "clearValue",
+ "type" : "function",
+ "desc" : "Clears any text/value currently set in the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
}
]
},
+ {
+ "name" : "doQuery",
+ "type" : "function",
+ "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
+ "sig" : "(query, forceAll)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "query",
+ "type" : "String",
+ "desc" : "The SQL query to execute",
+ "isOptional" : false
+ },
+ {
+ "name" : "forceAll",
+ "type" : "Boolean",
+ "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "enable",
"type" : "function",
]
},
{
- "name" : "ensureVisible",
+ "name" : "expand",
"type" : "function",
- "desc" : "Scrolls the specified cell into view",
- "sig" : "(row, col, hscroll)",
+ "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "row",
- "type" : "Number",
- "desc" : "The row index",
- "isOptional" : false
- },
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "hscroll",
- "type" : "Boolean",
- "desc" : "false to disable horizontal scrolling",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
]
},
{
- "name" : "focusCell",
- "type" : "function",
- "desc" : "Focuses the specified cell.",
- "sig" : "(row, col, hscroll)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "row",
- "type" : "Number",
- "desc" : "The row index",
- "isOptional" : false
- },
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "hscroll",
- "type" : "Boolean",
- "desc" : "false to disable horizontal scrolling",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "focusRow",
- "type" : "function",
- "desc" : "Focuses the specified row.",
- "sig" : "(row)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "row",
- "type" : "Number",
- "desc" : "The row index",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "getCellIndex",
+ "name" : "getAutoCreateLabel",
"type" : "function",
- "desc" : "get the Column Index from a dom element. (using regex on x-hcol-{colid})",
- "sig" : "(cell)",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "cell",
- "type" : "domElement",
- "desc" : "to look for",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
]
},
{
- "name" : "getGridEl",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns the grid's underlying element = used by panel.Grid",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Element",
- "desc" : "The element"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getHeaderIndex",
+ "name" : "getName",
"type" : "function",
- "desc" : "get the header TH element for columnIndex",
- "sig" : "(columnIndex)",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "name The name field"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "getId",
+ "name" : "getRawValue",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
]
},
{
- "name" : "getRowIndex",
+ "name" : "getValue",
"type" : "function",
- "desc" : "get the Row Index from a dom element.",
- "sig" : "(row)",
+ "desc" : "Returns the currently selected field value or empty string if no value is set.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "row",
- "type" : "Roo.Element",
- "desc" : "The row to look for",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "value The selected value"
}
- ],
- "returns" : []
+ ]
},
{
"name" : "getVisibilityEl",
"params" : [],
"returns" : []
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isExpanded",
+ "type" : "function",
+ "desc" : "Returns true if the dropdown list is expanded, else false.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "onTriggerClick",
+ "type" : "function",
+ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "purgeListeners",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(index, scrollIntoView)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The zero-based index of the list item to select",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollIntoView",
+ "type" : "Boolean",
+ "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "selectByValue",
+ "type" : "function",
+ "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(value, scrollIntoView)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The data value of the item to select",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollIntoView",
+ "type" : "Boolean",
+ "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value matched an item in the list, else false"
+ }
+ ]
+ },
{
"name" : "setDisabled",
"type" : "function",
"returns" : []
},
{
- "name" : "setRowVisibility",
+ "name" : "setEditable",
"type" : "function",
- "desc" : "Show or hide a row.",
- "sig" : "(rowIndex, state)",
+ "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
+ "sig" : "(value)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "to show or hide",
+ "name" : "value",
+ "type" : "Boolean",
+ "desc" : "True to allow the user to directly edit the field text",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setFromData",
+ "type" : "function",
+ "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "state",
- "type" : "Boolean",
- "desc" : "hide",
+ "name" : "value",
+ "type" : "Object",
+ "desc" : "the value to set as. or false on reset?",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The value to match",
"isOptional" : false
}
],
}
],
"returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.TableBody"
+ "implementations" : [
+ "Roo.bootstrap.form.MoneyField"
],
+ "tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.TableBody" : {
+ "Roo.bootstrap.form.DateField" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
+ },
{
"name" : "actionMode",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "align",
"type" : "String",
- "desc" : "Aligns the content inside the element",
- "memberOf" : "",
+ "desc" : "t) Default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "autocomplete",
+ "type" : "String",
+ "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "calendarWeeks",
+ "type" : "Boolean",
+ "desc" : "default false",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"optvals" : []
},
{
- "name" : "charoff",
- "type" : "Number",
- "desc" : "Sets the number of characters the content inside the element will be aligned from the character specified by the char attribute",
- "memberOf" : "",
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "user",
+ "camera"
+ ]
},
{
"name" : "cls",
"type" : "String",
- "desc" : "element class",
- "memberOf" : "",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "daysOfWeekDisabled",
+ "type" : "Object",
+ "desc" : "default empty",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "disableClass",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "endDate",
+ "type" : "Number",
+ "desc" : "default Infinity",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default fal",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "format",
+ "type" : "String",
+ "desc" : "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default tr",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "hideMode",
"type" : "String",
"visibility"
]
},
+ {
+ "name" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "button",
+ "checkbox",
+ "email",
+ "file",
+ "hidden",
+ "image",
+ "number",
+ "password",
+ "radio",
+ "range",
+ "reset",
+ "search",
+ "submit",
+ "text"
+ ]
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "keyboardNavigation",
+ "type" : "Boolean",
+ "desc" : "default true",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "left"
+ ]
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "language",
+ "type" : "String",
+ "desc" : "default en",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minViewMode",
+ "type" : "String",
+ "desc" : "default empty, (months|years)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "placeholder",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "singleMode",
+ "type" : "Boolean",
+ "desc" : "default false (true | false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "startDate",
+ "type" : "Number",
+ "desc" : "default -Infinity",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "tag",
- "type" : "String",
- "desc" : "element tag (thead|tbody|tfoot) default tbody",
+ "name" : "todayBtn",
+ "type" : "Boolean",
+ "desc" : "default false",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "todayHighlight",
+ "type" : "Boolean",
+ "desc" : "default false",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"optvals" : []
},
{
- "name" : "valign",
+ "name" : "validClass",
"type" : "String",
- "desc" : "Vertical aligns the content inside the <tbody> element",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "viewMode",
+ "type" : "String",
+ "desc" : "default empty, (months|years)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"parent"
]
},
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "weekStart",
+ "type" : "Number",
+ "desc" : "default 0",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "xattr",
"type" : "Object",
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "beforeselect",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when before select a date.",
+ "sig" : "function (_self, date)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.form.DateField",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "date",
+ "type" : "Mixed",
+ "desc" : "The date value",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "blur",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
+ "desc" : "Fires when this field loses input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "disable",
+ "name" : "change",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enable",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
+ "desc" : "Fires when the children have been rendered..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "hide",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires after the component is destroyed.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "render",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
+ "desc" : "Fires after the component is disabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "show",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires after the component is shown.",
+ "desc" : "Fires after the component is enabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "paste",
+ "type" : "function",
+ "desc" : "Fires after the user pastes into input",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "Fires when select a date.",
+ "sig" : "function (_self, date)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.DateField",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "date",
+ "type" : "Mixed",
+ "desc" : "The date value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires when this field show.",
+ "sig" : "function (_self, date)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.DateField",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "date",
+ "type" : "Mixed",
+ "desc" : "The date value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
{
"name" : "addEvents",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "name The name field"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.TableRow"
- ],
- "tree_parent" : [
- "Roo.bootstrap.Table"
- ]
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.TableCell" : {
+ "Roo.bootstrap.form.DateSplitField" : {
"props" : [
- {
- "name" : "abbr",
- "type" : "String",
- "desc" : "Specifies an abbreviated version of the content in a cell",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "actionMode",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "align",
- "type" : "String",
- "desc" : "Aligns the content in a cell",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"optvals" : []
},
{
- "name" : "axis",
- "type" : "String",
- "desc" : "Categorizes cells",
- "memberOf" : "",
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "bgcolor",
+ "name" : "cls",
"type" : "String",
- "desc" : "Specifies the background color of a cell",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
+ "desc" : "css class",
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "charoff",
- "type" : "Number",
- "desc" : "Sets the number of characters the content will be aligned from the character specified by the char attribute",
- "memberOf" : "",
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "cls",
- "type" : "String",
- "desc" : "cell class",
- "memberOf" : "",
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "colspan",
- "type" : "Number",
- "desc" : "Specifies the number of columns a cell should span",
+ "name" : "dayAllowBlank",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
"memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "container_method",
+ "name" : "dayFormat",
"type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "default 'd'",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "dataId",
+ "name" : "dayPlaceholder",
"type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "headers",
- "type" : "String",
- "desc" : "Specifies one or more header cells a cell is related to",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "Sets the height of a cell",
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
]
},
{
- "name" : "html",
+ "name" : "labelAlign",
"type" : "String",
- "desc" : "cell contain text",
+ "desc" : "",
"memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "top",
+ "left"
+ ]
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label (0-12)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "nowrap",
- "type" : "String",
- "desc" : "Specifies that the content inside a cell should not wrap",
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "rowspan",
+ "name" : "labelsm",
"type" : "Number",
- "desc" : "Sets the number of rows a cell should span",
+ "desc" : "set the width of label (1-12)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "scope",
- "type" : "String",
- "desc" : "Defines a way to associate header cells and data cells in a table",
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tag",
- "type" : "String",
- "desc" : "cell tag (td|th) default td",
+ "name" : "monthAllowBlank",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "monthFormat",
+ "type" : "string",
+ "desc" : "default 'm'",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tooltip",
+ "name" : "monthPlaceholder",
"type" : "string",
- "desc" : "Text for the tooltip",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "valign",
+ "name" : "style",
"type" : "String",
- "desc" : "Vertical aligns the content in a cell",
- "memberOf" : "",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
]
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "Specifies the width of a cell",
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "yearAllowBlank",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "yearFormat",
+ "type" : "string",
+ "desc" : "default 'Y'",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "yearPlaceholder",
+ "type" : "string",
+ "desc" : "",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
}
],
"returns" : []
},
+ {
+ "name" : "days",
+ "type" : "function",
+ "desc" : "getting the data of days",
+ "sig" : "function (_self, days)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.DateSplitField",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "days",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "years",
+ "type" : "function",
+ "desc" : "getting the data of years",
+ "sig" : "function (_self, years)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.DateSplitField",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "years",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.Alert",
- "Roo.bootstrap.BezierSignature",
- "Roo.bootstrap.Brick",
- "Roo.bootstrap.Button",
- "Roo.bootstrap.ButtonGroup",
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.Calendar",
- "Roo.bootstrap.Card",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.DocumentManager",
- "Roo.bootstrap.DocumentSlider",
- "Roo.bootstrap.DocumentViewer",
- "Roo.bootstrap.DropTarget",
- "Roo.bootstrap.Element",
- "Roo.bootstrap.Graph",
- "Roo.bootstrap.Header",
- "Roo.bootstrap.Img",
- "Roo.bootstrap.LayoutMasonry",
- "Roo.bootstrap.LayoutMasonryAuto",
- "Roo.bootstrap.Link",
- "Roo.bootstrap.LocationPicker",
- "Roo.bootstrap.MasonryBrick",
- "Roo.bootstrap.MessageBar",
- "Roo.bootstrap.Pagination",
- "Roo.bootstrap.PaginationItem",
- "Roo.bootstrap.PagingToolbar",
- "Roo.bootstrap.Progress",
- "Roo.bootstrap.ProgressBar",
- "Roo.bootstrap.Row",
- "Roo.bootstrap.Slider",
- "Roo.bootstrap.TabGroup",
- "Roo.bootstrap.TabPanel",
- "Roo.bootstrap.Table",
- "Roo.bootstrap.UploadCropbox",
- "Roo.bootstrap.breadcrumb.Nav",
- "Roo.bootstrap.dash.NumberBox",
- "Roo.bootstrap.dash.TabBox",
- "Roo.bootstrap.dash.TabPane",
- "Roo.bootstrap.form.CardUploader",
- "Roo.bootstrap.form.CheckBox",
- "Roo.bootstrap.form.ComboBox",
- "Roo.bootstrap.form.DateField",
- "Roo.bootstrap.form.DateSplitField",
- "Roo.bootstrap.form.FieldLabel",
- "Roo.bootstrap.form.Form",
- "Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.Input",
- "Roo.bootstrap.form.Markdown",
- "Roo.bootstrap.form.MoneyField",
- "Roo.bootstrap.form.MonthField",
- "Roo.bootstrap.form.NumberField",
- "Roo.bootstrap.form.Password",
- "Roo.bootstrap.form.PhoneInput",
- "Roo.bootstrap.form.Radio",
- "Roo.bootstrap.form.RadioSet",
- "Roo.bootstrap.form.SecurePass",
- "Roo.bootstrap.form.TextArea",
- "Roo.bootstrap.form.TimeField",
- "Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.nav.Group",
- "Roo.bootstrap.nav.Headerbar",
- "Roo.bootstrap.nav.ProgressBar",
- "Roo.bootstrap.nav.ProgressBarItem",
- "Roo.bootstrap.nav.Sidebar",
- "Roo.bootstrap.nav.SidebarItem",
- "Roo.bootstrap.nav.Simplebar"
- ],
- "tree_parent" : [
- "Roo.bootstrap.TableRow"
- ]
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.TableRow" : {
+ "Roo.bootstrap.form.FieldLabel" : {
"props" : [
{
"name" : "actionMode",
"optvals" : []
},
{
- "name" : "align",
- "type" : "String",
- "desc" : "Aligns the content in a table row",
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "e) target allowBlank default tr",
"memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "allowDomMove",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "bgcolor",
- "type" : "String",
- "desc" : "Specifies a background color for a table row",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "charoff",
- "type" : "Number",
- "desc" : "Sets the number of characters the content will be aligned from the character specified by the char attribute",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "cls",
"type" : "String",
- "desc" : "row class",
+ "desc" : "class of the element",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"visibility"
]
},
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "contents of the element",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "iconTooltip",
+ "type" : "String",
+ "desc" : "default \"This field is required\"",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default le",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - BS4 uses is-invalid",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "tag of the element default label",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "target",
+ "type" : "String",
+ "desc" : "label target",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tooltip",
"type" : "string",
"optvals" : []
},
{
- "name" : "valign",
+ "name" : "validClass",
"type" : "String",
- "desc" : "Vertical aligns the content in a table row",
+ "desc" : "DEPRICATED - BS4 uses is-valid",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
],
"returns" : []
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.FieldLabel",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.FieldLabel",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
}
]
},
+ {
+ "name" : "get",
+ "type" : "function",
+ "desc" : "fetch a FieldLabel Group based on the target",
+ "sig" : "(target)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "string",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "register",
+ "type" : "function",
+ "desc" : "register a FieldLabel Group",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "Roo.bootstrap.form.FieldLabel",
+ "desc" : "FieldLabel to add",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "releaseCapture",
"type" : "function",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.TableCell"
- ],
- "tree_parent" : [
- "Roo.bootstrap.TableBody"
- ]
- },
- "Roo.bootstrap.Tooltip" : {
- "props" : [],
- "events" : [],
- "methods" : [
- {
- "name" : "currentEl",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.UploadCropbox" : {
+ "Roo.bootstrap.form.Form" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "left | right - for navbars",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"optvals" : []
},
{
- "name" : "buttons",
- "type" : "Array",
- "desc" : "default ['rotateLeft', 'pictureBtn', 'rotateRight']",
+ "name" : "baseParams",
+ "type" : "Object",
+ "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"optvals" : []
},
{
- "name" : "emptyText",
- "type" : "String",
- "desc" : "show when image has been loaded",
+ "name" : "errorMask",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
"memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "errorTimeout",
- "type" : "Number",
- "desc" : "default 3000",
+ "name" : "fileUpload",
+ "type" : "Boolean",
+ "desc" : "Set to true if this form is a file upload.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
]
},
{
- "name" : "isDocument",
- "type" : "Boolean",
- "desc" : "e) default fal",
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "top | left (default top)",
"memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
+ "optvals" : []
},
{
"name" : "listeners",
{
"name" : "loadMask",
"type" : "Boolean",
- "desc" : "e) default tr",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "loadingText",
- "type" : "Boolean",
- "desc" : "default 'Loading...'",
+ "desc" : "load mask when submit (default true)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "method",
- "type" : "String",
- "desc" : "default POST",
+ "name" : "maskBody",
+ "type" : "Boolean",
+ "desc" : "",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "minHeight",
+ "name" : "maskOffset",
"type" : "Number",
- "desc" : "default 300",
+ "desc" : "Default 100",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "minWidth",
- "type" : "Number",
- "desc" : "default 300",
+ "name" : "method",
+ "type" : "String",
+ "desc" : "GET | POST (default POST)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"optvals" : []
},
{
- "name" : "paramName",
+ "name" : "style",
"type" : "String",
- "desc" : "default 'imageUpload'",
- "memberOf" : "",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "rotateNotify",
- "type" : "String",
- "desc" : "show when image too small to rotate",
+ "name" : "timeout",
+ "type" : "Number",
+ "desc" : "Timeout for form actions in seconds (default is 30 seconds).",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "tooltip",
"type" : "string",
{
"name" : "url",
"type" : "String",
- "desc" : "action url",
+ "desc" : "The URL to use for form actions if one isn't supplied in the action options.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
],
"events" : [
{
- "name" : "arrange",
+ "name" : "actioncomplete",
"type" : "function",
- "desc" : "Fire when arrange the file data",
- "sig" : "function (_self, formData)\n{\n\n}",
+ "desc" : "Fires when an action is completed.",
+ "sig" : "function (_self, action)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
+ "type" : "Form",
"desc" : "",
"isOptional" : false
},
{
- "name" : "formData",
- "type" : "Object",
- "desc" : "",
+ "name" : "action",
+ "type" : "Action",
+ "desc" : "The action that completed",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforedestroy",
+ "name" : "actionfailed",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when an action fails.",
+ "sig" : "function (_self, action)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Form",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "action",
+ "type" : "Action",
+ "desc" : "The action that failed",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforehide",
+ "name" : "beforeaction",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires before any action is performed. Return false to cancel the action.",
+ "sig" : "function (_self, action)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Form",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "action",
+ "type" : "Action",
+ "desc" : "The action to be performed",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeloadcanvas",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fire before load the canvas",
- "sig" : "function (_self, src)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "src",
- "type" : "String",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "beforeselectfile",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fire before select file",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "crop",
+ "name" : "clientvalidation",
"type" : "function",
- "desc" : "Fire after initEvent",
- "sig" : "function (_self, data)\n{\n\n}",
+ "desc" : "If the monitorValid config option is true, this event fires repetitively to notify of valid state",
+ "sig" : "function (_self, valid)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
+ "type" : "Form",
"desc" : "",
"isOptional" : false
},
{
- "name" : "data",
- "type" : "String",
- "desc" : "",
+ "name" : "valid",
+ "type" : "Boolean",
+ "desc" : "true if the form has passed client-side validation",
"isOptional" : false
}
],
],
"returns" : []
},
- {
- "name" : "download",
- "type" : "function",
- "desc" : "Fire when download the image",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "exception",
- "type" : "function",
- "desc" : "Fire when get exception",
- "sig" : "function (_self, xhr)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "xhr",
- "type" : "XMLHttpRequest",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "footerbuttonclick",
- "type" : "function",
- "desc" : "Fire when footerbuttonclick",
- "sig" : "function (_self, type)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "type",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "initial",
- "type" : "function",
- "desc" : "Fire after initEvent",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "inspect",
- "type" : "function",
- "desc" : "Fire when inspect the file",
- "sig" : "function (_self, file)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "file",
- "type" : "Object",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "prepare",
- "type" : "function",
- "desc" : "Fire when preparing the file data",
- "sig" : "function (_self, file)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "file",
- "type" : "Object",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "resize",
- "type" : "function",
- "desc" : "Fire when resize",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "rotate",
- "type" : "function",
- "desc" : "Fire when rotate the image",
- "sig" : "function (_self, pos)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "pos",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "trash",
- "type" : "function",
- "desc" : "Fire when trash image",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "upload",
- "type" : "function",
- "desc" : "Fire when xhr upload the file",
- "sig" : "function (_self, data)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"methods" : [
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clears all invalid messages in this form.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "doAction",
+ "type" : "function",
+ "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.",
+ "sig" : "(actionName, options)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "actionName",
+ "type" : "String",
+ "desc" : "The name of the action type",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) The options to pass to the action. All of the config options listed\nbelow are supported by both the submit and load actions unless otherwise noted (custom actions could also\naccept other config options):\n<pre>\nProperty Type Description\n---------------- --------------- ----------------------------------------------------------------------------------\nurl String The url for the action (defaults to the form's url)\nmethod String The form method to use (defaults to the form's method, or POST if not defined)\nparams String/Object The params to pass (defaults to the form's baseParams, or none if not defined)\nclientValidation Boolean Applies to submit only. Pass true to call form.isValid() prior to posting to\n validate the form on the client (defaults to false)\n</pre>",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
+ },
{
"name" : "enable",
"type" : "function",
}
]
},
+ {
+ "name" : "findField",
+ "type" : "function",
+ "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The value to search for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "",
+ "desc" : "Field"
+ }
+ ]
+ },
{
"name" : "fireEvent",
"type" : "function",
}
]
},
+ {
+ "name" : "getFieldValues",
+ "type" : "function",
+ "desc" : "Returns the fields in this form as an object with key/value pairs.\nThis differs from getValues as it calls getValue on each child item, rather than using dom data.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : ""
+ }
+ ]
+ },
{
"name" : "getId",
"type" : "function",
}
]
},
+ {
+ "name" : "getValues",
+ "type" : "function",
+ "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.",
+ "sig" : "(asString)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "asString",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : ""
+ }
+ ]
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "isDirty",
+ "type" : "function",
+ "desc" : "Returns true if any fields in this form have changed since their original load.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "",
+ "desc" : "Boolean"
+ }
+ ]
+ },
+ {
+ "name" : "isValid",
+ "type" : "function",
+ "desc" : "Returns true if client-side validation on the form is successful.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "",
+ "desc" : "Boolean"
+ }
+ ]
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark fields in this form invalid in bulk.",
+ "sig" : "(errors)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "errors",
+ "type" : "Array/Object",
+ "desc" : "Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
+ },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets this form.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setValues",
+ "type" : "function",
+ "desc" : "Set values for fields in this form in bulk.",
+ "sig" : "(values)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "values",
+ "type" : "Array/Object",
+ "desc" : "Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.bootstrap.breadcrumb" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
"tree_parent" : []
},
- "Roo.bootstrap.breadcrumb.Item" : {
+ "Roo.bootstrap.form.HtmlEditor" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
+ },
{
"name" : "actionMode",
"type" : "String",
"optvals" : []
},
{
- "name" : "active",
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ {
+ "name" : "allowBlank",
"type" : "Boolean",
- "desc" : "is it active",
- "memberOf" : "",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "autocomplete",
+ "type" : "String",
+ "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "buttons",
+ "type" : "Array",
+ "desc" : "Array of toolbar's buttons. - defaults to empty",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "user",
+ "camera"
+ ]
+ },
{
"name" : "cls",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "cols",
+ "type" : "Number",
+ "desc" : "Specifies the visible width of a text area",
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "container_method",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default fal",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default tr",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "(in pixels)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "hideMode",
"type" : "String",
]
},
{
- "name" : "href",
+ "name" : "html",
+ "type" : "string",
+ "desc" : "text",
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "indicatorpos",
"type" : "String",
- "desc" : "where it links to if '#' is used the link will be handled by onClick.",
- "memberOf" : "",
+ "desc" : "t) default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "html",
+ "name" : "invalidFeedbackIcon",
"type" : "String",
- "desc" : "the content of the link.",
- "memberOf" : "",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "left"
+ ]
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "placeholder",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "resize",
+ "type" : "String",
+ "desc" : "l) - css resize of eleme",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "none",
+ "both",
+ "horizontal",
+ "vertical"
+ ]
+ },
+ {
+ "name" : "rows",
+ "type" : "Number",
+ "desc" : "Specifies the visible number of lines in a text area",
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "stylesheets",
+ "type" : "Array",
+ "desc" : "url of stylesheets. set to [] to disable stylesheets.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "toolbars",
+ "type" : "Array|boolean",
+ "desc" : "Array of toolbars, or names of toolbars. - true for standard, and false for none.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tooltip",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"parent"
]
},
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "(in pixels)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "wrap",
+ "type" : "string",
+ "desc" : "d)Specifies how the text in a text area is to be wrapped when submitted in a fo",
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isOptional" : false,
+ "optvals" : [
+ "soft",
+ "hard"
+ ]
+ },
{
"name" : "xattr",
"type" : "Object",
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
+ {
+ "name" : "activate",
+ "type" : "function",
+ "desc" : "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "autosave",
+ "type" : "function",
+ "desc" : "Auto save the htmlEditor value as a file into Events",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "beforepush",
+ "type" : "function",
+ "desc" : "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push.",
+ "sig" : "function (_self, html)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforerender",
"type" : "function",
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "beforesync",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync.",
+ "sig" : "function (_self, html)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "html",
+ "type" : "String",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "click",
+ "name" : "blur",
"type" : "function",
- "desc" : "The img click event for the img.",
- "sig" : "function (e)\n{\n\n}",
+ "desc" : "",
+ "sig" : "function ()\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "function ()\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "enable",
+ "name" : "editmodechange",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when the editor switches edit modes",
+ "sig" : "function (_self, sourceEdit)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "sourceEdit",
+ "type" : "Boolean",
+ "desc" : "True if source edit, false if standard editing.",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "hide",
+ "name" : "editorevent",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "render",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
+ "desc" : "Fires after the component is enabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "show",
+ "name" : "firstfocus",
"type" : "function",
- "desc" : "Fires after the component is shown.",
+ "desc" : "Fires when on first focus - needed by toolbars..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "addEvents",
+ "name" : "focus",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "",
+ "sig" : "function ()\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "imageadd",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when on any editor when an image is added (excluding paste)",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "imagedelete",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when on any editor when an image is deleted",
+ "sig" : "function (_self, img, oldSrc)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "img",
+ "type" : "HTMLElement",
+ "desc" : "could also be a figure if blocks are enabled",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "oldSrc",
+ "type" : "HTMLElement",
+ "desc" : "source of image being replaced",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "imageupdated",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when on any editor when an image is changed (excluding paste)",
+ "sig" : "function (_self, img)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "img",
+ "type" : "HTMLElement",
+ "desc" : "could also be a figure if blocks are enabled",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "initialize",
+ "type" : "function",
+ "desc" : "Fires when the editor is fully initialized (including the iframe)",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "paste",
+ "type" : "function",
+ "desc" : "Fires when press user pastes into the editor",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.HtmlEditorCore",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "push",
+ "type" : "function",
+ "desc" : "Fires when the iframe editor is updated with content from the textarea.",
+ "sig" : "function (_self, html)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "savedpreview",
+ "type" : "function",
+ "desc" : "preview the saved version of htmlEditor",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "function ()\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "stylesheetsclick",
+ "type" : "function",
+ "desc" : "Fires when press the Sytlesheets button",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.HtmlEditorCore",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "sync",
+ "type" : "function",
+ "desc" : "Fires when the textarea is updated with content from the editor iframe.",
+ "sig" : "function (_self, html)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "capture",
+ "type" : "function",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "createToolbar",
+ "type" : "function",
+ "desc" : "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons.",
+ "sig" : "(editor)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "editor",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "name The name field"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real textarea element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "toggleSourceEdit",
+ "type" : "function",
+ "desc" : "Toggles the editor between standard and source edit mode.",
+ "sig" : "(sourceEdit)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "sourceEdit",
+ "type" : "Boolean",
+ "desc" : "(optional) True for source edit, false for standard",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "tooltipEl",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.Alert",
- "Roo.bootstrap.BezierSignature",
- "Roo.bootstrap.Brick",
- "Roo.bootstrap.Button",
- "Roo.bootstrap.ButtonGroup",
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.Calendar",
- "Roo.bootstrap.Card",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.DocumentManager",
- "Roo.bootstrap.DocumentSlider",
- "Roo.bootstrap.DocumentViewer",
- "Roo.bootstrap.DropTarget",
- "Roo.bootstrap.Element",
- "Roo.bootstrap.Graph",
- "Roo.bootstrap.Header",
- "Roo.bootstrap.Img",
- "Roo.bootstrap.LayoutMasonry",
- "Roo.bootstrap.LayoutMasonryAuto",
- "Roo.bootstrap.Link",
- "Roo.bootstrap.LocationPicker",
- "Roo.bootstrap.MasonryBrick",
- "Roo.bootstrap.MessageBar",
- "Roo.bootstrap.Pagination",
- "Roo.bootstrap.PaginationItem",
- "Roo.bootstrap.PagingToolbar",
- "Roo.bootstrap.Progress",
- "Roo.bootstrap.ProgressBar",
- "Roo.bootstrap.Row",
- "Roo.bootstrap.Slider",
- "Roo.bootstrap.TabGroup",
- "Roo.bootstrap.TabPanel",
- "Roo.bootstrap.Table",
- "Roo.bootstrap.UploadCropbox",
- "Roo.bootstrap.breadcrumb.Nav",
- "Roo.bootstrap.dash.NumberBox",
- "Roo.bootstrap.dash.TabBox",
- "Roo.bootstrap.dash.TabPane",
- "Roo.bootstrap.form.CardUploader",
- "Roo.bootstrap.form.CheckBox",
- "Roo.bootstrap.form.ComboBox",
- "Roo.bootstrap.form.DateField",
- "Roo.bootstrap.form.DateSplitField",
- "Roo.bootstrap.form.FieldLabel",
- "Roo.bootstrap.form.Form",
- "Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.Input",
- "Roo.bootstrap.form.Markdown",
- "Roo.bootstrap.form.MoneyField",
- "Roo.bootstrap.form.MonthField",
- "Roo.bootstrap.form.NumberField",
- "Roo.bootstrap.form.Password",
- "Roo.bootstrap.form.PhoneInput",
- "Roo.bootstrap.form.Radio",
- "Roo.bootstrap.form.RadioSet",
- "Roo.bootstrap.form.SecurePass",
- "Roo.bootstrap.form.TextArea",
- "Roo.bootstrap.form.TimeField",
- "Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.nav.Group",
- "Roo.bootstrap.nav.Headerbar",
- "Roo.bootstrap.nav.ProgressBar",
- "Roo.bootstrap.nav.ProgressBarItem",
- "Roo.bootstrap.nav.Sidebar",
- "Roo.bootstrap.nav.SidebarItem",
- "Roo.bootstrap.nav.Simplebar"
- ],
- "tree_parent" : [
- "Roo.bootstrap.breadcrumb.Nav"
- ]
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.breadcrumb.Nav" : {
+ "Roo.bootstrap.form.HtmlEditorToolbar" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.form.HtmlEditorToolbar.Standard" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) alignme",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "arrangement",
+ "type" : "Boolean",
+ "desc" : "stacked | justified",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "btns",
+ "type" : "Array",
+ "desc" : "List of additional buttons.\n\n\nNEEDS Extra CSS? \n.x-html-editor-tb .x-edit-none .x-btn-text { background: none; }",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "disable",
+ "type" : "Object",
+ "desc" : "List of elements to disable..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "disableClass",
"type" : "String",
"visibility"
]
},
+ {
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "is inverted color",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "e) loadMask on the b",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "main",
+ "type" : "Boolean",
+ "desc" : "e) main nav bar? default fal",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "name",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "v) default is n",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "header",
+ "footer",
+ "nav",
+ "div"
+ ]
+ },
{
"name" : "tooltip",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "type",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "nav",
+ "pills",
+ "tabs"
+ ]
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"parent"
]
},
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "e) default is ligh",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "light",
+ "primary",
+ "secondary",
+ "success",
+ "danger",
+ "warning",
+ "info",
+ "dark",
+ "white"
+ ]
+ },
{
"name" : "xattr",
"type" : "Object",
],
"returns" : []
},
+ {
+ "name" : "beforetoggle",
+ "type" : "function",
+ "desc" : "Fire before toggle the menu",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Collapse the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expand the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.breadcrumb.Item"
- ],
- "tree_parent" : []
- },
- "Roo.bootstrap.dash" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
+ },
+ {
+ "name" : "updateToolbar",
+ "type" : "function",
+ "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
"implementations" : [],
"tree_children" : [],
- "tree_parent" : []
+ "tree_parent" : [
+ "Roo.bootstrap.form.HtmlEditor"
+ ]
},
- "Roo.bootstrap.dash.NumberBox" : {
+ "Roo.bootstrap.form.Input" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empt",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
+ },
{
"name" : "actionMode",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default le",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "autocomplete",
+ "type" : "String",
+ "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empt",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "user",
+ "camera"
+ ]
+ },
{
"name" : "cls",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "content",
- "type" : "String",
- "desc" : "Box content",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "dataId",
"type" : "string",
"optvals" : []
},
{
- "name" : "fhref",
- "type" : "String",
- "desc" : "Footer href",
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "footer",
- "type" : "String",
- "desc" : "Footer text",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "headline",
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "focusClass",
"type" : "String",
- "desc" : "Box headline",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default tr",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "hideMode",
"type" : "String",
]
},
{
- "name" : "icon",
+ "name" : "indicatorpos",
"type" : "String",
- "desc" : "Box icon",
+ "desc" : "t) default le",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "button",
+ "checkbox",
+ "email",
+ "file",
+ "hidden",
+ "image",
+ "number",
+ "password",
+ "radio",
+ "range",
+ "reset",
+ "search",
+ "submit",
+ "text"
+ ]
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "left"
+ ]
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "placeholder",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"parent"
]
},
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "xattr",
"type" : "Object",
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"returns" : []
},
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "paste",
+ "type" : "function",
+ "desc" : "Fires after the user pastes into input",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "name The name field"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
+ "implementations" : [
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.dash.TabBox" : {
+ "Roo.bootstrap.form.Markdown" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
+ },
{
"name" : "actionMode",
"type" : "String",
"optvals" : []
},
{
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "cls",
+ "name" : "align",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "t) Default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
- "optvals" : []
- },
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autocomplete",
+ "type" : "String",
+ "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "user",
+ "camera"
+ ]
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cols",
+ "type" : "Number",
+ "desc" : "Specifies the visible width of a text area",
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "container_method",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "content",
+ "type" : "string",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "dataId",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default fal",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default tr",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "hideMode",
"type" : "String",
]
},
{
- "name" : "icon",
+ "name" : "html",
+ "type" : "string",
+ "desc" : "text",
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "indicatorpos",
"type" : "String",
- "desc" : "Icon of the TabBox",
- "memberOf" : "",
+ "desc" : "t) default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "button",
+ "checkbox",
+ "email",
+ "file",
+ "hidden",
+ "image",
+ "number",
+ "password",
+ "radio",
+ "range",
+ "reset",
+ "search",
+ "submit",
+ "text"
+ ]
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "left"
+ ]
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "placeholder",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "showtabs",
+ "name" : "preventMark",
"type" : "Boolean",
- "desc" : "e) show the tabs default tr",
- "memberOf" : "",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
+ "optvals" : []
},
{
- "name" : "style",
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regexText",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tabScrollable",
- "type" : "Boolean",
- "desc" : "e) tab scrollable when mobile view default fal",
- "memberOf" : "",
+ "name" : "resize",
+ "type" : "string",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.TextArea",
"isOptional" : false,
"optvals" : [
- "true",
- "false"
+ "none",
+ "both",
+ "horizontal",
+ "vertical",
+ "inherit",
+ "initial"
]
},
{
- "name" : "title",
+ "name" : "rows",
+ "type" : "Number",
+ "desc" : "Specifies the visible number of lines in a text area",
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
"type" : "String",
- "desc" : "Title of the TabBox",
- "memberOf" : "",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"parent"
]
},
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "wrap",
+ "type" : "string",
+ "desc" : "d)Specifies how the text in a text area is to be wrapped when submitted in a fo",
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isOptional" : false,
+ "optvals" : [
+ "soft",
+ "hard"
+ ]
+ },
{
"name" : "xattr",
"type" : "Object",
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
- "name" : "activatepane",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "When a pane is activated",
- "sig" : "function (pane)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "pane",
- "type" : "Roo.bootstrap.dash.TabPane",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "addpane",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "When a pane is added",
- "sig" : "function (pane)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "pane",
- "type" : "Roo.bootstrap.dash.TabPane",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforedestroy",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "beforehide",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "blur",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "desc" : "Fires when this field loses input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "change",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
}
],
"returns" : []
],
"returns" : []
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "paste",
+ "type" : "function",
+ "desc" : "Fires after the user pastes into input",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "name The name field"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real textarea element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
"returns" : []
},
{
- "name" : "setTitle",
+ "name" : "setRawValue",
"type" : "function",
- "desc" : "Updates the box title",
- "sig" : "(html)",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "html",
- "type" : "String",
- "desc" : "to set the title to.",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
"isOptional" : false
}
],
}
],
"returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.dash.TabPane"
- ],
+ "tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.dash.TabPane" : {
+ "Roo.bootstrap.form.MoneyField" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
+ },
{
"name" : "actionMode",
"type" : "String",
"optvals" : []
},
{
- "name" : "active",
- "type" : "Boolean",
- "desc" : "e) Default fal",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "false",
- "true"
- ]
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "title",
- "type" : "String",
- "desc" : "title of panel",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : [
- "el",
- "parent"
- ]
- },
- {
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "activate",
- "type" : "function",
- "desc" : "When a pane is activated",
- "sig" : "function (pane)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "pane",
- "type" : "Roo.bootstrap.dash.TabPane",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "methods" : [
- {
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "addListener",
- "type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "capture",
- "type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "fireEvent",
- "type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "getChildContainer",
- "type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
- },
- {
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
- }
- ]
- },
- {
- "name" : "getId",
- "type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getVisibilityEl",
- "type" : "function",
- "desc" : "Get the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "hasListener",
- "type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "initEvents",
- "type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "on",
- "type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "removeListener",
- "type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setDisabled",
- "type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setTitle",
- "type" : "function",
- "desc" : "Updates the tab title",
- "sig" : "(html)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "html",
- "type" : "String",
- "desc" : "to set the title to.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setVisibilityEl",
- "type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
- },
- {
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.Graph",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.TabGroup"
- ],
- "tree_parent" : []
- },
- "Roo.bootstrap.form" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.bootstrap.form.CardUploader" : {
- "props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "badge",
- "type" : "String",
- "desc" : "text for badge",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "badge_weight",
- "type" : "String",
- "desc" : "k) default (same as butto",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : [
- "default",
- "primary",
- "secondary",
- "success",
- "info",
- "warning",
- "danger",
- "link",
- "light",
- "dark"
- ]
- },
- {
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "default false;",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "errorTimeout",
- "type" : "Number",
- "desc" : "default 3000",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fa",
- "type" : "String",
- "desc" : "fontawesome icon - eg. 'comment' - without the fa/fas etc..",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "glyphicon",
- "type" : "String",
- "desc" : "depricated - use fa",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "grpup",
- "type" : "Boolean",
- "desc" : "if parent is a btn group - then it turns it into a toogleGroup.",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
- },
- {
- "name" : "href",
- "type" : "String",
- "desc" : "empty or href",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "html",
- "type" : "Array",
- "desc" : "The button text.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "images",
- "type" : "Array",
- "desc" : "an array of ?? Img objects ??? when loading existing files..",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "dark themed version",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "isClose",
- "type" : "Boolean",
- "desc" : "default false;",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "menu",
- "type" : "Roo.bootstrap.menu.Menu",
- "desc" : "a Menu",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "offtext",
- "type" : "String",
- "desc" : "text for off slidy toggle state",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "ontext",
- "type" : "String",
- "desc" : "text for on slidy toggle state",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "outline",
- "type" : "Boolean",
- "desc" : "default false (except for weight=default which emulates old behaveiour with an outline)",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "pressed",
- "type" : "Boolean",
- "desc" : "default null - if the button ahs active state",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "default true (stop click event triggering the URL if it's a link.)",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "removeClass",
- "type" : "Boolean",
- "desc" : "remove the standard class..",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "size",
- "type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : [
- "lg",
- "sm",
- "xs"
- ]
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "tag",
- "type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : [
- "a",
- "input",
- "submit"
- ]
- },
- {
- "name" : "target",
- "type" : "String",
- "desc" : "r) target for a hre",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : [
- "_self",
- "_blank",
- "_parent",
- "_top",
- "other"
- ]
- },
- {
- "name" : "theme",
- "type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : [
- "default",
- "glow"
- ]
- },
- {
- "name" : "toggle",
- "type" : "Boolean",
- "desc" : "is it a slidy toggle button",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : [
- "el",
- "parent"
- ]
- },
- {
- "name" : "weight",
- "type" : "String",
- "desc" : "k) defau",
- "memberOf" : "Roo.bootstrap.Button",
- "isOptional" : false,
- "optvals" : [
- "default",
- "primary",
- "secondary",
- "success",
- "info",
- "warning",
- "danger",
- "link",
- "light",
- "dark"
- ]
- },
- {
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "click",
- "type" : "function",
- "desc" : "When a button is pressed",
- "sig" : "function (btn, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Button",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "btn",
- "type" : "Roo.bootstrap.Button",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "dblclick",
- "type" : "function",
- "desc" : "When a button is double clicked",
- "sig" : "function (btn, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Button",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "btn",
- "type" : "Roo.bootstrap.Button",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "download",
- "type" : "function",
- "desc" : "When a the download link is clicked",
- "sig" : "function (_self, The)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Card",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "The",
- "type" : "Object",
- "desc" : "image information data contains",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "preview",
- "type" : "function",
- "desc" : "When a image is clicked on - and needs to display a slideshow or similar..",
- "sig" : "function (_self, The)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Card",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "The",
- "type" : "Object",
- "desc" : "image information data",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "toggle",
- "type" : "function",
- "desc" : "After the button has been toggles",
- "sig" : "function (btn, e, pressed)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Button",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "btn",
- "type" : "Roo.bootstrap.Button",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "pressed",
- "type" : "boolean",
- "desc" : "(also available as button.pressed)",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "methods" : [
- {
- "name" : "addCard",
- "type" : "function",
- "desc" : "addCard - add an Attachment to the uploader",
- "sig" : "(data)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "data",
- "type" : "",
- "desc" : "- the data about the image to upload\n\n{\n id : 123\n title : \"Title of file\",\n is_uploaded : false,\n src : \"http://.....\",\n srcfile : { the File upload object },\n mimetype : file.type,\n preview : false,\n is_deleted : 0\n .. any other data...\n }",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "addListener",
- "type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "capture",
- "type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this button",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Button",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enables this button",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Button",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "fireEvent",
- "type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "getChildContainer",
- "type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
- },
- {
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
- }
- ]
- },
- {
- "name" : "getId",
- "type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getText",
- "type" : "function",
- "desc" : "get the text of the first selected button",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Button",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "getVisibilityEl",
- "type" : "function",
- "desc" : "Get the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "hasListener",
- "type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "initEvents",
- "type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isActive",
- "type" : "function",
- "desc" : "get the current active state",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Button",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "boolean",
- "desc" : "true if it's active"
- }
- ]
- },
- {
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "on",
- "type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "removeListener",
- "type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
},
{
- "name" : "render",
- "type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "setActive",
- "type" : "function",
- "desc" : "sets the active state on/off,",
- "sig" : "(state)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Button",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "state",
- "type" : "Boolean",
- "desc" : "(optional) Force a particular state",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
},
{
- "name" : "setDisabled",
- "type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "allQuery",
+ "type" : "String",
+ "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "setText",
- "type" : "function",
- "desc" : "set the text of the first selected button",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Button",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "setVisibilityEl",
- "type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
+ "name" : "allowDecimals",
+ "type" : "Boolean",
+ "desc" : "False to disallow decimal values (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "toggleActive",
- "type" : "function",
- "desc" : "toggles the current active state",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Button",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.bootstrap.form.CheckBox" : {
- "props" : [
- {
- "name" : "accept",
- "type" : "String",
- "desc" : "o) use for file input only. (default empt",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "allowNegative",
+ "type" : "Boolean",
+ "desc" : "False to prevent entering a negative sign (defaults to true)",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "image",
- "video",
- "audio"
- ]
+ "optvals" : []
},
{
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
+ "name" : "allowZero",
+ "type" : "Boolean",
+ "desc" : "False to blank out if the user enters '0' (defaults to true)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "alwaysQuery",
+ "type" : "Boolean",
+ "desc" : "Disable caching of results, and always send query",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "afterButton",
- "type" : "Roo.bootstrap.Button",
- "desc" : "to show before",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "animate",
+ "type" : "Boolean",
+ "desc" : "default true",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "align",
- "type" : "String",
- "desc" : "t) Default le",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "append",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
"isOptional" : false,
"optvals" : [
- "left",
- "center",
- "right"
+ "true",
+ "false"
]
},
{
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "autoCreate",
+ "type" : "Boolean/Object",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "allowDomMove",
+ "name" : "autoFocus",
"type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
+ "desc" : "e) auto focus the first item, default tr",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "autocomplete",
"optvals" : []
},
{
- "name" : "boxLabel",
+ "name" : "blockFocus",
+ "type" : "Boolean",
+ "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "btnPosition",
"type" : "String",
- "desc" : "The text that appears beside the checkbox",
- "memberOf" : "",
+ "desc" : "set the position of the trigger button (left | right) default right",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
"isOptional" : false,
"optvals" : []
},
]
},
{
- "name" : "checked",
+ "name" : "caret",
+ "type" : "String",
+ "desc" : "r) BS3 only - carat fa na",
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : [
+ "search",
+ "calendar"
+ ]
+ },
+ {
+ "name" : "castInt",
"type" : "Boolean",
- "desc" : "initnal the element",
+ "desc" : "e) cast int if true (defalut tru",
"memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "cls",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "decimalPrecision",
+ "type" : "Number",
+ "desc" : "The maximum precision to display after the decimal separator (defaults to 2)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "decimalSeparator",
+ "type" : "String",
+ "desc" : "Character(s) to allow as the decimal separator (defaults to '.')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "defaults",
+ "type" : "String",
+ "desc" : "currency of the MoneyField\nvalue should be in lkey",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "disableClass",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "disableClear",
+ "type" : "Boolean",
+ "desc" : "Disable showing of clear button.",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "disableKeyFilter",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "displayField",
+ "type" : "String",
+ "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "editable",
+ "type" : "Boolean",
+ "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "emptyResultText",
+ "type" : "Boolean",
+ "desc" : "only for touch device",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "emptyTitle",
+ "type" : "String",
+ "desc" : "default ''",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "fieldLabel",
"type" : "string",
]
},
{
- "name" : "groupId",
- "type" : "String",
- "desc" : "the checkbox group id // normal just use for checkbox",
- "memberOf" : "",
+ "name" : "forceSelection",
+ "type" : "Boolean",
+ "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "grow",
+ "type" : "Boolean",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMax",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "handleHeight",
+ "type" : "Number",
+ "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
"isOptional" : false,
"optvals" : []
},
"false"
]
},
+ {
+ "name" : "hiddenName",
+ "type" : "String",
+ "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "hideMode",
"type" : "String",
"visibility"
]
},
+ {
+ "name" : "hideTrigger",
+ "type" : "Boolean",
+ "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "indicatorpos",
"type" : "String",
"right"
]
},
- {
- "name" : "inline",
- "type" : "Boolean",
- "desc" : "inline the element (default false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "inputType",
"type" : "String",
"text"
]
},
- {
- "name" : "inputValue",
- "type" : "String",
- "desc" : "The value that should go into the generated input element's value when checked.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "invalidClass",
"type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "DEPRICATED - uses BS4 is-valid now",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "lazyRender",
+ "type" : "Boolean",
+ "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "lg",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "listAlign",
+ "type" : "String",
+ "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listWidth",
+ "type" : "Number",
+ "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "loadingText",
+ "type" : "String",
+ "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "maskRe",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "maxHeight",
+ "type" : "Number",
+ "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "maxLength",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "maxText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxValue",
+ "type" : "Number",
+ "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "max_length",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "md",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "minChars",
+ "type" : "Number",
+ "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "minLength",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "minListWidth",
+ "type" : "Number",
+ "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minValue",
+ "type" : "Number",
+ "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "mobileTouchView",
+ "type" : "Boolean",
+ "desc" : "e) show mobile touch view when using a mobile default tr",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "mobile_restrict_height",
+ "type" : "Boolean",
+ "desc" : "e) restrict height for touch vi",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "modalTitle",
+ "type" : "String",
+ "desc" : "The title of the dialog that pops up on mobile views.",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "mode",
+ "type" : "String",
+ "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "multiple",
+ "type" : "Boolean",
+ "desc" : "e) ComboBobArray, default fal",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "name",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "nanText",
+ "type" : "String",
+ "desc" : "Error text to display if the value is not a valid number. For example, this can happen\nif a valid character like '.' or '-' is left in the field with no number (defaults to \"{value} is not a valid number\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "pageSize",
+ "type" : "Number",
+ "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "placeholder",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "queryDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "queryParam",
+ "type" : "String",
+ "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "readOnly",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "removable",
+ "type" : "Boolean",
+ "desc" : "e) special filter default fal",
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "resizable",
+ "type" : "Boolean",
+ "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "selectOnFocus",
"type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "selectedClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "shadow",
+ "type" : "Boolean/String",
+ "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "showToggleBtn",
+ "type" : "Boolean",
+ "desc" : "show toggle button or not (true|false) default true",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "specialFilter",
+ "type" : "Boolean",
+ "desc" : "e) special filter default fal",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "Store to lookup currency??",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "style",
"type" : "String",
"optvals" : []
},
{
- "name" : "tooltip",
+ "name" : "thousandsDelimiter",
"type" : "String",
- "desc" : "label tooltip",
+ "desc" : "Symbol of thousandsDelimiter",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "tickable",
+ "type" : "Boolean",
+ "desc" : "ComboBox with tickable selections (true|false), default false",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tpl",
+ "type" : "String/Roo.Template",
+ "desc" : "The template to use to render the output default is '<a class=\"dropdown-item\" href=\"#\">{' + this.displayField + '}</a>'",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "triggerAction",
+ "type" : "String",
+ "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "triggerClass",
+ "type" : "String",
+ "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "triggerList",
+ "type" : "Boolean",
+ "desc" : "trigger show the list or not (true|false) default true",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "triggerText",
+ "type" : "String",
+ "desc" : "multiple combobox trigger button text default 'Select'",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "typeAhead",
+ "type" : "Boolean",
+ "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "typeAheadDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "useNativeIOS",
+ "type" : "Boolean",
+ "desc" : "e) render it as classic select for ios, not support dynamic load data (default fals",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "validClass",
"type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "DEPRICATED - uses BS4 is-valid now",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "valueOff",
+ "name" : "valueField",
"type" : "String",
- "desc" : "The value that should go into the generated input element's value when unchecked.",
- "memberOf" : "",
+ "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "valueNotFoundText",
+ "type" : "String",
+ "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "weight",
- "type" : "String",
- "desc" : "s) The text that appears beside the checkb",
- "memberOf" : "",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "fixed with? experimental",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
"isOptional" : false,
- "optvals" : [
- "primary",
- "warning",
- "info",
- "danger",
- "success"
- ]
+ "optvals" : []
},
{
"name" : "xattr",
}
],
"events" : [
+ {
+ "name" : "add",
+ "type" : "function",
+ "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "afterremove",
+ "type" : "function",
+ "desc" : "Fires when the remove value from the combobox array",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "beforequery",
+ "type" : "function",
+ "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
+ "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "query",
+ "type" : "String",
+ "desc" : "The query",
+ "isOptional" : false
+ },
+ {
+ "name" : "forceAll",
+ "type" : "Boolean",
+ "desc" : "true to force \"all\" query",
+ "isOptional" : false
+ },
+ {
+ "name" : "cancel",
+ "type" : "Boolean",
+ "desc" : "true to cancel the query",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "The query event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforerender",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "beforeselect",
+ "type" : "function",
+ "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
+ "sig" : "function (combo, record, index)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The data record returned from the underlying store",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the selected item in the dropdown list",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforeshow",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "check",
- "type" : "function",
- "desc" : "Fires when the element is checked or unchecked.",
- "sig" : "function (_self, checked)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.form.CheckBox",
- "desc" : "This input",
- "isOptional" : false
- },
- {
- "name" : "checked",
- "type" : "Boolean",
- "desc" : "The new checked value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "childrenrendered",
"type" : "function",
"returns" : []
},
{
- "name" : "click",
+ "name" : "collapse",
"type" : "function",
- "desc" : "Fires when the element is click.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when the dropdown list is collapsed",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.form.CheckBox",
- "desc" : "This input",
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
}
],
],
"returns" : []
},
+ {
+ "name" : "edit",
+ "type" : "function",
+ "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo, record)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record|false",
+ "desc" : "The data record returned from the underlying store (or false on nothing selected)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "enable",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Fires when the dropdown list is expanded",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "focus",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "remove",
+ "type" : "function",
+ "desc" : "Fires when the remove value from the combobox array",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "Fires when a list item is selected",
+ "sig" : "function (combo, record, index)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The data record returned from the underlying store (or false on clear)",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the selected item in the dropdown list",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "specialfilter",
+ "type" : "function",
+ "desc" : "Fires when specialfilter",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "specialkey",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "tick",
+ "type" : "function",
+ "desc" : "Fires when tick the element",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "touchviewdisplay",
+ "type" : "function",
+ "desc" : "Fires when touch view require special display (default is using displayField)",
+ "sig" : "function (combo, cfg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "cfg",
+ "type" : "Object",
+ "desc" : "set html .",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "valid",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "clearValue",
+ "type" : "function",
+ "desc" : "Clears any text/value currently set in the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "doQuery",
+ "type" : "function",
+ "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
+ "sig" : "(query, forceAll)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "query",
+ "type" : "String",
+ "desc" : "The SQL query to execute",
+ "isOptional" : false
+ },
+ {
+ "name" : "forceAll",
+ "type" : "Boolean",
+ "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "enable",
"type" : "function",
}
]
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
}
]
},
- {
- "name" : "get",
- "type" : "function",
- "desc" : "fetch a CheckBox Group based on the group ID",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "string",
- "desc" : "group ID",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "getAutoCreateLabel",
"type" : "function",
{
"name" : "getValue",
"type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "desc" : "Returns the currently selected field value or empty string if no value is set.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "String",
+ "desc" : "value The selected value"
}
]
},
"desc" : "return the real input element.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isExpanded",
+ "type" : "function",
+ "desc" : "Returns true if the dropdown list is expanded, else false.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Mark this field as invalid",
"sig" : "(msg)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Mark this field as valid",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "onTriggerClick",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "register",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "register a CheckBox Group",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.form.CheckBox",
- "desc" : "CheckBox to add",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
"params" : [],
"returns" : []
},
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(index, scrollIntoView)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The zero-based index of the list item to select",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollIntoView",
+ "type" : "Boolean",
+ "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "selectByValue",
+ "type" : "function",
+ "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(value, scrollIntoView)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The data value of the item to select",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollIntoView",
+ "type" : "Boolean",
+ "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value matched an item in the list, else false"
+ }
+ ]
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setEditable",
+ "type" : "function",
+ "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Boolean",
+ "desc" : "True to allow the user to directly edit the field text",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setFromData",
+ "type" : "function",
+ "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Object",
+ "desc" : "the value to set as. or false on reset?",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setRawValue",
"type" : "function",
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
"sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [
{
"name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "type" : "String",
+ "desc" : "The value to match",
"isOptional" : false
}
],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.ComboBox" : {
+ "Roo.bootstrap.form.MonthField" : {
"props" : [
{
"name" : "accept",
"right"
]
},
- {
- "name" : "allQuery",
- "type" : "String",
- "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "allowBlank",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "alwaysQuery",
- "type" : "Boolean",
- "desc" : "Disable caching of results, and always send query",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "animate",
- "type" : "Boolean",
- "desc" : "default true",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "append",
- "type" : "Boolean",
- "desc" : "e) default fal",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "autoCreate",
- "type" : "Boolean/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoFocus",
- "type" : "Boolean",
- "desc" : "e) auto focus the first item, default tr",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
{
"name" : "autocomplete",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "blockFocus",
- "type" : "Boolean",
- "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "btnPosition",
- "type" : "String",
- "desc" : "set the position of the trigger button (left | right) default right",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"camera"
]
},
- {
- "name" : "caret",
- "type" : "String",
- "desc" : "r) BS3 only - carat fa na",
- "memberOf" : "Roo.bootstrap.form.TriggerField",
- "isOptional" : false,
- "optvals" : [
- "search",
- "calendar"
- ]
- },
{
"name" : "cls",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "disableClear",
- "type" : "Boolean",
- "desc" : "Disable showing of clear button.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "disableKeyFilter",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "displayField",
- "type" : "String",
- "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "editable",
- "type" : "Boolean",
- "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "emptyResultText",
- "type" : "Boolean",
- "desc" : "only for touch device",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "emptyTitle",
- "type" : "String",
- "desc" : "default ''",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "fieldLabel",
"type" : "string",
"false"
]
},
- {
- "name" : "forceSelection",
- "type" : "Boolean",
- "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "grow",
- "type" : "Boolean",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "growMax",
- "type" : "Number",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "growMin",
- "type" : "Number",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "handleHeight",
- "type" : "Number",
- "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "hasFeedback",
"type" : "Boolean",
"false"
]
},
- {
- "name" : "hiddenName",
- "type" : "String",
- "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "hideMode",
"type" : "String",
"visibility"
]
},
- {
- "name" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.TriggerField",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "indicatorpos",
"type" : "String",
{
"name" : "invalidClass",
"type" : "String",
- "desc" : "DEPRICATED - uses BS4 is-valid now",
- "memberOf" : "",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "lazyRender",
- "type" : "Boolean",
- "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
+ "name" : "language",
+ "type" : "String",
+ "desc" : "default en",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "listAlign",
- "type" : "String",
- "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listClass",
- "type" : "String",
- "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listWidth",
- "type" : "Number",
- "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "loadingText",
- "type" : "String",
- "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "maskRe",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "maxHeight",
- "type" : "Number",
- "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "maxLength",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "minChars",
- "type" : "Number",
- "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "minLength",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "minListWidth",
- "type" : "Number",
- "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "mobileTouchView",
- "type" : "Boolean",
- "desc" : "e) show mobile touch view when using a mobile default tr",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "mobile_restrict_height",
- "type" : "Boolean",
- "desc" : "e) restrict height for touch vi",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "modalTitle",
- "type" : "String",
- "desc" : "The title of the dialog that pops up on mobile views.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "mode",
- "type" : "String",
- "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "multiple",
- "type" : "Boolean",
- "desc" : "e) ComboBobArray, default fal",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
{
"name" : "name",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "pageSize",
- "type" : "Number",
- "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "placeholder",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "queryDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "queryParam",
- "type" : "String",
- "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "readOnly",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "removable",
- "type" : "Boolean",
- "desc" : "e) special filter default fal",
- "memberOf" : "Roo.bootstrap.form.TriggerField",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "resizable",
- "type" : "Boolean",
- "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "selectOnFocus",
"type" : "Boolean",
- "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "selectedClass",
- "type" : "String",
- "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "shadow",
- "type" : "Boolean/String",
- "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "showToggleBtn",
- "type" : "Boolean",
- "desc" : "show toggle button or not (true|false) default true",
- "memberOf" : "",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "specialFilter",
- "type" : "Boolean",
- "desc" : "e) special filter default fal",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to which this combo is bound (defaults to undefined)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "style",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "tickable",
- "type" : "Boolean",
- "desc" : "ComboBox with tickable selections (true|false), default false",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "title",
- "type" : "String",
- "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "tooltip",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "tpl",
- "type" : "String/Roo.Template",
- "desc" : "The template to use to render the output default is '<a class=\"dropdown-item\" href=\"#\">{' + this.displayField + '}</a>'",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "triggerAction",
- "type" : "String",
- "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "triggerClass",
- "type" : "String",
- "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
- "memberOf" : "Roo.bootstrap.form.TriggerField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "triggerList",
- "type" : "Boolean",
- "desc" : "trigger show the list or not (true|false) default true",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "triggerText",
- "type" : "String",
- "desc" : "multiple combobox trigger button text default 'Select'",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "typeAhead",
- "type" : "Boolean",
- "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "typeAheadDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "useNativeIOS",
- "type" : "Boolean",
- "desc" : "e) render it as classic select for ios, not support dynamic load data (default fals",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
{
"name" : "validClass",
"type" : "String",
- "desc" : "DEPRICATED - uses BS4 is-valid now",
- "memberOf" : "",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "valueField",
- "type" : "String",
- "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "valueNotFoundText",
- "type" : "String",
- "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "visibilityEl",
"type" : "string|object",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "fixed with? experimental",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "xattr",
"type" : "Object",
}
],
"events" : [
- {
- "name" : "add",
- "type" : "function",
- "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "afterremove",
- "type" : "function",
- "desc" : "Fires when the remove value from the combobox array",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "beforequery",
- "type" : "function",
- "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
- "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "query",
- "type" : "String",
- "desc" : "The query",
- "isOptional" : false
- },
- {
- "name" : "forceAll",
- "type" : "Boolean",
- "desc" : "true to force \"all\" query",
- "isOptional" : false
- },
- {
- "name" : "cancel",
- "type" : "Boolean",
- "desc" : "true to cancel the query",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Object",
- "desc" : "The query event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforerender",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "beforeselect",
- "type" : "function",
- "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
- "sig" : "function (combo, record, index)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The data record returned from the underlying store",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the selected item in the dropdown list",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforeshow",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Fires when the dropdown list is collapsed",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "edit",
- "type" : "function",
- "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo, record)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record|false",
- "desc" : "The data record returned from the underlying store (or false on nothing selected)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Fires when the dropdown list is expanded",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "focus",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "remove",
- "type" : "function",
- "desc" : "Fires when the remove value from the combobox array",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
{
"name" : "select",
"type" : "function",
- "desc" : "Fires when a list item is selected",
- "sig" : "function (combo, record, index)\n{\n\n}",
+ "desc" : "Fires when select a date.",
+ "sig" : "function (_self, oldvalue, newvalue)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "combo",
- "type" : "Roo.bootstrap.form.ComboBox",
- "desc" : "This combo box",
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.MonthField",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The data record returned from the underlying store (or false on clear)",
+ "name" : "oldvalue",
+ "type" : "String",
+ "desc" : "The old value",
"isOptional" : false
},
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the selected item in the dropdown list",
+ "name" : "newvalue",
+ "type" : "String",
+ "desc" : "The new value",
"isOptional" : false
}
],
{
"name" : "show",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when this field show.",
+ "sig" : "function (_self, date)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.form.MonthField",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "specialfilter",
- "type" : "function",
- "desc" : "Fires when specialfilter",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "combo",
- "type" : "Roo.bootstrap.form.ComboBox",
- "desc" : "This combo box",
+ "name" : "date",
+ "type" : "Mixed",
+ "desc" : "The date value",
"isOptional" : false
}
],
],
"returns" : []
},
- {
- "name" : "tick",
- "type" : "function",
- "desc" : "Fires when tick the element",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "touchviewdisplay",
- "type" : "function",
- "desc" : "Fires when touch view require special display (default is using displayField)",
- "sig" : "function (combo, cfg)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "cfg",
- "type" : "Object",
- "desc" : "set html .",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "valid",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "clearValue",
- "type" : "function",
- "desc" : "Clears any text/value currently set in the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "doQuery",
- "type" : "function",
- "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
- "sig" : "(query, forceAll)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "query",
- "type" : "String",
- "desc" : "The SQL query to execute",
- "isOptional" : false
- },
- {
- "name" : "forceAll",
- "type" : "Boolean",
- "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
}
]
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "fireEvent",
"type" : "function",
{
"name" : "getValue",
"type" : "function",
- "desc" : "Returns the currently selected field value or empty string if no value is set.",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "value The selected value"
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
]
},
"params" : [],
"returns" : []
},
- {
- "name" : "isExpanded",
- "type" : "function",
- "desc" : "Returns true if the dropdown list is expanded, else false.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "isVisible",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "onTriggerClick",
- "type" : "function",
- "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "purgeListeners",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(index, scrollIntoView)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The zero-based index of the list item to select",
- "isOptional" : false
- },
- {
- "name" : "scrollIntoView",
- "type" : "Boolean",
- "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "selectByValue",
- "type" : "function",
- "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(value, scrollIntoView)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "String",
- "desc" : "The data value of the item to select",
- "isOptional" : false
- },
- {
- "name" : "scrollIntoView",
- "type" : "Boolean",
- "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value matched an item in the list, else false"
- }
- ]
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setEditable",
- "type" : "function",
- "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Boolean",
- "desc" : "True to allow the user to directly edit the field text",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setFromData",
- "type" : "function",
- "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Object",
- "desc" : "the value to set as. or false on reset?",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setRawValue",
"type" : "function",
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
"sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [
{
"name" : "value",
- "type" : "String",
- "desc" : "The value to match",
+ "type" : "Mixed",
+ "desc" : "The value to set",
"isOptional" : false
}
],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.bootstrap.form.MoneyField"
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.form.MultiLineTag" : {
+ "props" : [],
+ "events" : [
+ {
+ "name" : "beforeload",
+ "type" : "function",
+ "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.",
+ "sig" : "function (_self, store, options)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.boostrap.form.MultiLineTag",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "store",
+ "type" : "Store",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.DateField" : {
+ "Roo.bootstrap.form.NumberField" : {
"props" : [
{
"name" : "accept",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "allowDecimals",
+ "type" : "Boolean",
+ "desc" : "False to disallow decimal values (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "allowNegative",
+ "type" : "Boolean",
+ "desc" : "False to prevent entering a negative sign (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowZero",
+ "type" : "Boolean",
+ "desc" : "False to blank out if the user enters '0' (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "autocomplete",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "calendarWeeks",
- "type" : "Boolean",
- "desc" : "default false",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"optvals" : []
},
{
- "name" : "daysOfWeekDisabled",
- "type" : "Object",
- "desc" : "default empty",
+ "name" : "decimalPrecision",
+ "type" : "Number",
+ "desc" : "The maximum precision to display after the decimal separator (defaults to 2)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "decimalSeparator",
+ "type" : "String",
+ "desc" : "Character(s) to allow as the decimal separator (defaults to '.')",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "endDate",
- "type" : "Number",
- "desc" : "default Infinity",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "fieldLabel",
"type" : "string",
"false"
]
},
- {
- "name" : "format",
- "type" : "String",
- "desc" : "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "hasFeedback",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "keyboardNavigation",
- "type" : "Boolean",
- "desc" : "default true",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "labelAlign",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "language",
- "type" : "String",
- "desc" : "default en",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "lg",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "maxText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxValue",
+ "type" : "Number",
+ "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "md",
"type" : "Number",
"optvals" : []
},
{
- "name" : "minViewMode",
+ "name" : "minText",
"type" : "String",
- "desc" : "default empty, (months|years)",
+ "desc" : "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minValue",
+ "type" : "Number",
+ "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "nanText",
+ "type" : "String",
+ "desc" : "Error text to display if the value is not a valid number. For example, this can happen\nif a valid character like '.' or '-' is left in the field with no number (defaults to \"{value} is not a valid number\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "placeholder",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "singleMode",
- "type" : "Boolean",
- "desc" : "default false (true | false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "size",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "startDate",
- "type" : "Number",
- "desc" : "default -Infinity",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "style",
"type" : "String",
"optvals" : []
},
{
- "name" : "todayBtn",
- "type" : "Boolean",
- "desc" : "default false",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "todayHighlight",
- "type" : "Boolean",
- "desc" : "default false",
+ "name" : "thousandsDelimiter",
+ "type" : "String",
+ "desc" : "Symbol of thousandsDelimiter",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"optvals" : []
},
{
- "name" : "viewMode",
+ "name" : "valueAlign",
"type" : "String",
- "desc" : "default empty, (months|years)",
+ "desc" : "alignment of value",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "weekStart",
- "type" : "Number",
- "desc" : "default 0",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "xattr",
"type" : "Object",
],
"returns" : []
},
- {
- "name" : "beforeselect",
- "type" : "function",
- "desc" : "Fires when before select a date.",
- "sig" : "function (_self, date)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.form.DateField",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "date",
- "type" : "Mixed",
- "desc" : "The date value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforeshow",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when select a date.",
- "sig" : "function (_self, date)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.form.DateField",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "date",
- "type" : "Mixed",
- "desc" : "The date value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
- "desc" : "Fires when this field show.",
- "sig" : "function (_self, date)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.form.DateField",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "date",
- "type" : "Mixed",
- "desc" : "The date value",
- "isOptional" : false
}
],
"returns" : []
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.DateSplitField" : {
+ "Roo.bootstrap.form.Password" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
+ },
{
"name" : "actionMode",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "autocomplete",
+ "type" : "String",
+ "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "user",
+ "camera"
+ ]
+ },
{
"name" : "cls",
"type" : "String",
"optvals" : []
},
{
- "name" : "dayAllowBlank",
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableKeyFilter",
"type" : "Boolean",
- "desc" : "e) default fal",
- "memberOf" : "",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
+ "optvals" : []
},
{
- "name" : "dayFormat",
- "type" : "string",
- "desc" : "default 'd'",
- "memberOf" : "",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "dayPlaceholder",
+ "name" : "fieldLabel",
"type" : "string",
- "desc" : "",
- "memberOf" : "",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disableClass",
+ "name" : "focusClass",
"type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "",
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default fal",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default tr",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hideMode",
"visibility"
]
},
+ {
+ "name" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "button",
+ "checkbox",
+ "email",
+ "file",
+ "hidden",
+ "image",
+ "number",
+ "password",
+ "radio",
+ "range",
+ "reset",
+ "search",
+ "submit",
+ "text"
+ ]
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "labelAlign",
"type" : "String",
"desc" : "",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : [
"top",
{
"name" : "labelWidth",
"type" : "Number",
- "desc" : "set the width of label (0-12)",
- "memberOf" : "",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "labellg",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "labelmd",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "labelsm",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "labelxs",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "monthAllowBlank",
- "type" : "Boolean",
- "desc" : "e) default fal",
- "memberOf" : "",
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
+ "optvals" : []
},
{
- "name" : "monthFormat",
- "type" : "string",
- "desc" : "default 'm'",
- "memberOf" : "",
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "monthPlaceholder",
- "type" : "string",
- "desc" : "",
- "memberOf" : "",
+ "name" : "maxLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
{
"name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "placeholder",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
]
},
{
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "yearAllowBlank",
- "type" : "Boolean",
- "desc" : "e) default fal",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "yearFormat",
- "type" : "string",
- "desc" : "default 'Y'",
- "memberOf" : "",
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "yearPlaceholder",
- "type" : "string",
- "desc" : "",
- "memberOf" : "",
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
}
],
"returns" : []
},
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
"returns" : []
},
{
- "name" : "days",
+ "name" : "destroy",
"type" : "function",
- "desc" : "getting the data of days",
- "sig" : "function (_self, days)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.form.DateSplitField",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "days",
- "type" : "Object",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
+ "desc" : "Fires after the component is enabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "disable",
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "enable",
+ "name" : "invalid",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "hide",
+ "name" : "keyup",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "invalid",
+ "name" : "paste",
"type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the user pastes into input",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
},
{
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "valid",
+ "name" : "specialkey",
"type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "years",
+ "name" : "valid",
"type" : "function",
- "desc" : "getting the data of years",
- "sig" : "function (_self, years)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.form.DateSplitField",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "years",
- "type" : "Object",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "name The name field"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "isVisible",
"type" : "function",
"desc" : "Mark this field as invalid",
"sig" : "(msg)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
},
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.FieldLabel" : {
+ "Roo.bootstrap.form.PhoneInput" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
+ },
{
"name" : "actionMode",
"type" : "String",
"optvals" : []
},
{
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "e) target allowBlank default tr",
- "memberOf" : "",
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : [
- "true",
- "false"
+ "left",
+ "center",
+ "right"
]
},
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "autocomplete",
+ "type" : "String",
+ "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "user",
+ "camera"
+ ]
+ },
+ {
+ "name" : "caret",
+ "type" : "String",
+ "desc" : "r) BS3 only - carat fa na",
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : [
+ "search",
+ "calendar"
+ ]
+ },
{
"name" : "cls",
"type" : "String",
- "desc" : "class of the element",
- "memberOf" : "",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "defaultDialCode",
+ "type" : "String",
+ "desc" : "default '+852'",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "disableClass",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default fal",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default tr",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "hideMode",
"type" : "String",
]
},
{
- "name" : "html",
- "type" : "String",
- "desc" : "contents of the element",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "iconTooltip",
- "type" : "String",
- "desc" : "default \"This field is required\"",
- "memberOf" : "",
+ "name" : "hideTrigger",
+ "type" : "Boolean",
+ "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
"isOptional" : false,
"optvals" : []
},
"name" : "indicatorpos",
"type" : "String",
"desc" : "t) default le",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : [
"left",
"right"
]
},
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "button",
+ "checkbox",
+ "email",
+ "file",
+ "hidden",
+ "image",
+ "number",
+ "password",
+ "radio",
+ "range",
+ "reset",
+ "search",
+ "submit",
+ "text"
+ ]
+ },
{
"name" : "invalidClass",
"type" : "String",
- "desc" : "DEPRICATED - BS4 uses is-invalid",
- "memberOf" : "",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "left"
+ ]
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "style",
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLengthText",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tag",
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLengthText",
"type" : "String",
- "desc" : "tag of the element default label",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "placeholder",
+ "type" : "string",
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "preferedCountries",
+ "type" : "Array",
+ "desc" : "default []",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "target",
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regexText",
"type" : "String",
- "desc" : "label target",
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "removable",
+ "type" : "Boolean",
+ "desc" : "e) special filter default fal",
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to which this combo is bound (defaults to undefined)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tooltip",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "triggerClass",
+ "type" : "String",
+ "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "validClass",
"type" : "String",
- "desc" : "DEPRICATED - BS4 uses is-valid",
- "memberOf" : "",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"parent"
]
},
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "xattr",
"type" : "Object",
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"returns" : []
},
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
"type" : "function",
"desc" : "Fires after the field has been marked as invalid.",
"sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.FieldLabel",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
},
],
"returns" : []
},
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "paste",
+ "type" : "function",
+ "desc" : "Fires after the user pastes into input",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "valid",
"type" : "function",
"desc" : "Fires after the field has been validated with no errors.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.FieldLabel",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
]
},
{
- "name" : "get",
+ "name" : "getAutoCreateLabel",
"type" : "function",
- "desc" : "fetch a FieldLabel Group based on the target",
- "sig" : "(target)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "target",
- "type" : "string",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "name The name field"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "isVisible",
"type" : "function",
"desc" : "Mark this field as invalid",
"sig" : "(msg)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Mark this field as valid",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "onTriggerClick",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "register",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "register a FieldLabel Group",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.form.FieldLabel",
- "desc" : "FieldLabel to add",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.Form" : {
+ "Roo.bootstrap.form.Radio" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "align",
- "type" : "String",
- "desc" : "left | right - for navbars",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"optvals" : []
},
{
- "name" : "baseParams",
- "type" : "Object",
- "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
+ "name" : "boxLabel",
+ "type" : "String",
+ "desc" : "- the label associated",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "errorMask",
- "type" : "Boolean",
- "desc" : "e) default fal",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "fileUpload",
- "type" : "Boolean",
- "desc" : "Set to true if this form is a file upload.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "hideMode",
"type" : "String",
"visibility"
]
},
- {
- "name" : "labelAlign",
- "type" : "String",
- "desc" : "top | left (default top)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "loadMask",
- "type" : "Boolean",
- "desc" : "load mask when submit (default true)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maskBody",
- "type" : "Boolean",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maskOffset",
- "type" : "Number",
- "desc" : "Default 100",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "method",
- "type" : "String",
- "desc" : "GET | POST (default POST)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "name",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "timeout",
- "type" : "Number",
- "desc" : "Timeout for form actions in seconds (default is 30 seconds).",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "tooltip",
"type" : "string",
"optvals" : []
},
{
- "name" : "url",
+ "name" : "value",
"type" : "String",
- "desc" : "The URL to use for form actions if one isn't supplied in the action options.",
+ "desc" : "- the value of radio",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
- {
- "name" : "actioncomplete",
- "type" : "function",
- "desc" : "Fires when an action is completed.",
- "sig" : "function (_self, action)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Form",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "action",
- "type" : "Action",
- "desc" : "The action that completed",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "actionfailed",
- "type" : "function",
- "desc" : "Fires when an action fails.",
- "sig" : "function (_self, action)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Form",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "action",
- "type" : "Action",
- "desc" : "The action that failed",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeaction",
- "type" : "function",
- "desc" : "Fires before any action is performed. Return false to cancel the action.",
- "sig" : "function (_self, action)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Form",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "action",
- "type" : "Action",
- "desc" : "The action to be performed",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "clientvalidation",
- "type" : "function",
- "desc" : "If the monitorValid config option is true, this event fires repetitively to notify of valid state",
- "sig" : "function (_self, valid)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Form",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "valid",
- "type" : "Boolean",
- "desc" : "true if the form has passed client-side validation",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clears all invalid messages in this form.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "doAction",
- "type" : "function",
- "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.",
- "sig" : "(actionName, options)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "actionName",
- "type" : "String",
- "desc" : "The name of the action type",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) The options to pass to the action. All of the config options listed\nbelow are supported by both the submit and load actions unless otherwise noted (custom actions could also\naccept other config options):\n<pre>\nProperty Type Description\n---------------- --------------- ----------------------------------------------------------------------------------\nurl String The url for the action (defaults to the form's url)\nmethod String The form method to use (defaults to the form's method, or POST if not defined)\nparams String/Object The params to pass (defaults to the form's baseParams, or none if not defined)\nclientValidation Boolean Applies to submit only. Pass true to call form.isValid() prior to posting to\n validate the form on the client (defaults to false)\n</pre>",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
- },
{
"name" : "enable",
"type" : "function",
}
]
},
- {
- "name" : "findField",
- "type" : "function",
- "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The value to search for",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "",
- "desc" : "Field"
- }
- ]
- },
{
"name" : "fireEvent",
"type" : "function",
}
]
},
- {
- "name" : "getFieldValues",
- "type" : "function",
- "desc" : "Returns the fields in this form as an object with key/value pairs.\nThis differs from getValues as it calls getValue on each child item, rather than using dom data.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : ""
- }
- ]
- },
{
"name" : "getId",
"type" : "function",
}
]
},
- {
- "name" : "getValues",
- "type" : "function",
- "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.",
- "sig" : "(asString)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "asString",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : ""
- }
- ]
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "isDirty",
- "type" : "function",
- "desc" : "Returns true if any fields in this form have changed since their original load.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "",
- "desc" : "Boolean"
- }
- ]
- },
- {
- "name" : "isValid",
- "type" : "function",
- "desc" : "Returns true if client-side validation on the form is successful.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "",
- "desc" : "Boolean"
- }
- ]
- },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark fields in this form invalid in bulk.",
- "sig" : "(errors)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "errors",
- "type" : "Array/Object",
- "desc" : "Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
- },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets this form.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setValues",
- "type" : "function",
- "desc" : "Set values for fields in this form in bulk.",
- "sig" : "(values)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "values",
- "type" : "Array/Object",
- "desc" : "Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
- },
{
"name" : "setVisibilityEl",
"type" : "function",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.Alert",
- "Roo.bootstrap.BezierSignature",
- "Roo.bootstrap.Brick",
- "Roo.bootstrap.Button",
- "Roo.bootstrap.ButtonGroup",
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.Calendar",
- "Roo.bootstrap.Card",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.DocumentManager",
- "Roo.bootstrap.DocumentSlider",
- "Roo.bootstrap.DocumentViewer",
- "Roo.bootstrap.DropTarget",
- "Roo.bootstrap.Element",
- "Roo.bootstrap.Graph",
- "Roo.bootstrap.Header",
- "Roo.bootstrap.Img",
- "Roo.bootstrap.LayoutMasonry",
- "Roo.bootstrap.LayoutMasonryAuto",
- "Roo.bootstrap.Link",
- "Roo.bootstrap.LocationPicker",
- "Roo.bootstrap.MasonryBrick",
- "Roo.bootstrap.MessageBar",
- "Roo.bootstrap.Pagination",
- "Roo.bootstrap.PaginationItem",
- "Roo.bootstrap.PagingToolbar",
- "Roo.bootstrap.Progress",
- "Roo.bootstrap.ProgressBar",
- "Roo.bootstrap.Row",
- "Roo.bootstrap.Slider",
- "Roo.bootstrap.TabGroup",
- "Roo.bootstrap.TabPanel",
- "Roo.bootstrap.Table",
- "Roo.bootstrap.UploadCropbox",
- "Roo.bootstrap.breadcrumb.Nav",
- "Roo.bootstrap.dash.NumberBox",
- "Roo.bootstrap.dash.TabBox",
- "Roo.bootstrap.dash.TabPane",
- "Roo.bootstrap.form.CardUploader",
- "Roo.bootstrap.form.CheckBox",
- "Roo.bootstrap.form.ComboBox",
- "Roo.bootstrap.form.DateField",
- "Roo.bootstrap.form.DateSplitField",
- "Roo.bootstrap.form.FieldLabel",
- "Roo.bootstrap.form.Form",
- "Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.Input",
- "Roo.bootstrap.form.Markdown",
- "Roo.bootstrap.form.MoneyField",
- "Roo.bootstrap.form.MonthField",
- "Roo.bootstrap.form.NumberField",
- "Roo.bootstrap.form.Password",
- "Roo.bootstrap.form.PhoneInput",
- "Roo.bootstrap.form.Radio",
- "Roo.bootstrap.form.RadioSet",
- "Roo.bootstrap.form.SecurePass",
- "Roo.bootstrap.form.TextArea",
- "Roo.bootstrap.form.TimeField",
- "Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.nav.Group",
- "Roo.bootstrap.nav.Headerbar",
- "Roo.bootstrap.nav.ProgressBar",
- "Roo.bootstrap.nav.ProgressBarItem",
- "Roo.bootstrap.nav.Sidebar",
- "Roo.bootstrap.nav.SidebarItem",
- "Roo.bootstrap.nav.Simplebar"
- ],
+ "tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.HtmlEditor" : {
+ "Roo.bootstrap.form.RadioSet" : {
"props" : [
{
"name" : "accept",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "buttons",
- "type" : "Array",
- "desc" : "Array of toolbar's buttons. - defaults to empty",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "cols",
- "type" : "Number",
- "desc" : "Specifies the visible width of a text area",
- "memberOf" : "Roo.bootstrap.form.TextArea",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "container_method",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "forceFeedback",
"type" : "Boolean",
"false"
]
},
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "(in pixels)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "hideMode",
"type" : "String",
"visibility"
]
},
- {
- "name" : "html",
- "type" : "string",
- "desc" : "text",
- "memberOf" : "Roo.bootstrap.form.TextArea",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "indicatorpos",
"type" : "String",
"desc" : "t) default le",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : [
"left",
"right"
]
},
+ {
+ "name" : "inline",
+ "type" : "Boolean",
+ "desc" : "e) inline the element (default tru",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "button",
+ "checkbox",
+ "email",
+ "file",
+ "hidden",
+ "image",
+ "number",
+ "password",
+ "radio",
+ "range",
+ "reset",
+ "search",
+ "submit",
+ "text"
+ ]
+ },
{
"name" : "invalidClass",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "labelAlign",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "resize",
- "type" : "String",
- "desc" : "l) - css resize of eleme",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "none",
- "both",
- "horizontal",
- "vertical"
- ]
- },
- {
- "name" : "rows",
- "type" : "Number",
- "desc" : "Specifies the visible number of lines in a text area",
- "memberOf" : "Roo.bootstrap.form.TextArea",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "selectOnFocus",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "stylesheets",
- "type" : "Array",
- "desc" : "url of stylesheets. set to [] to disable stylesheets.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "toolbars",
- "type" : "Array|boolean",
- "desc" : "Array of toolbars, or names of toolbars. - true for standard, and false for none.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "tooltip",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "validationDelay",
"type" : "Number",
"optvals" : []
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "(in pixels)",
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "s) The text that appears beside the rad",
"memberOf" : "",
"isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "wrap",
- "type" : "string",
- "desc" : "d)Specifies how the text in a text area is to be wrapped when submitted in a fo",
- "memberOf" : "Roo.bootstrap.form.TextArea",
- "isOptional" : false,
"optvals" : [
- "soft",
- "hard"
+ "primary",
+ "warning",
+ "info",
+ "danger",
+ "success"
]
},
{
}
],
"events" : [
- {
- "name" : "activate",
- "type" : "function",
- "desc" : "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.form.HtmlEditor",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "autosave",
- "type" : "function",
- "desc" : "Auto save the htmlEditor value as a file into Events",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.form.HtmlEditor",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "beforepush",
- "type" : "function",
- "desc" : "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push.",
- "sig" : "function (_self, html)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.form.HtmlEditor",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "html",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforerender",
"type" : "function",
"returns" : []
},
{
- "name" : "beforesync",
+ "name" : "blur",
"type" : "function",
- "desc" : "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync.",
- "sig" : "function (_self, html)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.form.HtmlEditor",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "html",
- "type" : "String",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "",
- "sig" : "function ()\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "change",
"type" : "function",
- "desc" : "",
- "sig" : "function ()\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "editmodechange",
+ "name" : "check",
"type" : "function",
- "desc" : "Fires when the editor switches edit modes",
- "sig" : "function (_self, sourceEdit)\n{\n\n}",
+ "desc" : "Fires when the element is checked or unchecked.",
+ "sig" : "function (_self, item)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.form.HtmlEditor",
- "desc" : "",
+ "type" : "Roo.bootstrap.form.RadioSet",
+ "desc" : "This radio",
"isOptional" : false
},
{
- "name" : "sourceEdit",
- "type" : "Boolean",
- "desc" : "True if source edit, false if standard editing.",
+ "name" : "item",
+ "type" : "Roo.bootstrap.form.Radio",
+ "desc" : "The checked item",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "editorevent",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.",
+ "desc" : "Fires when the children have been rendered..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.form.HtmlEditor",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "enable",
+ "name" : "click",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when the element is click.",
+ "sig" : "function (_self, item, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "type" : "Roo.bootstrap.form.RadioSet",
+ "desc" : "This radio set",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "firstfocus",
- "type" : "function",
- "desc" : "Fires when on first focus - needed by toolbars..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.bootstrap.form.HtmlEditor",
- "desc" : "",
+ "name" : "item",
+ "type" : "Roo.bootstrap.form.Radio",
+ "desc" : "The checked item",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "focus",
- "type" : "function",
- "desc" : "",
- "sig" : "function ()\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "hide",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires after the component is destroyed.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "imageadd",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires when on any editor when an image is added (excluding paste)",
+ "desc" : "Fires after the component is disabled.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.form.HtmlEditor",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "imagedelete",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires when on any editor when an image is deleted",
- "sig" : "function (_self, img, oldSrc)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.form.HtmlEditor",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "img",
- "type" : "HTMLElement",
- "desc" : "could also be a figure if blocks are enabled",
- "isOptional" : false
- },
- {
- "name" : "oldSrc",
- "type" : "HTMLElement",
- "desc" : "source of image being replaced",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "imageupdated",
+ "name" : "focus",
"type" : "function",
- "desc" : "Fires when on any editor when an image is changed (excluding paste)",
- "sig" : "function (_self, img)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.form.HtmlEditor",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "img",
- "type" : "HTMLElement",
- "desc" : "could also be a figure if blocks are enabled",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "initialize",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires when the editor is fully initialized (including the iframe)",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.form.HtmlEditor",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
{
"name" : "paste",
"type" : "function",
- "desc" : "Fires when press user pastes into the editor",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.HtmlEditorCore",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "push",
- "type" : "function",
- "desc" : "Fires when the iframe editor is updated with content from the textarea.",
- "sig" : "function (_self, html)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the user pastes into input",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.form.HtmlEditor",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
},
{
- "name" : "html",
- "type" : "String",
- "desc" : "",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
"isOptional" : false
}
],
],
"returns" : []
},
- {
- "name" : "savedpreview",
- "type" : "function",
- "desc" : "preview the saved version of htmlEditor",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.form.HtmlEditor",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
{
"name" : "specialkey",
"type" : "function",
- "desc" : "",
- "sig" : "function ()\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "stylesheetsclick",
- "type" : "function",
- "desc" : "Fires when press the Sytlesheets button",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.HtmlEditorCore",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "sync",
- "type" : "function",
- "desc" : "Fires when the textarea is updated with content from the editor iframe.",
- "sig" : "function (_self, html)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.form.HtmlEditor",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
},
{
- "name" : "html",
- "type" : "String",
- "desc" : "",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
"isOptional" : false
}
],
"desc" : "Clear any invalid styles/messages for this field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.TextArea",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
- {
- "name" : "createToolbar",
- "type" : "function",
- "desc" : "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons.",
- "sig" : "(editor)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "editor",
- "type" : "HtmlEditor",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
{
"name" : "inputEl",
"type" : "function",
- "desc" : "return the real textarea element.",
+ "desc" : "return the real input element.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.TextArea",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Mark this field as invalid",
"sig" : "(msg)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.TextArea",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Mark this field as valid",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.TextArea",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
- {
- "name" : "toggleSourceEdit",
- "type" : "function",
- "desc" : "Toggles the editor between standard and source edit mode.",
- "sig" : "(sourceEdit)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "sourceEdit",
- "type" : "Boolean",
- "desc" : "(optional) True for source edit, false for standard",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "tooltipEl",
"type" : "function",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.bootstrap.form.HtmlEditorToolbar" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
+ "tree_children" : [
+ "Roo.bootstrap.form.Radio"
+ ],
"tree_parent" : []
},
- "Roo.bootstrap.form.HtmlEditorToolbar.Standard" : {
+ "Roo.bootstrap.form.SecurePass" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
+ },
{
"name" : "actionMode",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "align",
"type" : "String",
- "desc" : "t) alignme",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "desc" : "t) Default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : [
"left",
+ "center",
"right"
]
},
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"optvals" : []
},
{
- "name" : "arrangement",
- "type" : "Boolean",
- "desc" : "stacked | justified",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "name" : "autocomplete",
+ "type" : "String",
+ "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "btns",
- "type" : "Array",
- "desc" : "List of additional buttons.\n\n\nNEEDS Extra CSS? \n.x-html-editor-tb .x-edit-none .x-btn-text { background: none; }",
- "memberOf" : "",
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "user",
+ "camera"
+ ]
+ },
{
"name" : "cls",
"type" : "String",
"optvals" : []
},
{
- "name" : "disable",
- "type" : "Object",
- "desc" : "List of elements to disable..",
- "memberOf" : "",
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disableClass",
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "focusClass",
"type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default fal",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default tr",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "hideMode",
"type" : "String",
]
},
{
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "is inverted color",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "name" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "button",
+ "checkbox",
+ "email",
+ "file",
+ "hidden",
+ "image",
+ "number",
+ "password",
+ "radio",
+ "range",
+ "reset",
+ "search",
+ "submit",
+ "text"
+ ]
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "left"
+ ]
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "loadMask",
- "type" : "Boolean",
- "desc" : "e) loadMask on the b",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
+ "optvals" : []
},
{
- "name" : "main",
- "type" : "Boolean",
- "desc" : "e) main nav bar? default fal",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
+ "optvals" : []
+ },
+ {
+ "name" : "maxLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minimumStrength",
+ "type" : "Number",
+ "desc" : "invalid if the strength of the password input is less than the minimum strength (from 0 to 3) (default 2)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "placeholder",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "style",
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regexText",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tag",
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
"type" : "String",
- "desc" : "v) default is n",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
- "optvals" : [
- "header",
- "footer",
- "nav",
- "div"
- ]
+ "optvals" : []
},
{
"name" : "tooltip",
"optvals" : []
},
{
- "name" : "type",
+ "name" : "validClass",
"type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
- "optvals" : [
- "nav",
- "pills",
- "tabs"
- ]
+ "optvals" : []
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
]
},
{
- "name" : "weight",
+ "name" : "vtype",
"type" : "String",
- "desc" : "e) default is ligh",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
- "optvals" : [
- "light",
- "primary",
- "secondary",
- "success",
- "danger",
- "warning",
- "info",
- "dark",
- "white"
- ]
+ "optvals" : []
},
{
"name" : "xattr",
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"returns" : []
},
{
- "name" : "beforetoggle",
+ "name" : "blur",
"type" : "function",
- "desc" : "Fire before toggle the menu",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.nav.Bar",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "paste",
+ "type" : "function",
+ "desc" : "Fires after the user pastes into input",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
"returns" : []
},
{
- "name" : "collapse",
+ "name" : "clearInvalid",
"type" : "function",
- "desc" : "Collapse the navbar pulldown",
+ "desc" : "Clear any invalid styles/messages for this field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.nav.Bar",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expand the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.nav.Bar",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "fireEvent",
"type" : "function",
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "name The name field"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
"returns" : []
},
{
- "name" : "updateToolbar",
+ "name" : "validate",
"type" : "function",
- "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.",
+ "desc" : "Validates the field value",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
"tree_children" : [],
- "tree_parent" : [
- "Roo.bootstrap.form.HtmlEditor"
- ]
+ "tree_parent" : []
},
- "Roo.bootstrap.form.Input" : {
+ "Roo.bootstrap.form.TextArea" : {
"props" : [
{
"name" : "accept",
"type" : "String",
"desc" : "o) use for file input only. (default empt",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : [
"image",
"name" : "after",
"type" : "string",
"desc" : "- input group add on after",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "afterButton",
"type" : "Roo.bootstrap.Button",
"desc" : "to show before",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "align",
"type" : "String",
"desc" : "t) Default le",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : [
"left",
"name" : "allowBlank",
"type" : "Boolean",
"desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "autocomplete",
"type" : "String",
"desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "before",
"type" : "string",
"desc" : "- input group add on before",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "blankText",
"type" : "String",
"desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "capture",
"type" : "String",
"desc" : "a) use for file input only. (default empt",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : [
"user",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "cols",
+ "type" : "Number",
+ "desc" : "Specifies the visible width of a text area",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "container_method",
"type" : "string",
"name" : "disableKeyFilter",
"type" : "Boolean",
"desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "disabled",
"type" : "Boolean",
"desc" : "is it disabled",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "fieldLabel",
"type" : "string",
"desc" : "- the label associated",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "focusClass",
"type" : "String",
"desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "forceFeedback",
"type" : "Boolean",
"desc" : "e) Default fal",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : [
"true",
"name" : "hasFeedback",
"type" : "Boolean",
"desc" : "e) default tr",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : [
"true",
"visibility"
]
},
+ {
+ "name" : "html",
+ "type" : "string",
+ "desc" : "text",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "indicatorpos",
"type" : "String",
"desc" : "t) default le",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : [
"left",
"name" : "inputType",
"type" : "String",
"desc" : "",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : [
"button",
"name" : "invalidClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "invalidFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "invalidText",
"type" : "String",
"desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "labelAlign",
"type" : "String",
"desc" : "",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : [
"top",
"name" : "labelWidth",
"type" : "Number",
"desc" : "set the width of label",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "labellg",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "labelmd",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "labelsm",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "labelxs",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "lg",
"type" : "Number",
"desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "maskRe",
"type" : "String",
"desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "maxLength",
"type" : "Number",
"desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "maxLengthText",
"type" : "String",
"desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "md",
"type" : "Number",
"desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "minLength",
"type" : "Number",
"desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "minLengthText",
"type" : "String",
"desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "name",
"type" : "String",
"desc" : "name of the input",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "placeholder",
"type" : "string",
"desc" : "- placeholder to put in text.",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "preventMark",
"type" : "Boolean",
"desc" : "Do not show tick or cross if error/success",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "readOnly",
"type" : "Boolean",
"desc" : "Specifies that the field should be read-only",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "regex",
"type" : "RegExp",
"desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "regexText",
"type" : "String",
"desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "resize",
+ "type" : "string",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "none",
+ "both",
+ "horizontal",
+ "vertical",
+ "inherit",
+ "initial"
+ ]
+ },
+ {
+ "name" : "rows",
+ "type" : "Number",
+ "desc" : "Specifies the visible number of lines in a text area",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"name" : "selectOnFocus",
"type" : "Boolean",
"desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "size",
"type" : "string",
"desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "sm",
"type" : "Number",
"desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "validClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "validFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "validationDelay",
"type" : "Number",
"desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "validationEvent",
"type" : "String/Boolean",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "validator",
"type" : "Function",
"desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "value",
"type" : "string",
"desc" : "default value of the input",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"name" : "vtype",
"type" : "String",
"desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "wrap",
+ "type" : "string",
+ "desc" : "d)Specifies how the text in a text area is to be wrapped when submitted in a fo",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "soft",
+ "hard"
+ ]
+ },
{
"name" : "xattr",
"type" : "Object",
"name" : "xs",
"type" : "Number",
"desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
}
"type" : "function",
"desc" : "Fires when this field loses input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires just before the field blurs if the field value has changed.",
"sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when this field receives input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the field has been marked as invalid.",
"sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the key up",
"sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the user pastes into input",
"sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
"sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the field has been validated with no errors.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"desc" : "autocreate the label - also used by textara... ?? and others?",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns the name of the field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "inputEl",
"type" : "function",
- "desc" : "return the real input element.",
+ "desc" : "return the real textarea element.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
"sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
"sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Validates the field value",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
"sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [
- "Roo.bootstrap.form.CheckBox",
- "Roo.bootstrap.form.ComboBox",
- "Roo.bootstrap.form.DateField",
"Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.Markdown",
- "Roo.bootstrap.form.MoneyField",
- "Roo.bootstrap.form.MonthField",
- "Roo.bootstrap.form.NumberField",
- "Roo.bootstrap.form.Password",
- "Roo.bootstrap.form.PhoneInput",
- "Roo.bootstrap.form.RadioSet",
- "Roo.bootstrap.form.SecurePass",
- "Roo.bootstrap.form.TextArea",
- "Roo.bootstrap.form.TimeField",
- "Roo.bootstrap.form.TriggerField"
+ "Roo.bootstrap.form.Markdown"
],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.Markdown" : {
+ "Roo.bootstrap.form.TimeField" : {
"props" : [
{
"name" : "accept",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "cols",
- "type" : "Number",
- "desc" : "Specifies the visible width of a text area",
- "memberOf" : "Roo.bootstrap.form.TextArea",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "container_method",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "content",
- "type" : "string",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "dataId",
"type" : "string",
"false"
]
},
+ {
+ "name" : "format",
+ "type" : "String",
+ "desc" : "The default time format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'H:i').",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "hasFeedback",
"type" : "Boolean",
"visibility"
]
},
- {
- "name" : "html",
- "type" : "string",
- "desc" : "text",
- "memberOf" : "Roo.bootstrap.form.TextArea",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "indicatorpos",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "minuteStep",
+ "type" : "Number",
+ "desc" : "the minutes is always the multiple of a fixed number, default 1",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "name",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "resize",
- "type" : "string",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.form.TextArea",
- "isOptional" : false,
- "optvals" : [
- "none",
- "both",
- "horizontal",
- "vertical",
- "inherit",
- "initial"
- ]
- },
- {
- "name" : "rows",
- "type" : "Number",
- "desc" : "Specifies the visible number of lines in a text area",
- "memberOf" : "Roo.bootstrap.form.TextArea",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "selectOnFocus",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "wrap",
- "type" : "string",
- "desc" : "d)Specifies how the text in a text area is to be wrapped when submitted in a fo",
- "memberOf" : "Roo.bootstrap.form.TextArea",
- "isOptional" : false,
- "optvals" : [
- "soft",
- "hard"
- ]
- },
{
"name" : "xattr",
"type" : "Object",
"returns" : []
},
{
- "name" : "show",
+ "name" : "select",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when select a date.",
+ "sig" : "function (_self, date)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.form.DateField",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "date",
+ "type" : "Mixed",
+ "desc" : "The date value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires when this field show.",
+ "sig" : "function (thisthis, date)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "thisthis",
+ "type" : "Roo.bootstrap.form.DateField",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "date",
+ "type" : "Mixed",
+ "desc" : "The date value",
+ "isOptional" : false
}
],
"returns" : []
"desc" : "Clear any invalid styles/messages for this field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.TextArea",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "inputEl",
"type" : "function",
- "desc" : "return the real textarea element.",
+ "desc" : "return the real input element.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.TextArea",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Mark this field as invalid",
"sig" : "(msg)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.TextArea",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Mark this field as valid",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.TextArea",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.MoneyField" : {
+ "Roo.bootstrap.form.TriggerField" : {
"props" : [
{
"name" : "accept",
"right"
]
},
- {
- "name" : "allQuery",
- "type" : "String",
- "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "allowBlank",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "allowDecimals",
- "type" : "Boolean",
- "desc" : "False to disallow decimal values (defaults to true)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "allowNegative",
- "type" : "Boolean",
- "desc" : "False to prevent entering a negative sign (defaults to true)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowZero",
- "type" : "Boolean",
- "desc" : "False to blank out if the user enters '0' (defaults to true)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "alwaysQuery",
- "type" : "Boolean",
- "desc" : "Disable caching of results, and always send query",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "animate",
- "type" : "Boolean",
- "desc" : "default true",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "append",
- "type" : "Boolean",
- "desc" : "e) default fal",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "autoCreate",
- "type" : "Boolean/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoFocus",
- "type" : "Boolean",
- "desc" : "e) auto focus the first item, default tr",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
{
"name" : "autocomplete",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "blockFocus",
- "type" : "Boolean",
- "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "btnPosition",
- "type" : "String",
- "desc" : "set the position of the trigger button (left | right) default right",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"name" : "caret",
"type" : "String",
"desc" : "r) BS3 only - carat fa na",
- "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : [
"search",
"calendar"
]
},
- {
- "name" : "castInt",
- "type" : "Boolean",
- "desc" : "e) cast int if true (defalut tru",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
{
"name" : "cls",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "decimalPrecision",
- "type" : "Number",
- "desc" : "The maximum precision to display after the decimal separator (defaults to 2)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "decimalSeparator",
- "type" : "String",
- "desc" : "Character(s) to allow as the decimal separator (defaults to '.')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "defaults",
- "type" : "String",
- "desc" : "currency of the MoneyField\nvalue should be in lkey",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "disableClass",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "disableClear",
- "type" : "Boolean",
- "desc" : "Disable showing of clear button.",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "disableKeyFilter",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "displayField",
- "type" : "String",
- "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "editable",
- "type" : "Boolean",
- "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "emptyResultText",
- "type" : "Boolean",
- "desc" : "only for touch device",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "emptyTitle",
- "type" : "String",
- "desc" : "default ''",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "fieldLabel",
"type" : "string",
"false"
]
},
- {
- "name" : "forceSelection",
- "type" : "Boolean",
- "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "grow",
- "type" : "Boolean",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "growMax",
- "type" : "Number",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "growMin",
- "type" : "Number",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "handleHeight",
- "type" : "Number",
- "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "hasFeedback",
"type" : "Boolean",
"false"
]
},
- {
- "name" : "hiddenName",
- "type" : "String",
- "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "hideMode",
"type" : "String",
"name" : "hideTrigger",
"type" : "Boolean",
"desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
"name" : "invalidClass",
"type" : "String",
- "desc" : "DEPRICATED - uses BS4 is-valid now",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "lazyRender",
- "type" : "Boolean",
- "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "lg",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "listAlign",
- "type" : "String",
- "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listClass",
- "type" : "String",
- "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listWidth",
- "type" : "Number",
- "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "loadingText",
- "type" : "String",
- "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "maskRe",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "maxHeight",
- "type" : "Number",
- "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "maxLength",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "maxText",
- "type" : "String",
- "desc" : "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxValue",
- "type" : "Number",
- "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "max_length",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "md",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "minChars",
- "type" : "Number",
- "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "minLength",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "minListWidth",
- "type" : "Number",
- "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minText",
- "type" : "String",
- "desc" : "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minValue",
- "type" : "Number",
- "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "mobileTouchView",
- "type" : "Boolean",
- "desc" : "e) show mobile touch view when using a mobile default tr",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "mobile_restrict_height",
- "type" : "Boolean",
- "desc" : "e) restrict height for touch vi",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "modalTitle",
- "type" : "String",
- "desc" : "The title of the dialog that pops up on mobile views.",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "mode",
- "type" : "String",
- "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "multiple",
- "type" : "Boolean",
- "desc" : "e) ComboBobArray, default fal",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
{
"name" : "name",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "nanText",
- "type" : "String",
- "desc" : "Error text to display if the value is not a valid number. For example, this can happen\nif a valid character like '.' or '-' is left in the field with no number (defaults to \"{value} is not a valid number\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "pageSize",
- "type" : "Number",
- "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "placeholder",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "queryDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "queryParam",
- "type" : "String",
- "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "readOnly",
"type" : "Boolean",
"name" : "removable",
"type" : "Boolean",
"desc" : "e) special filter default fal",
- "memberOf" : "Roo.bootstrap.form.TriggerField",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "resizable",
- "type" : "Boolean",
- "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "selectedClass",
- "type" : "String",
- "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "shadow",
- "type" : "Boolean/String",
- "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "showToggleBtn",
- "type" : "Boolean",
- "desc" : "show toggle button or not (true|false) default true",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "size",
- "type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "specialFilter",
- "type" : "Boolean",
- "desc" : "e) special filter default fal",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : [
"true",
- "false"
- ]
- },
- {
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "Store to lookup currency??",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "thousandsDelimiter",
- "type" : "String",
- "desc" : "Symbol of thousandsDelimiter",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "tickable",
- "type" : "Boolean",
- "desc" : "ComboBox with tickable selections (true|false), default false",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "title",
- "type" : "String",
- "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "tpl",
- "type" : "String/Roo.Template",
- "desc" : "The template to use to render the output default is '<a class=\"dropdown-item\" href=\"#\">{' + this.displayField + '}</a>'",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
+ "false"
+ ]
},
{
- "name" : "triggerAction",
- "type" : "String",
- "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "triggerClass",
- "type" : "String",
- "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
- "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "triggerList",
- "type" : "Boolean",
- "desc" : "trigger show the list or not (true|false) default true",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "triggerText",
+ "name" : "style",
"type" : "String",
- "desc" : "multiple combobox trigger button text default 'Select'",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "typeAhead",
- "type" : "Boolean",
- "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "typeAheadDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "name" : "triggerClass",
+ "type" : "String",
+ "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "useNativeIOS",
- "type" : "Boolean",
- "desc" : "e) render it as classic select for ios, not support dynamic load data (default fals",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
{
"name" : "validClass",
"type" : "String",
- "desc" : "DEPRICATED - uses BS4 is-valid now",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "valueField",
- "type" : "String",
- "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "valueNotFoundText",
- "type" : "String",
- "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "visibilityEl",
"type" : "string|object",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "fixed with? experimental",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "xattr",
"type" : "Object",
}
],
"events" : [
- {
- "name" : "add",
- "type" : "function",
- "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "afterremove",
- "type" : "function",
- "desc" : "Fires when the remove value from the combobox array",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "beforequery",
- "type" : "function",
- "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
- "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "query",
- "type" : "String",
- "desc" : "The query",
- "isOptional" : false
- },
- {
- "name" : "forceAll",
- "type" : "Boolean",
- "desc" : "true to force \"all\" query",
- "isOptional" : false
- },
- {
- "name" : "cancel",
- "type" : "Boolean",
- "desc" : "true to cancel the query",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Object",
- "desc" : "The query event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforerender",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "beforeselect",
- "type" : "function",
- "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
- "sig" : "function (combo, record, index)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The data record returned from the underlying store",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the selected item in the dropdown list",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforeshow",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Fires when the dropdown list is collapsed",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "edit",
- "type" : "function",
- "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo, record)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record|false",
- "desc" : "The data record returned from the underlying store (or false on nothing selected)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Fires when the dropdown list is expanded",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "focus",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "remove",
- "type" : "function",
- "desc" : "Fires when the remove value from the combobox array",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when a list item is selected",
- "sig" : "function (combo, record, index)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The data record returned from the underlying store (or false on clear)",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the selected item in the dropdown list",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "specialfilter",
- "type" : "function",
- "desc" : "Fires when specialfilter",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "specialkey",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "tick",
- "type" : "function",
- "desc" : "Fires when tick the element",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "touchviewdisplay",
- "type" : "function",
- "desc" : "Fires when touch view require special display (default is using displayField)",
- "sig" : "function (combo, cfg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "cfg",
- "type" : "Object",
- "desc" : "set html .",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "valid",
"type" : "function",
"desc" : "",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
- {
- "name" : "clearValue",
- "type" : "function",
- "desc" : "Clears any text/value currently set in the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "doQuery",
- "type" : "function",
- "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
- "sig" : "(query, forceAll)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "query",
- "type" : "String",
- "desc" : "The SQL query to execute",
- "isOptional" : false
- },
- {
- "name" : "forceAll",
- "type" : "Boolean",
- "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
}
]
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "fireEvent",
"type" : "function",
{
"name" : "getValue",
"type" : "function",
- "desc" : "Returns the currently selected field value or empty string if no value is set.",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "value The selected value"
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
]
},
"params" : [],
"returns" : []
},
- {
- "name" : "isExpanded",
- "type" : "function",
- "desc" : "Returns true if the dropdown list is expanded, else false.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "isVisible",
"type" : "function",
"desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
"sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setVisibilityEl",
+ "type" : "function",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
+ }
+ ]
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.PhoneInput"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.layout" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.layout.Basic" : {
+ "props" : [
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "mgr",
+ "type" : "Roo.bootstrap.layout.Manager",
+ "desc" : "The manager",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "region",
+ "type" : "string",
+ "desc" : "the region that it inhabits..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "skipConfig",
+ "type" : "bool",
+ "desc" : "skip config?",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "add",
+ "type" : "function",
+ "desc" : "Add the passed ContentPanel(s)",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "ContentPanel...",
+ "desc" : "The ContentPanel(s) to add (you can pass more than one)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel added (if only one was added)"
+ }
+ ]
+ },
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "capture",
+ "type" : "function",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "fireEvent",
+ "type" : "function",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "reset",
+ "name" : "getActivePanel",
"type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "desc" : "Get the active panel for this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The active panel or null"
+ }
+ ]
},
{
- "name" : "select",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(index, scrollIntoView)",
+ "desc" : "Returns the container element for this region.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The zero-based index of the list item to select",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "scrollIntoView",
- "type" : "Boolean",
- "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "selectByValue",
+ "name" : "getPanel",
"type" : "function",
- "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(value, scrollIntoView)",
+ "desc" : "Returns the panel specified or null if it's not in this region.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "String",
- "desc" : "The data value of the item to select",
- "isOptional" : false
- },
- {
- "name" : "scrollIntoView",
- "type" : "Boolean",
- "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the value matched an item in the list, else false"
+ "type" : "Roo.ContentPanel",
+ "desc" : ""
}
]
},
{
- "name" : "setDisabled",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Returns this regions position (north/south/east/west/center).",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setEditable",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
- "sig" : "(value)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Boolean",
- "desc" : "True to allow the user to directly edit the field text",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "setFromData",
+ "name" : "hasPanel",
"type" : "function",
- "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
- "sig" : "(value)",
+ "desc" : "Returns true if the panel is in this region.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Object",
- "desc" : "the value to set as. or false on reset?",
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "setRawValue",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
+ "desc" : "Returns true if this region is currently visible.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setValue",
+ "name" : "on",
"type" : "function",
- "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
- "sig" : "(value)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The value to match",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setVisibilityEl",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Set the element that will be used to show or hide",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
"returns" : []
},
{
- "name" : "tooltipEl",
+ "name" : "remove",
"type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
+ "sig" : "(panel, preservePanel)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
+ "isOptional" : false
+ },
+ {
+ "name" : "preservePanel",
+ "type" : "Boolean",
+ "desc" : "Overrides the config preservePanel option",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel that was removed"
}
]
},
{
- "name" : "un",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
+ "desc" : "Removes a listener",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"returns" : []
},
{
- "name" : "validate",
+ "name" : "resizeTo",
"type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
+ "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
+ "sig" : "(newSize)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new width or height",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "validateValue",
+ "name" : "showPanel",
"type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
+ "desc" : "Show the specified panel.",
+ "sig" : "(panelId)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
+ "name" : "panelId",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "type" : "Roo.ContentPanel",
+ "desc" : "The shown panel or null"
}
]
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
+ "implementations" : [
+ "Roo.bootstrap.layout.Region"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.MonthField" : {
+ "Roo.bootstrap.layout.Border" : {
"props" : [
- {
- "name" : "accept",
- "type" : "String",
- "desc" : "o) use for file input only. (default empt",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "image",
- "video",
- "audio"
- ]
- },
{
"name" : "actionMode",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "afterButton",
- "type" : "Roo.bootstrap.Button",
- "desc" : "to show before",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) Default le",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "left",
- "center",
- "right"
- ]
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "autocomplete",
- "type" : "String",
- "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"optvals" : []
},
{
- "name" : "capture",
- "type" : "String",
- "desc" : "a) use for file input only. (default empt",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "center",
+ "type" : "Roo.bootstrap.layout.Region",
+ "desc" : "region to go in center",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "user",
- "camera"
- ]
+ "optvals" : []
},
{
"name" : "cls",
"optvals" : []
},
{
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "east",
+ "type" : "Roo.bootstrap.layout.Region",
+ "desc" : "region to go in east",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : "e) Default fal",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : "e) default tr",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
{
"name" : "hideMode",
"type" : "String",
"visibility"
]
},
- {
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : "t) default le",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "left",
- "right"
- ]
- },
- {
- "name" : "inputType",
- "type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "button",
- "checkbox",
- "email",
- "file",
- "hidden",
- "image",
- "number",
- "password",
- "radio",
- "range",
- "reset",
- "search",
- "submit",
- "text"
- ]
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelAlign",
- "type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "top",
- "left"
- ]
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "language",
- "type" : "String",
- "desc" : "default en",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "placeholder",
"type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "size",
- "type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "north",
+ "type" : "Roo.bootstrap.layout.Region",
+ "desc" : "region to go in north",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "south",
+ "type" : "Roo.bootstrap.layout.Region",
+ "desc" : "region to go in south",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "value",
- "type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "visibilityEl",
"type" : "string|object",
]
},
{
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "west",
+ "type" : "Roo.bootstrap.layout.Region",
+ "desc" : "region to go in west",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
}
],
"events" : [
],
"returns" : []
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "childrenrendered",
"type" : "function",
"returns" : []
},
{
- "name" : "focus",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires when this field receives input focus.",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "hide",
+ "name" : "layout",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires when a layout is performed.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.layout.Manager",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "invalid",
+ "name" : "regioncollapsed",
"type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Fires when a region is collapsed.",
+ "sig" : "function (region)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
+ "name" : "region",
+ "type" : "Roo.layout.Region",
+ "desc" : "The collapsed region",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "keyup",
+ "name" : "regionexpanded",
"type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Fires when a region is expanded.",
+ "sig" : "function (region)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
+ "name" : "region",
+ "type" : "Roo.layout.Region",
+ "desc" : "The expanded region",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "paste",
+ "name" : "regionresized",
"type" : "function",
- "desc" : "Fires after the user pastes into input",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Fires when the user resizes a region.",
+ "sig" : "function (region, newSize)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "region",
+ "type" : "Roo.layout.Region",
+ "desc" : "The resized region",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new size (width for east/west, height for north/south)",
"isOptional" : false
}
],
],
"returns" : []
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when select a date.",
- "sig" : "function (_self, oldvalue, newvalue)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.form.MonthField",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "oldvalue",
- "type" : "String",
- "desc" : "The old value",
- "isOptional" : false
- },
- {
- "name" : "newvalue",
- "type" : "String",
- "desc" : "The new value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
- "desc" : "Fires when this field show.",
- "sig" : "function (_self, date)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.form.MonthField",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "date",
- "type" : "Mixed",
- "desc" : "The date value",
- "isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "specialkey",
+ "name" : "add",
"type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Adds a ContentPanel (or subclass) to this layout.",
+ "sig" : "(target, panel)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "target",
+ "type" : "String",
+ "desc" : "The target region key (north, south, east, west or center).",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "panel",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel to add",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "methods" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The added panel"
+ }
+ ]
+ },
{
"name" : "addEvents",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "addRegion",
+ "type" : "function",
+ "desc" : "Creates and adds a new region if it doesn't already exist.",
+ "sig" : "(target, config)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "String",
+ "desc" : "The target region key (north, south, east, west or center).",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The regions config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BorderLayoutRegion",
+ "desc" : "The new region"
+ }
+ ]
+ },
+ {
+ "name" : "addxtype",
+ "type" : "function",
+ "desc" : "Adds a xtype elements to the layout.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'ContentPanel',\n region: 'west',\n items: [ .... ]\n }\n);\n\nlayout.addxtype({\n xtype : 'NestedLayoutPanel',\n region: 'west',\n layout: {\n center: { },\n west: { } \n },\n items : [ ... list of content panels or nested layout panels.. ]\n }\n);\n</code></pre>",
+ "sig" : "(cfg)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "cfg",
+ "type" : "Object",
+ "desc" : "Xtype definition of item to add.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beginUpdate",
+ "type" : "function",
+ "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.layout.Manager",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
"returns" : []
},
{
- "name" : "clearInvalid",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "disable",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "desc" : "Disable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "disable",
+ "name" : "enable",
"type" : "function",
- "desc" : "Disable this component.",
+ "desc" : "Enable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component",
]
},
{
- "name" : "enable",
+ "name" : "endUpdate",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
+ "sig" : "(noLayout)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "noLayout",
+ "type" : "Boolean",
+ "desc" : "true to disable a layout update",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "findPanel",
+ "type" : "function",
+ "desc" : "Searches all regions for a panel with the specified id",
+ "sig" : "(panelId)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panelId",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel or null if it wasn't found"
}
]
},
}
]
},
- {
- "name" : "getAutoCreateLabel",
- "type" : "function",
- "desc" : "autocreate the label - also used by textara... ?? and others?",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "getChildContainer",
"type" : "function",
{
"name" : "getEl",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Returns the Element this layout is bound to.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "The element"
+ "desc" : ""
}
]
},
]
},
{
- "name" : "getName",
+ "name" : "getRegion",
"type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the specified region.",
+ "sig" : "(target)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Mixed",
- "desc" : "name The name field"
+ "name" : "target",
+ "type" : "String",
+ "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ ],
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "Roo.layout.Region",
+ "desc" : ""
}
]
},
{
- "name" : "getValue",
+ "name" : "getViewSize",
"type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "Object",
+ "desc" : "The size as an object {width: (the width), height: (the height)}"
}
]
},
"returns" : []
},
{
- "name" : "inputEl",
+ "name" : "isUpdating",
"type" : "function",
- "desc" : "return the real input element.",
+ "desc" : "Returns true if this layout is currently being updated",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
"name" : "isVisible",
"returns" : []
},
{
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "markValid",
+ "name" : "layout",
"type" : "function",
- "desc" : "Mark this field as valid",
+ "desc" : "Performs a layout update.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
},
+ {
+ "name" : "remove",
+ "type" : "function",
+ "desc" : "Remove a ContentPanel (or subclass) to this layout.",
+ "sig" : "(target, panel)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "String",
+ "desc" : "The target region key (north, south, east, west or center).",
+ "isOptional" : false
+ },
+ {
+ "name" : "panel",
+ "type" : "Number/String/Roo.ContentPanel",
+ "desc" : "The index, id or panel to remove",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The removed panel"
+ }
+ ]
+ },
{
"name" : "removeListener",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
- },
- {
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.bootstrap.form.MultiLineTag" : {
- "props" : [],
- "events" : [
- {
- "name" : "beforeload",
- "type" : "function",
- "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.",
- "sig" : "function (_self, store, options)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.boostrap.form.MultiLineTag",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "store",
- "type" : "Store",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "The loading options that were specified (see {@link #load} for details)",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.bootstrap.form.NumberField" : {
- "props" : [
- {
- "name" : "accept",
- "type" : "String",
- "desc" : "o) use for file input only. (default empt",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "image",
- "video",
- "audio"
- ]
- },
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "afterButton",
- "type" : "Roo.bootstrap.Button",
- "desc" : "to show before",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) Default le",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "left",
- "center",
- "right"
- ]
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowDecimals",
- "type" : "Boolean",
- "desc" : "False to disallow decimal values (defaults to true)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowNegative",
- "type" : "Boolean",
- "desc" : "False to prevent entering a negative sign (defaults to true)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowZero",
- "type" : "Boolean",
- "desc" : "False to blank out if the user enters '0' (defaults to true)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autocomplete",
- "type" : "String",
- "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "capture",
- "type" : "String",
- "desc" : "a) use for file input only. (default empt",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "user",
- "camera"
- ]
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "decimalPrecision",
- "type" : "Number",
- "desc" : "The maximum precision to display after the decimal separator (defaults to 2)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "decimalSeparator",
- "type" : "String",
- "desc" : "Character(s) to allow as the decimal separator (defaults to '.')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : "e) Default fal",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : "e) default tr",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
- },
- {
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : "t) default le",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "left",
- "right"
- ]
- },
- {
- "name" : "inputType",
- "type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "button",
- "checkbox",
- "email",
- "file",
- "hidden",
- "image",
- "number",
- "password",
- "radio",
- "range",
- "reset",
- "search",
- "submit",
- "text"
- ]
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelAlign",
- "type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "top",
- "left"
- ]
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxText",
- "type" : "String",
- "desc" : "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxValue",
- "type" : "Number",
- "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
- "name" : "minText",
- "type" : "String",
- "desc" : "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")",
+ "name" : "showPanel",
+ "type" : "function",
+ "desc" : "Searches all regions for a panel with the specified id and activates (shows) it.",
+ "sig" : "(panelId)",
+ "static" : false,
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panelId",
+ "type" : "String/ContentPanel",
+ "desc" : "The panels id or the panel itself",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The shown panel or null"
+ }
+ ]
},
{
- "name" : "minValue",
- "type" : "Number",
- "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
+ }
+ ]
},
{
- "name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [
+ "Roo.bootstrap.panel.Content",
+ "Roo.bootstrap.panel.Grid",
+ "Roo.bootstrap.panel.Nest",
+ "Roo.bootstrap.panel.Nest",
+ "Roo.bootstrap.panel.Grid"
+ ],
+ "tree_parent" : [
+ "builder",
+ "Roo.bootstrap.panel.Nest",
+ "Roo.bootstrap.panel.Nest",
+ "Roo.bootstrap.Modal"
+ ]
+ },
+ "Roo.bootstrap.layout.Manager" : {
+ "props" : [
{
- "name" : "nanText",
+ "name" : "actionMode",
"type" : "String",
- "desc" : "Error text to display if the value is not a valid number. For example, this can happen\nif a valid character like '.' or '-' is left in the field with no number (defaults to \"{value} is not a valid number\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "placeholder",
- "type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "preventMark",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "readOnly",
+ "name" : "can_build_overlaid",
"type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "regexText",
+ "name" : "cls",
"type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "size",
+ "name" : "container_method",
"type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "thousandsDelimiter",
- "type" : "String",
- "desc" : "Symbol of thousandsDelimiter",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "tooltip",
+ "name" : "dataId",
"type" : "string",
- "desc" : "Text for the tooltip",
+ "desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "validClass",
+ "name" : "disableClass",
"type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "validFeedbackIcon",
+ "name" : "hideMode",
"type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "value",
+ "name" : "tooltip",
"type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "valueAlign",
- "type" : "String",
- "desc" : "alignment of value",
- "memberOf" : "",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
"parent"
]
},
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "xattr",
"type" : "Object",
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
}
],
"events" : [
"returns" : []
},
{
- "name" : "blur",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires when this field loses input focus.",
+ "desc" : "Fires when the children have been rendered..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "change",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
+ "desc" : "Fires after the component is disabled.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
+ "desc" : "Fires after the component is enabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "disable",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "enable",
+ "name" : "layout",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
+ "desc" : "Fires when a layout is performed.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.layout.Manager",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "focus",
+ "name" : "regioncollapsed",
"type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Fires when a region is collapsed.",
+ "sig" : "function (region)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "region",
+ "type" : "Roo.layout.Region",
+ "desc" : "The collapsed region",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "hide",
+ "name" : "regionexpanded",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires when a region is expanded.",
+ "sig" : "function (region)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "region",
+ "type" : "Roo.layout.Region",
+ "desc" : "The expanded region",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "regionresized",
+ "type" : "function",
+ "desc" : "Fires when the user resizes a region.",
+ "sig" : "function (region, newSize)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "region",
+ "type" : "Roo.layout.Region",
+ "desc" : "The resized region",
+ "isOptional" : false
+ },
+ {
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new size (width for east/west, height for north/south)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "invalid",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "keyup",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "paste",
+ "name" : "beginUpdate",
"type" : "function",
- "desc" : "Fires after the user pastes into input",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "capture",
+ "type" : "function",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "this",
+ "name" : "",
"type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "show",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "this",
+ "name" : "",
"type" : "Roo.Component",
- "desc" : "",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "endUpdate",
+ "type" : "function",
+ "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
+ "sig" : "(noLayout)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "noLayout",
+ "type" : "Boolean",
+ "desc" : "true to disable a layout update",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "specialkey",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
+ "name" : "eventName",
+ "type" : "String",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "getChildContainer",
+ "type" : "function",
+ "desc" : "Fetch the element to add children to",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
+ }
+ ]
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns the Element this layout is bound to.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getId",
+ "type" : "function",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getRegion",
+ "type" : "function",
+ "desc" : "Returns the specified region.",
+ "sig" : "(target)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "String",
+ "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')",
"isOptional" : false
}
],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.layout.Region",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getViewSize",
+ "type" : "function",
+ "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "The size as an object {width: (the width), height: (the height)}"
+ }
+ ]
+ },
+ {
+ "name" : "getVisibilityEl",
+ "type" : "function",
+ "desc" : "Get the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "valid",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Hide a component - adds 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "initEvents",
+ "type" : "function",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isUpdating",
+ "type" : "function",
+ "desc" : "Returns true if this layout is currently being updated",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "on",
+ "type" : "function",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
- "name" : "addEvents",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
"memberOf" : "Roo.util.Observable",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "render",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "clearInvalid",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "desc" : "Set the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "disable",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
"memberOf" : "Roo.Component",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
]
},
{
- "name" : "enable",
+ "name" : "show",
"type" : "function",
- "desc" : "Enable this component.",
+ "desc" : "Show a component - removes 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
{
- "name" : "fireEvent",
+ "name" : "un",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : true,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.bootstrap.layout.Border"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.layout.Region" : {
+ "props" : [
+ {
+ "name" : "alwaysShowTabs",
+ "type" : "Boolean",
+ "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean",
+ "desc" : "True to animate expand/collapse (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoHide",
+ "type" : "Boolean",
+ "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoScroll",
+ "type" : "Boolean",
+ "desc" : "True to enable overflow scrolling (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "closeOnTab",
+ "type" : "Boolean",
+ "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cls",
+ "type" : "string",
+ "desc" : "Extra CSS classes to add to region",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cmargins",
+ "type" : "Object",
+ "desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableTabTips",
+ "type" : "Boolean",
+ "desc" : "True to disable tab tooltips",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "For North/South panels",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "True to start the region hidden (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideTabs",
+ "type" : "Boolean",
+ "desc" : "True to hide the tab strip (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideWhenEmpty",
+ "type" : "Boolean",
+ "desc" : "True to hide the region when it has no panels",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "margins",
+ "type" : "Object",
+ "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "mgr",
+ "type" : "Roo.bootstrap.layout.Manager",
+ "desc" : "The manager",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minTabWidth",
+ "type" : "Number",
+ "desc" : "The minimum tab width (defaults to 40)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "overflow",
+ "type" : "String",
+ "desc" : "e) if you have menus in the region, then you need to set this to visibl",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "hidden",
+ "visible"
]
},
{
- "name" : "focus",
+ "name" : "preferredTabWidth",
+ "type" : "Number",
+ "desc" : "The preferred tab width (defaults to 150)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "preservePanels",
+ "type" : "Boolean",
+ "desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "region",
+ "type" : "string",
+ "desc" : "the region that it inhabits..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "resizeTabs",
+ "type" : "Boolean",
+ "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "skipConfig",
+ "type" : "bool",
+ "desc" : "skip config?",
+ "memberOf" : "Roo.bootstrap.layout.Basic",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "split",
+ "type" : "Boolean",
+ "desc" : "To show the splitter",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tabPosition",
+ "type" : "String",
+ "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "bottom"
+ ]
+ },
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title for the region (overrides panel titles)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "titlebar",
+ "type" : "Boolean",
+ "desc" : "True to display a title bar (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "toolbar",
+ "type" : "Boolean",
+ "desc" : "xtype configuration for a toolbar - shows on right of tabbar",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "For East/West panels",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "add",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Adds the passed ContentPanel(s) to this region.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "name" : "panel",
+ "type" : "ContentPanel...",
+ "desc" : "The ContentPanel(s) to add (you can pass more than one)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel added (if only one was added; null otherwise)"
}
]
},
{
- "name" : "getAutoCreateLabel",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "autocreate the label - also used by textara... ?? and others?",
- "sig" : "()\n{\n\n}",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "getChildContainer",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getEl",
+ "name" : "animateCollapse",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Collapses this region.",
+ "sig" : "(skipAnim)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "name" : "skipAnim",
+ "type" : "Boolean",
+ "desc" : "(optional) true to collapse the element without animation (if animate is true)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getId",
+ "name" : "animateExpand",
"type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Expands this region if it was previously collapsed.",
+ "sig" : "(e, skipAnim)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : ""
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event that triggered the expand (or null if calling manually)",
+ "isOptional" : false
+ },
+ {
+ "name" : "skipAnim",
+ "type" : "Boolean",
+ "desc" : "(optional) true to expand the element without animation (if animate is true)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getName",
+ "name" : "capture",
"type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "fireEvent",
+ "type" : "function",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "name The name field"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "getRawValue",
+ "name" : "getActivePanel",
"type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "desc" : "Get the active panel for this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "Roo.ContentPanel",
+ "desc" : "The active panel or null"
}
]
},
{
- "name" : "getValue",
+ "name" : "getBox",
"type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)",
+ "sig" : "(title)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "name" : "title",
+ "type" : "String",
+ "desc" : "(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, \"&#160;\")",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getVisibilityEl",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Get the element that will be used to show or hide",
+ "desc" : "Returns the container element for this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "hasListener",
+ "name" : "getPanel",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Returns the panel specified or null if it's not in this region.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.bootstrap.layout.Basic",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "Roo.ContentPanel",
+ "desc" : ""
}
]
},
{
- "name" : "hide",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
+ "desc" : "Returns this regions position (north/south/east/west/center).",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.layout.Basic",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "initEvents",
+ "name" : "getTabs",
"type" : "function",
- "desc" : "Initialize Events for the element",
+ "desc" : "Returns the TabPanel component used by this region",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.TabPanel",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "inputEl",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "isVisible",
+ "name" : "hasPanel",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
+ "desc" : "Returns true if the panel is in this region.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.layout.Basic",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Hides this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "markInvalid",
+ "name" : "hidePanel",
"type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
+ "desc" : "Hides the tab for the specified panel.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "markValid",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Mark this field as valid",
+ "desc" : "Returns true if this region is currently visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
"name" : "on",
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "remove",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
+ "sig" : "(panel, preservePanel)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "preservePanel",
+ "type" : "Boolean",
+ "desc" : "Overrides the config preservePanel option",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ "returns" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel that was removed"
}
- ],
- "returns" : []
- },
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
+ ]
},
{
- "name" : "setDisabled",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setValue",
+ "name" : "resizeTo",
"type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
+ "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
+ "sig" : "(newSize)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.bootstrap.layout.Basic",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new width or height",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setVisibilityEl",
+ "name" : "show",
"type" : "function",
- "desc" : "Set the element that will be used to show or hide",
+ "desc" : "Shows this region if it was previously hidden.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "showPanel",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Shows the specified panel.",
+ "sig" : "(panelId)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "panelId",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Roo.ContentPanel",
+ "desc" : "The shown panel, or null if a panel could not be found from panelId"
}
]
},
"returns" : []
},
{
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "validateValue",
+ "name" : "unhidePanel",
"type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
+ "desc" : "Unhides the tab for a previously hidden panel.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.Password" : {
+ "Roo.bootstrap.layout.Split" : {
"props" : [
{
- "name" : "accept",
- "type" : "String",
- "desc" : "o) use for file input only. (default empt",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "image",
- "video",
- "audio"
- ]
- },
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "afterButton",
- "type" : "Roo.bootstrap.Button",
- "desc" : "to show before",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) Default le",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "left",
- "center",
- "right"
- ]
- },
- {
- "name" : "allowBlank",
+ "name" : "alwaysShowTabs",
"type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "allowDomMove",
+ "name" : "animate",
"type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autocomplete",
- "type" : "String",
- "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "True to animate expand/collapse (defaults to false)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "can_build_overlaid",
+ "name" : "autoHide",
"type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "capture",
- "type" : "String",
- "desc" : "a) use for file input only. (default empt",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "user",
- "camera"
- ]
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
+ "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disableKeyFilter",
+ "name" : "autoScroll",
"type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "True to enable overflow scrolling (defaults to false)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disabled",
+ "name" : "closeOnTab",
"type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "cmargins",
+ "type" : "Object",
+ "desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : "e) Default fal",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "hasFeedback",
+ "name" : "collapsed",
"type" : "Boolean",
- "desc" : "e) default tr",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
- },
- {
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : "t) default le",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "left",
- "right"
- ]
- },
- {
- "name" : "inputType",
- "type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "button",
- "checkbox",
- "email",
- "file",
- "hidden",
- "image",
- "number",
- "password",
- "radio",
- "range",
- "reset",
- "search",
- "submit",
- "text"
- ]
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "True to set the initial display to collapsed (defaults to false)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "invalidFeedbackIcon",
+ "name" : "collapsedTitle",
"type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Optional string message to display in the collapsed block of a north or south region",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "collapsible",
+ "type" : "Boolean",
+ "desc" : "False to disable collapsing (defaults to true)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "labelAlign",
- "type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "top",
- "left"
- ]
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "disableTabTips",
+ "type" : "Boolean",
+ "desc" : "True to disable tab tooltips",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "floatable",
+ "type" : "Boolean",
+ "desc" : "False to disable floating (defaults to true)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "labelmd",
+ "name" : "height",
"type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "For North/South panels",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "True to start the region hidden (defaults to false)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "hideTabs",
+ "type" : "Boolean",
+ "desc" : "True to hide the tab strip (defaults to false)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "hideWhenEmpty",
+ "type" : "Boolean",
+ "desc" : "True to hide the region when it has no panels",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "margins",
+ "type" : "Object",
+ "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "md",
+ "name" : "minTabWidth",
"type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "The minimum tab width (defaults to 40)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "minLength",
+ "name" : "preferredTabWidth",
"type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "placeholder",
- "type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "The preferred tab width (defaults to 150)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "preventMark",
+ "name" : "preservePanels",
"type" : "Boolean",
- "desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "readOnly",
+ "name" : "resizeTabs",
"type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "selectOnFocus",
+ "name" : "showPin",
"type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "size",
- "type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "True to show a pin button",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "split",
+ "type" : "Boolean",
+ "desc" : "To show the splitter",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "validClass",
+ "name" : "tabPosition",
"type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "top",
+ "bottom"
+ ]
},
{
- "name" : "validFeedbackIcon",
+ "name" : "title",
"type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "The title for the region (overrides panel titles)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "validateOnBlur",
+ "name" : "titlebar",
"type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "value",
- "type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : [
- "el",
- "parent"
- ]
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "True to display a title bar (defaults to true)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "toolbar",
+ "type" : "Boolean",
+ "desc" : "xtype configuration for a toolbar - shows on right of tabbar",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "xs",
+ "name" : "width",
"type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "For East/West panels",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
{
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "blur",
+ "name" : "beforecollapse",
"type" : "function",
- "desc" : "Fires when this field loses input focus.",
+ "desc" : "Fires when this region before collapse.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "change",
+ "name" : "beforeremove",
"type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument.",
+ "sig" : "function (_self, panel, e)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
},
{
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
+ "name" : "panel",
+ "type" : "Roo.panel.Content",
+ "desc" : "The panel",
"isOptional" : false
},
{
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
- "desc" : "",
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "The cancel event object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "collapsed",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
+ "desc" : "Fires when this region is collapsed.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "disable",
+ "name" : "expanded",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
+ "desc" : "Fires when this region is expanded.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "enable",
+ "name" : "invalidated",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
+ "desc" : "Fires when the layout for this region is changed.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "focus",
+ "name" : "panelactivated",
"type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Fires when a panel is activated.",
+ "sig" : "function (_self, panel)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "panel",
+ "type" : "Roo.panel.Content",
+ "desc" : "The activated panel",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "invalid",
+ "name" : "paneladded",
"type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Fires when a panel is added.",
+ "sig" : "function (_self, panel)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
},
{
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
+ "name" : "panel",
+ "type" : "Roo.panel.Content",
+ "desc" : "The panel",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "keyup",
+ "name" : "panelremoved",
"type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Fires when a panel is removed.",
+ "sig" : "function (_self, panel)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
+ "name" : "panel",
+ "type" : "Roo.panel.Content",
+ "desc" : "The panel",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "paste",
+ "name" : "resized",
"type" : "function",
- "desc" : "Fires after the user pastes into input",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Fires when the user resizes this region.",
+ "sig" : "function (_self, newSize)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new size (width for east/west, height for north/south)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "slidehide",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
+ "desc" : "Fires when this region slides out of view.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "show",
+ "name" : "slideshow",
"type" : "function",
- "desc" : "Fires after the component is shown.",
+ "desc" : "Fires when this region is slid into view.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "specialkey",
+ "name" : "visibilitychange",
"type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Fires when this region is shown or hidden",
+ "sig" : "function (_self, visibility)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
+ "name" : "visibility",
+ "type" : "Boolean",
+ "desc" : "true or false",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "valid",
+ "name" : "add",
"type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Adds the passed ContentPanel(s) to this region.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "Roo.layout.Region",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "panel",
+ "type" : "panel.Content...",
+ "desc" : "The ContentPanel(s) to add (you can pass more than one)",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "methods" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.panel.Content",
+ "desc" : "The panel added (if only one was added; null otherwise)"
+ }
+ ]
+ },
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "disable",
+ "name" : "collapse",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Collapses this region.",
+ "sig" : "(skipAnim)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.layout.Region",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "skipAnim",
+ "type" : "Boolean",
+ "desc" : "(optional) true to collapse the element without animation (if animate is true)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "enable",
+ "name" : "expand",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Expands this region if it was previously collapsed.",
+ "sig" : "(e, skipAnim)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.layout.Region",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event that triggered the expand (or null if calling manually)",
+ "isOptional" : false
+ },
+ {
+ "name" : "skipAnim",
+ "type" : "Boolean",
+ "desc" : "(optional) true to expand the element without animation (if animate is true)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
"name" : "fireEvent",
]
},
{
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "getAutoCreateLabel",
- "type" : "function",
- "desc" : "autocreate the label - also used by textara... ?? and others?",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "getChildContainer",
+ "name" : "getActivePanel",
"type" : "function",
- "desc" : "Fetch the element to add children to",
+ "desc" : "Get the active panel for this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.layout.Region",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Roo.panel.Content",
+ "desc" : "The active panel or null"
}
]
},
{
"name" : "getEl",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Returns the container element for this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.layout.Region",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "The element"
+ "desc" : ""
}
]
},
{
- "name" : "getId",
+ "name" : "getPanel",
"type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the panel specified or null if it's not in this region.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.layout.BasicRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/panel.Content",
+ "desc" : "The panels index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "String",
+ "type" : "Roo.panel.Content",
"desc" : ""
}
]
},
{
- "name" : "getName",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "Returns the name of the field",
+ "desc" : "Returns this regions position (north/south/east/west/center).",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.layout.BasicRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "name The name field"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getRawValue",
+ "name" : "getSplitBar",
"type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "desc" : "Returns the {@link Roo.SplitBar} for this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "Roo.SplitBar",
+ "desc" : ""
}
]
},
{
- "name" : "getValue",
+ "name" : "getTabs",
"type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "desc" : "Returns the TabPanel component used by this region",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.layout.Region",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "Roo.panel.Tab",
+ "desc" : ""
}
]
},
- {
- "name" : "getVisibilityEl",
- "type" : "function",
- "desc" : "Get the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "hasListener",
"type" : "function",
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "initEvents",
- "type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "inputEl",
+ "name" : "hasPanel",
"type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns true if the panel is in this region.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.layout.BasicRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/panel.Content",
+ "desc" : "The panels index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "isVisible",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
+ "desc" : "Hides this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.layout.Region",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "markInvalid",
+ "name" : "hidePanel",
"type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
+ "desc" : "Hides the tab for the specified panel.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.layout.Region",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
+ "name" : "panel",
+ "type" : "Number/String/panel.Content",
+ "desc" : "The panel's index, id or the panel itself",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "markValid",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Mark this field as valid",
+ "desc" : "Returns true if this region is currently visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.layout.Region",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
"name" : "on",
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "remove",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
+ "sig" : "(panel, preservePanel)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.layout.Region",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "panel",
+ "type" : "Number/String/panel.Content",
+ "desc" : "The panel's index, id or the panel itself",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "preservePanel",
+ "type" : "Boolean",
+ "desc" : "Overrides the config preservePanel option",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ "returns" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.panel.Content",
+ "desc" : "The panel that was removed"
}
- ],
- "returns" : []
- },
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
+ ]
},
{
- "name" : "setDisabled",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setRawValue",
+ "name" : "resizeTo",
"type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
+ "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
+ "sig" : "(newSize)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.layout.BasicRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new width or height",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setValue",
+ "name" : "setCollapsedTitle",
"type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
+ "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)",
+ "sig" : "(title)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.layout.Region",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "title",
+ "type" : "String",
+ "desc" : "(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, \"&#160;\")",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setVisibilityEl",
+ "name" : "show",
"type" : "function",
- "desc" : "Set the element that will be used to show or hide",
+ "desc" : "Shows this region if it was previously hidden.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.layout.Region",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "showPanel",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Shows the specified panel.",
+ "sig" : "(panelId)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.layout.Region",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "panelId",
+ "type" : "Number/String/panel.Content",
+ "desc" : "The panel's index, id or the panel itself",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Roo.panel.Content",
+ "desc" : "The shown panel, or null if a panel could not be found from panelId"
}
]
},
"returns" : []
},
{
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "validateValue",
+ "name" : "unhidePanel",
"type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
+ "desc" : "Unhides the tab for a previously hidden panel.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.layout.Region",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
+ "name" : "panel",
+ "type" : "Number/String/panel.Content",
+ "desc" : "The panel's index, id or the panel itself",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
+ "returns" : []
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.PhoneInput" : {
+ "Roo.bootstrap.menu" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.menu.Item" : {
"props" : [
- {
- "name" : "accept",
- "type" : "String",
- "desc" : "o) use for file input only. (default empt",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "image",
- "video",
- "audio"
- ]
- },
{
"name" : "actionMode",
"type" : "String",
"optvals" : []
},
{
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "afterButton",
- "type" : "Roo.bootstrap.Button",
- "desc" : "to show before",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) Default le",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "left",
- "center",
- "right"
- ]
- },
- {
- "name" : "allowBlank",
+ "name" : "active",
"type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "used on sidebars to highlight active itesm",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "autocomplete",
- "type" : "String",
- "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "capture",
- "type" : "String",
- "desc" : "a) use for file input only. (default empt",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "user",
- "camera"
- ]
- },
- {
- "name" : "caret",
- "type" : "String",
- "desc" : "r) BS3 only - carat fa na",
- "memberOf" : "Roo.bootstrap.form.TriggerField",
- "isOptional" : false,
- "optvals" : [
- "search",
- "calendar"
- ]
- },
{
"name" : "cls",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "defaultDialCode",
- "type" : "String",
- "desc" : "default '+852'",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "disableClass",
"type" : "String",
"optvals" : []
},
{
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "focusClass",
+ "name" : "fa",
"type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "favicon to show on left of menu item.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : "e) Default fal",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : "e) default tr",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
{
"name" : "hideMode",
"type" : "String",
]
},
{
- "name" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.TriggerField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : "t) default le",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "left",
- "right"
- ]
- },
- {
- "name" : "inputType",
- "type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "button",
- "checkbox",
- "email",
- "file",
- "hidden",
- "image",
- "number",
- "password",
- "radio",
- "range",
- "reset",
- "search",
- "submit",
- "text"
- ]
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "invalidText",
+ "name" : "href",
"type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "the link",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "labelAlign",
+ "name" : "html",
"type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "top",
- "left"
- ]
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "the menu label",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "isContainer",
+ "type" : "Boolean",
+ "desc" : "is it a container - just returns a drop down item..",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "menu",
+ "type" : "Roo.bootsrap.Menu",
+ "desc" : "the child menu.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
"name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "placeholder",
"type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "preferedCountries",
- "type" : "Array",
- "desc" : "default []",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "removable",
- "type" : "Boolean",
- "desc" : "e) special filter default fal",
- "memberOf" : "Roo.bootstrap.form.TriggerField",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "selectOnFocus",
+ "name" : "preventDefault",
"type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "size",
- "type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to which this combo is bound (defaults to undefined)",
+ "desc" : "do not trigger A href on clicks (default false).",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "triggerClass",
- "type" : "String",
- "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
- "memberOf" : "Roo.bootstrap.form.TriggerField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "value",
- "type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "visibilityEl",
"type" : "string|object",
"parent"
]
},
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "xattr",
"type" : "Object",
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
}
],
"events" : [
"returns" : []
},
{
- "name" : "blur",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires when this field loses input focus.",
+ "desc" : "Fires when the children have been rendered..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "change",
+ "name" : "click",
"type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "The raw click event for the entire grid.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.bootstrap.menu.Item",
"desc" : "",
"isOptional" : false
},
{
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "paste",
- "type" : "function",
- "desc" : "Fires after the user pastes into input",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"methods" : [
],
"returns" : []
},
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "getAutoCreateLabel",
- "type" : "function",
- "desc" : "autocreate the label - also used by textara... ?? and others?",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "getChildContainer",
"type" : "function",
}
]
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "name The name field"
- }
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "onTriggerClick",
- "type" : "function",
- "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "purgeListeners",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
}
],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.TabGroup"
+ ],
+ "tree_parent" : [
+ "Roo.bootstrap.menu.Menu"
+ ]
+ },
+ "Roo.bootstrap.menu.Manager" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "validate",
+ "name" : "get",
"type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns a {@link Roo.menu.Menu} object",
+ "sig" : "(menu)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "name" : "menu",
+ "type" : "String/Object",
+ "desc" : "The string menu id, an existing menu object reference, or a Menu config that will\nbe used to generate and return a new Menu instance.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "validateValue",
+ "name" : "hideAll",
"type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
+ "desc" : "Hides all menus that are currently visible",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.Radio" : {
+ "Roo.bootstrap.menu.Menu" : {
"props" : [
{
"name" : "actionMode",
"optvals" : []
},
{
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
+ "name" : "align",
+ "type" : "String",
+ "desc" : "default tl-bl? == below - how the menu should be aligned.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "boxLabel",
- "type" : "String",
- "desc" : "- the label associated",
- "memberOf" : "",
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "hidden",
+ "type" : "bool",
+ "desc" : "if the menu should be hidden when rendered.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "hideMode",
"type" : "String",
"visibility"
]
},
+ {
+ "name" : "hideTrigger",
+ "type" : "bool",
+ "desc" : "e) default false - hide the carret for trigge",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "isLink",
+ "type" : "bool",
+ "desc" : "e) the menu has link disable auto expand and collaspe (default fals",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "registerMenu",
+ "type" : "Boolean",
+ "desc" : "True (default) - means that clicking on screen etc. hides it.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "stopEvent",
+ "type" : "bool",
+ "desc" : "e) Stop event after trigger press (default tru",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "style",
"type" : "String",
"optvals" : []
},
{
- "name" : "value",
+ "name" : "type",
"type" : "String",
- "desc" : "- the value of radio",
+ "desc" : "u) type of me",
"memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "dropdown",
+ "treeview",
+ "submenu"
+ ]
},
{
"name" : "visibilityEl",
{
"name" : "beforehide",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "desc" : "Fires before this menu is hidden (return false to block)",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
}
{
"name" : "beforeshow",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "desc" : "Fires before this menu is displayed (return false to block)",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)",
+ "sig" : "function (_self, menuItem, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "menuItem",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was clicked",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
{
"name" : "hide",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires after this menu is hidden",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "itemclick",
+ "type" : "function",
+ "desc" : "Fires when a menu item contained in this menu is clicked",
+ "sig" : "function (baseItem, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "baseItem",
+ "type" : "Roo.menu.BaseItem",
+ "desc" : "The BaseItem that was clicked",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "mouseout",
+ "type" : "function",
+ "desc" : "Fires when the mouse exits this menu",
+ "sig" : "function (_self, e, menuItem)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "menuItem",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was clicked",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "mouseover",
+ "type" : "function",
+ "desc" : "Fires when the mouse is hovering over this menu",
+ "sig" : "function (_self, e, menuItem)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "menuItem",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was clicked",
+ "isOptional" : false
}
],
"returns" : []
{
"name" : "show",
"type" : "function",
- "desc" : "Fires after the component is shown.",
+ "desc" : "Fires after this menu is displayed",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
}
{
"name" : "hide",
"type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
+ "desc" : "Hides this menu and optionally all parent menus",
+ "sig" : "(deep)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "deep",
+ "type" : "Boolean",
+ "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
{
"name" : "show",
"type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
+ "desc" : "Displays this menu relative to another element",
+ "sig" : "(element, position, parentMenu)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "element",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element to align to",
+ "isOptional" : false
+ },
+ {
+ "name" : "position",
+ "type" : "String",
+ "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)",
+ "isOptional" : false
+ },
+ {
+ "name" : "parentMenu",
+ "type" : "Roo.menu.Menu",
+ "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "showAt",
+ "type" : "function",
+ "desc" : "Displays this menu at a specific xy position",
+ "sig" : "(xyPosition, parentMenu)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "xyPosition",
+ "type" : "Array",
+ "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)",
+ "isOptional" : false
+ },
+ {
+ "name" : "parentMenu",
+ "type" : "Roo.menu.Menu",
+ "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
+ "tree_children" : [
+ "Roo.bootstrap.menu.Item",
+ "Roo.bootstrap.menu.Separator"
+ ],
+ "tree_parent" : [
+ "none"
+ ]
},
- "Roo.bootstrap.form.RadioSet" : {
+ "Roo.bootstrap.menu.Separator" : {
"props" : [
- {
- "name" : "accept",
- "type" : "String",
- "desc" : "o) use for file input only. (default empt",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "image",
- "video",
- "audio"
- ]
- },
{
"name" : "actionMode",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "afterButton",
- "type" : "Roo.bootstrap.Button",
- "desc" : "to show before",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) Default le",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "left",
- "center",
- "right"
- ]
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "autocomplete",
- "type" : "String",
- "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "capture",
- "type" : "String",
- "desc" : "a) use for file input only. (default empt",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "user",
- "camera"
- ]
- },
{
"name" : "cls",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : "e) Default fal",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : "e) default tr",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
{
"name" : "hideMode",
"type" : "String",
"visibility"
]
},
- {
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : "t) default le",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "left",
- "right"
- ]
- },
- {
- "name" : "inline",
- "type" : "Boolean",
- "desc" : "e) inline the element (default tru",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "inputType",
- "type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "button",
- "checkbox",
- "email",
- "file",
- "hidden",
- "image",
- "number",
- "password",
- "radio",
- "range",
- "reset",
- "search",
- "submit",
- "text"
- ]
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelAlign",
- "type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "top",
- "left"
- ]
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "placeholder",
"type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "size",
- "type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "value",
- "type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "visibilityEl",
"type" : "string|object",
"parent"
]
},
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "weight",
- "type" : "String",
- "desc" : "s) The text that appears beside the rad",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "primary",
- "warning",
- "info",
- "danger",
- "success"
- ]
- },
{
"name" : "xattr",
"type" : "Object",
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
}
],
"events" : [
],
"returns" : []
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "check",
- "type" : "function",
- "desc" : "Fires when the element is checked or unchecked.",
- "sig" : "function (_self, item)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.form.RadioSet",
- "desc" : "This radio",
- "isOptional" : false
- },
- {
- "name" : "item",
- "type" : "Roo.bootstrap.form.Radio",
- "desc" : "The checked item",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "Fires when the element is click.",
- "sig" : "function (_self, item, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.form.RadioSet",
- "desc" : "This radio set",
- "isOptional" : false
- },
- {
- "name" : "item",
- "type" : "Roo.bootstrap.form.Radio",
- "desc" : "The checked item",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
"desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "paste",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires after the user pastes into input",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
+ "desc" : "Fires after the component is enabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "show",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires after the component is shown.",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "specialkey",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "valid",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "getAutoCreateLabel",
- "type" : "function",
- "desc" : "autocreate the label - also used by textara... ?? and others?",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "getChildContainer",
"type" : "function",
}
]
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "name The name field"
- }
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.form.Radio"
- ],
+ "tree_children" : [],
+ "tree_parent" : [
+ "Roo.bootstrap.menu.Menu"
+ ]
+ },
+ "Roo.bootstrap.nav" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.SecurePass" : {
+ "Roo.bootstrap.nav.Bar" : {
"props" : [
- {
- "name" : "accept",
- "type" : "String",
- "desc" : "o) use for file input only. (default empt",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "image",
- "video",
- "audio"
- ]
- },
{
"name" : "actionMode",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "afterButton",
- "type" : "Roo.bootstrap.Button",
- "desc" : "to show before",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) Default le",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "left",
- "center",
- "right"
- ]
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "autocomplete",
- "type" : "String",
- "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "capture",
- "type" : "String",
- "desc" : "a) use for file input only. (default empt",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "user",
- "camera"
- ]
- },
{
"name" : "cls",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : "e) Default fal",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : "e) default tr",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
{
"name" : "hideMode",
"type" : "String",
"visibility"
]
},
- {
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : "t) default le",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "left",
- "right"
- ]
- },
- {
- "name" : "inputType",
- "type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "button",
- "checkbox",
- "email",
- "file",
- "hidden",
- "image",
- "number",
- "password",
- "radio",
- "range",
- "reset",
- "search",
- "submit",
- "text"
- ]
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelAlign",
- "type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "top",
- "left"
- ]
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minimumStrength",
- "type" : "Number",
- "desc" : "invalid if the strength of the password input is less than the minimum strength (from 0 to 3) (default 2)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "placeholder",
- "type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "size",
"type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "value",
- "type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "visibilityEl",
"type" : "string|object",
"parent"
]
},
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "xattr",
"type" : "Object",
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
}
],
"events" : [
"returns" : []
},
{
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
+ "name" : "beforetoggle",
"type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Fire before toggle the menu",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
}
],
"returns" : []
],
"returns" : []
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "paste",
- "type" : "function",
- "desc" : "Fires after the user pastes into input",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "valid",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "clearInvalid",
+ "name" : "collapse",
"type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
+ "desc" : "Collapse the navbar pulldown",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expand the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
}
]
},
- {
- "name" : "getAutoCreateLabel",
- "type" : "function",
- "desc" : "autocreate the label - also used by textara... ?? and others?",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "getChildContainer",
"type" : "function",
}
]
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "name The name field"
- }
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
],
- "isAbstract" : false,
+ "isAbstract" : true,
"isBuilderTop" : false,
- "implementations" : [],
+ "implementations" : [
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.PopoverNav",
+ "Roo.bootstrap.form.HtmlEditorToolbar.Standard",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.TextArea" : {
+ "Roo.bootstrap.nav.Group" : {
"props" : [
- {
- "name" : "accept",
- "type" : "String",
- "desc" : "o) use for file input only. (default empt",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "image",
- "video",
- "audio"
- ]
- },
{
"name" : "actionMode",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "afterButton",
- "type" : "Roo.bootstrap.Button",
- "desc" : "to show before",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "align",
"type" : "String",
- "desc" : "t) Default le",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : [
"left",
- "center",
"right"
]
},
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "autocomplete",
- "type" : "String",
- "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "capture",
- "type" : "String",
- "desc" : "a) use for file input only. (default empt",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "user",
- "camera"
- ]
- },
{
"name" : "cls",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "cols",
- "type" : "Number",
- "desc" : "Specifies the visible width of a text area",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "container_method",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : "e) Default fal",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : "e) default tr",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
{
"name" : "hideMode",
"type" : "String",
]
},
{
- "name" : "html",
- "type" : "string",
- "desc" : "text",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : "t) default le",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "left",
- "right"
- ]
- },
- {
- "name" : "inputType",
- "type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "button",
- "checkbox",
- "email",
- "file",
- "hidden",
- "image",
- "number",
- "password",
- "radio",
- "range",
- "reset",
- "search",
- "submit",
- "text"
- ]
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelAlign",
- "type" : "String",
+ "name" : "inverse",
+ "type" : "Boolean",
"desc" : "",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "top",
- "left"
- ]
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "placeholder",
"type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "regexText",
+ "name" : "navId",
"type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "resize",
- "type" : "string",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "none",
- "both",
- "horizontal",
- "vertical",
- "inherit",
- "initial"
- ]
- },
- {
- "name" : "rows",
- "type" : "Number",
- "desc" : "Specifies the visible number of lines in a text area",
+ "desc" : "- reference Id for navbar.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "selectOnFocus",
+ "name" : "pilltype",
"type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "size",
- "type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "default true (turn to off to disable active toggle)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validFeedbackIcon",
+ "name" : "type",
"type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "value",
- "type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "b) default n",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "nav",
+ "pills",
+ "tab"
+ ]
},
{
"name" : "visibilityEl",
"parent"
]
},
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "wrap",
- "type" : "string",
- "desc" : "d)Specifies how the text in a text area is to be wrapped when submitted in a fo",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "soft",
- "hard"
- ]
- },
{
"name" : "xattr",
"type" : "Object",
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
}
],
"events" : [
"returns" : []
},
{
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
+ "name" : "changed",
"type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Fires when the active item changes",
+ "sig" : "function (_self, selected, prev)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.bootstrap.nav.Group",
"desc" : "",
"isOptional" : false
},
{
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
+ "name" : "selected",
+ "type" : "Roo.bootstrap.Navbar.Item",
+ "desc" : "The item selected",
"isOptional" : false
},
{
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
+ "name" : "prev",
+ "type" : "Roo.bootstrap.Navbar.Item",
+ "desc" : "The previously selected item",
"isOptional" : false
}
],
],
"returns" : []
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "paste",
- "type" : "function",
- "desc" : "Fires after the user pastes into input",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "specialkey",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "methods" : [
- {
- "name" : "addEvents",
+ "name" : "addItem",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "adds a Navigation item",
+ "sig" : "(the)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "the",
+ "type" : "Roo.bootstrap.nav.Item",
+ "desc" : "navitem to add",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "clearInvalid",
+ "name" : "clearAll",
"type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
+ "desc" : "clear all the Navigation item",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
]
},
{
- "name" : "getAutoCreateLabel",
+ "name" : "get",
"type" : "function",
- "desc" : "autocreate the label - also used by textara... ?? and others?",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
+ "desc" : "fetch a Navigation Group based on the navigation ID",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "string",
+ "desc" : "navgroup to add",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "getChildContainer",
+ "name" : "getActive",
"type" : "function",
- "desc" : "Fetch the element to add children to",
+ "desc" : "gets the active Navigation item",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Roo.bootstrap.nav.Item",
+ "desc" : "the current navitem"
}
]
},
{
- "name" : "getEl",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "The element"
+ "desc" : "defaults to this.el"
}
]
},
{
- "name" : "getId",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component",
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "name The name field"
- }
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "getValue",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "String",
+ "desc" : ""
}
]
},
"params" : [],
"returns" : []
},
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real textarea element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "register",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "register a Navigation item",
+ "sig" : "(the)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "the",
+ "type" : "Roo.bootstrap.nav.Item",
+ "desc" : "navitem to add",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "register",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
+ "desc" : "register a Navigation Group",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "the",
+ "type" : "Roo.bootstrap.nav.Group",
+ "desc" : "navgroup to add",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "reset",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "render",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
"memberOf" : "Roo.Component",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setRawValue",
+ "name" : "setActiveItem",
"type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
+ "desc" : "sets the active Navigation item",
+ "sig" : "(the)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "the",
+ "type" : "Roo.bootstrap.nav.Item",
+ "desc" : "new current navitem",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setValue",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
}
],
"returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.Markdown"
+ "implementations" : [],
+ "tree_children" : [
+ "Roo.bootstrap.nav.Item",
+ "Roo.bootstrap.nav.SidebarItem"
],
- "tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.TimeField" : {
+ "Roo.bootstrap.nav.Headerbar" : {
"props" : [
- {
- "name" : "accept",
- "type" : "String",
- "desc" : "o) use for file input only. (default empt",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "image",
- "video",
- "audio"
- ]
- },
{
"name" : "actionMode",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "afterButton",
- "type" : "Roo.bootstrap.Button",
- "desc" : "to show before",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "align",
"type" : "String",
- "desc" : "t) Default le",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "t) alignme",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
"isOptional" : false,
"optvals" : [
"left",
- "center",
"right"
]
},
{
- "name" : "allowBlank",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "allowDomMove",
+ "name" : "arrangement",
"type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
+ "desc" : "stacked | justified",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "autocomplete",
- "type" : "String",
- "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "autohide",
+ "type" : "Boolean",
+ "desc" : "a top nav bar header that hides on scroll.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "brand",
+ "type" : "String",
+ "desc" : "what is brand",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "blankText",
+ "name" : "brand_href",
"type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "href of the brand",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "capture",
- "type" : "String",
- "desc" : "a) use for file input only. (default empt",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "user",
- "camera"
- ]
- },
{
"name" : "cls",
"type" : "String",
"optvals" : []
},
{
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabled",
+ "name" : "desktopCenter",
"type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "should the header be centered on desktop using a container class",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : "e) Default fal",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "format",
+ "name" : "disableClass",
"type" : "String",
- "desc" : "The default time format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'H:i').",
- "memberOf" : "",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : "e) default tr",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
{
"name" : "hideMode",
"type" : "String",
]
},
{
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : "t) default le",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "left",
- "right"
- ]
- },
- {
- "name" : "inputType",
- "type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "button",
- "checkbox",
- "email",
- "file",
- "hidden",
- "image",
- "number",
- "password",
- "radio",
- "range",
- "reset",
- "search",
- "submit",
- "text"
- ]
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelAlign",
- "type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "top",
- "left"
- ]
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "is inverted color",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "e) loadMask on the b",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "main",
+ "type" : "Boolean",
+ "desc" : "e) main nav bar? default fal",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "minuteStep",
- "type" : "Number",
- "desc" : "the minutes is always the multiple of a fixed number, default 1",
+ "name" : "mobilerow",
+ "type" : "Roo.bootstrap.Row",
+ "desc" : "- a row to display on mobile only..",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
"name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "placeholder",
"type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "regexText",
+ "name" : "position",
"type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "p) positi",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "fixed-top",
+ "fixed-bottom",
+ "static-top"
+ ]
},
{
- "name" : "selectOnFocus",
+ "name" : "srButton",
"type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "size",
- "type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "generate the (screen reader / mobile) sr-only button default true",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "v) default is n",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "header",
+ "footer",
+ "nav",
+ "div"
+ ]
+ },
{
"name" : "tooltip",
"type" : "string",
"optvals" : []
},
{
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validFeedbackIcon",
+ "name" : "type",
"type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "value",
- "type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "nav",
+ "pills",
+ "tabs"
+ ]
},
{
"name" : "visibilityEl",
]
},
{
- "name" : "vtype",
+ "name" : "weight",
"type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "e) default is ligh",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "light",
+ "primary",
+ "secondary",
+ "success",
+ "danger",
+ "warning",
+ "info",
+ "dark",
+ "white"
+ ]
},
{
"name" : "xattr",
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
}
],
"events" : [
"returns" : []
},
{
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
+ "name" : "beforetoggle",
"type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Fire before toggle the menu",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
}
],
"returns" : []
],
"returns" : []
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "paste",
- "type" : "function",
- "desc" : "Fires after the user pastes into input",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when select a date.",
- "sig" : "function (_self, date)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.form.DateField",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "date",
- "type" : "Mixed",
- "desc" : "The date value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
- "desc" : "Fires when this field show.",
- "sig" : "function (thisthis, date)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "thisthis",
- "type" : "Roo.bootstrap.form.DateField",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "date",
- "type" : "Mixed",
- "desc" : "The date value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "clearInvalid",
+ "name" : "collapse",
"type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
+ "desc" : "Collapse the navbar pulldown",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expand the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
}
]
},
- {
- "name" : "getAutoCreateLabel",
- "type" : "function",
- "desc" : "autocreate the label - also used by textara... ?? and others?",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "getChildContainer",
"type" : "function",
}
]
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "name The name field"
- }
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"example" : "",
"deprecated" : "",
"since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "markValid",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Mark this field as valid",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [],
+ "tree_children" : [
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.Link"
+ ],
"tree_parent" : []
},
- "Roo.bootstrap.form.TriggerField" : {
+ "Roo.bootstrap.nav.Item" : {
"props" : [
- {
- "name" : "accept",
- "type" : "String",
- "desc" : "o) use for file input only. (default empt",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "image",
- "video",
- "audio"
- ]
- },
{
"name" : "actionMode",
"type" : "String",
"optvals" : []
},
{
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "afterButton",
- "type" : "Roo.bootstrap.Button",
- "desc" : "to show before",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) Default le",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "left",
- "center",
- "right"
- ]
- },
- {
- "name" : "allowBlank",
+ "name" : "active",
"type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Is item active",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "autocomplete",
- "type" : "String",
- "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "animateRef",
+ "type" : "Boolean",
+ "desc" : "e) link to element default fal",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "badge",
+ "type" : "String",
+ "desc" : "text inside badge",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "blankText",
+ "name" : "badgecls",
"type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "w)the extra classes for the bad",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "bg-green",
+ "bg-red",
+ "bg-yellow"
+ ]
},
{
- "name" : "can_build_overlaid",
+ "name" : "button_outline",
"type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "show and outlined button",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "capture",
+ "name" : "button_weight",
"type" : "String",
- "desc" : "a) use for file input only. (default empt",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "k) default no",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : [
- "user",
- "camera"
+ "default",
+ "primary",
+ "secondary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "link",
+ "light",
+ "dark"
]
},
{
- "name" : "caret",
- "type" : "String",
- "desc" : "r) BS3 only - carat fa na",
- "memberOf" : "",
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
- "optvals" : [
- "search",
- "calendar"
- ]
+ "optvals" : []
},
{
"name" : "cls",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "disabled",
"type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Is item disabled",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "fa",
+ "type" : "String",
+ "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "focusClass",
+ "name" : "glyphicon",
"type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "DEPRICATED - use fa",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : "e) Default fal",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : "e) default tr",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
{
"name" : "hideMode",
"type" : "String",
]
},
{
- "name" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : "t) default le",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "left",
- "right"
- ]
- },
- {
- "name" : "inputType",
- "type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "button",
- "checkbox",
- "email",
- "file",
- "hidden",
- "image",
- "number",
- "password",
- "radio",
- "range",
- "reset",
- "search",
- "submit",
- "text"
- ]
- },
- {
- "name" : "invalidClass",
+ "name" : "href",
"type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "link to",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "invalidFeedbackIcon",
+ "name" : "html",
"type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "content of button",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "invalidText",
+ "name" : "icon",
"type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "DEPRICATED - use fa",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "labelAlign",
+ "name" : "linkcls",
"type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "top",
- "left"
- ]
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Link Class",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "name" : "menu",
+ "type" : "Roo.bootstrap.menu.Menu",
+ "desc" : "a Menu",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
"name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "placeholder",
"type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "removable",
+ "name" : "preventDefault",
"type" : "Boolean",
- "desc" : "e) special filter default fal",
+ "desc" : "e) default fal",
"memberOf" : "",
"isOptional" : false,
"optvals" : [
"false"
]
},
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "size",
- "type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "style",
"type" : "String",
"optvals" : []
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "triggerClass",
+ "name" : "tabId",
"type" : "String",
- "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
+ "desc" : "the tab that this item activates.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validFeedbackIcon",
+ "name" : "tagtype",
"type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "n) render as a href or spa",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "a",
+ "span"
+ ]
},
{
- "name" : "value",
+ "name" : "tooltip",
"type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
"parent"
]
},
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "xattr",
"type" : "Object",
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
}
],
"events" : [
"returns" : []
},
{
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
+ "name" : "changed",
"type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Fires when the active item active state changes",
+ "sig" : "function (_self, state)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.bootstrap.nav.Item",
"desc" : "",
"isOptional" : false
},
{
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
+ "name" : "state",
+ "type" : "boolean",
+ "desc" : "the new state",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "click",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "The raw click event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "disable",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
+ "desc" : "Fires after the component is destroyed.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "enable",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
+ "desc" : "Fires after the component is disabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "focus",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires when this field receives input focus.",
+ "desc" : "Fires after the component is enabled.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "invalid",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "keyup",
+ "name" : "scrollto",
"type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Fires when scroll to element",
+ "sig" : "function (_self, options, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.bootstrap.nav.Item",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "paste",
- "type" : "function",
- "desc" : "Fires after the user pastes into input",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
+ "name" : "options",
+ "type" : "Object",
"desc" : "",
"isOptional" : false
},
{
"name" : "e",
"type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
}
],
"returns" : []
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"methods" : [
],
"returns" : []
},
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "getAutoCreateLabel",
- "type" : "function",
- "desc" : "autocreate the label - also used by textara... ?? and others?",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "getChildContainer",
"type" : "function",
}
]
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "name The name field"
- }
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"returns" : []
},
{
- "name" : "hasListener",
- "type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "initEvents",
- "type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "inputEl",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "isVisible",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
+ "desc" : "Hide a component - adds 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "markInvalid",
+ "name" : "initEvents",
"type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "markValid",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Mark this field as valid",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
},
- {
- "name" : "onTriggerClick",
- "type" : "function",
- "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "purgeListeners",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
"returns" : []
},
{
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setValue",
+ "name" : "setHtml",
"type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
+ "desc" : "Set the HTML (text content) of the item",
+ "sig" : "(html)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "html",
+ "type" : "string",
+ "desc" : "content for the nav item",
"isOptional" : false
}
],
"desc" : "Fetch the element to display the tooltip on.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
],
"returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [
- "Roo.bootstrap.form.ComboBox",
- "Roo.bootstrap.form.MoneyField",
- "Roo.bootstrap.form.PhoneInput"
+ "Roo.bootstrap.nav.SidebarItem"
],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.bootstrap.layout" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
+ "tree_children" : [
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.form.CardUploader"
+ ],
+ "tree_parent" : [
+ "Roo.bootstrap.nav.Group"
+ ]
},
- "Roo.bootstrap.layout.Basic" : {
+ "Roo.bootstrap.nav.ProgressBar" : {
"props" : [
+ {
+ "name" : "NavProgressBar:bullets[]",
+ "type" : "Roo.bootstrap.nav.ProgressItem",
+ "desc" : "Bullets for the Nav Progress bar for the toolbar",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
{
"name" : "listeners",
"type" : "Object",
"optvals" : []
},
{
- "name" : "mgr",
- "type" : "Roo.bootstrap.layout.Manager",
- "desc" : "The manager",
- "memberOf" : "",
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "region",
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tooltip",
"type" : "string",
- "desc" : "the region that it inhabits..",
- "memberOf" : "",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "skipConfig",
- "type" : "bool",
- "desc" : "skip config?",
- "memberOf" : "",
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
}
],
- "events" : [],
- "methods" : [
+ "events" : [
{
- "name" : "add",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Add the passed ContentPanel(s)",
- "sig" : "(panel)",
- "static" : false,
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforehide",
+ "type" : "function",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforerender",
+ "type" : "function",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "changed",
+ "type" : "function",
+ "desc" : "Fires when the active item changes",
+ "sig" : "function (_self, selected, prev)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "ContentPanel...",
- "desc" : "The ContentPanel(s) to add (you can pass more than one)",
+ "name" : "this",
+ "type" : "Roo.bootstrap.nav.ProgressBar",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "selected",
+ "type" : "Roo.bootstrap.nav.ProgressItem",
+ "desc" : "The item selected",
+ "isOptional" : false
+ },
+ {
+ "name" : "prev",
+ "type" : "Roo.bootstrap.nav.ProgressItem",
+ "desc" : "The previously selected item",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel added (if only one was added)"
+ "name" : "this",
+ "type" : "Roo.bootstrap.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
{
"name" : "addEvents",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
{
"name" : "fireEvent",
"type" : "function",
]
},
{
- "name" : "getActivePanel",
+ "name" : "focus",
"type" : "function",
- "desc" : "Get the active panel for this region.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The active panel or null"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getEl",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Returns the container element for this region.",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Roo.Element",
- "desc" : ""
+ "desc" : "defaults to this.el"
}
]
},
{
- "name" : "getPanel",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns the panel specified or null if it's not in this region.",
- "sig" : "(panel)",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "getPosition",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns this regions position (north/south/east/west/center).",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
+ {
+ "name" : "getVisibilityEl",
+ "type" : "function",
+ "desc" : "Get the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "hasListener",
"type" : "function",
]
},
{
- "name" : "hasPanel",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns true if the panel is in this region.",
- "sig" : "(panel)",
+ "desc" : "Hide a component - adds 'hidden' class",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "initEvents",
+ "type" : "function",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
"name" : "isVisible",
"type" : "function",
- "desc" : "Returns true if this region is currently visible.",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
"name" : "on",
"returns" : []
},
{
- "name" : "remove",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
- "sig" : "(panel, preservePanel)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "preservePanel",
- "type" : "Boolean",
- "desc" : "Overrides the config preservePanel option",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel that was removed"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "removeListener",
+ "name" : "render",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resizeTo",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
- "sig" : "(newSize)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new width or height",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "showPanel",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Show the specified panel.",
- "sig" : "(panelId)",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panelId",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The shown panel or null"
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.bootstrap.layout.Region"
+ "implementations" : [],
+ "tree_children" : [
+ "Roo.bootstrap.nav.ProgressBarItem"
],
- "tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.layout.Border" : {
+ "Roo.bootstrap.nav.ProgressBarItem" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "active",
+ "type" : "Boolean",
+ "desc" : "e) Is item active default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "center",
- "type" : "Roo.bootstrap.layout.Region",
- "desc" : "region to go in center",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "cls",
"type" : "String",
"optvals" : []
},
{
- "name" : "east",
- "type" : "Roo.bootstrap.layout.Region",
- "desc" : "region to go in east",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "e) Is item active default fal",
"memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hideMode",
"visibility"
]
},
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "icon",
+ "type" : "String",
+ "desc" : "show icon instead of number",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"optvals" : []
},
{
- "name" : "north",
- "type" : "Roo.bootstrap.layout.Region",
- "desc" : "region to go in north",
+ "name" : "position",
+ "type" : "String",
+ "desc" : "m) text position default bott",
"memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "top",
+ "bottom"
+ ]
},
{
- "name" : "south",
- "type" : "Roo.bootstrap.layout.Region",
- "desc" : "region to go in south",
+ "name" : "rid",
+ "type" : "String",
+ "desc" : "the reference id",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"parent"
]
},
- {
- "name" : "west",
- "type" : "Roo.bootstrap.layout.Region",
- "desc" : "region to go in west",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "xattr",
"type" : "Object",
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "click",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "The raw click event for the entire grid.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.nav.ProgressBarItem",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "disable",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
+ "desc" : "Fires after the component is destroyed.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "enable",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
+ "desc" : "Fires after the component is disabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "hide",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires after the component is enabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "layout",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires when a layout is performed.",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.layout.Manager",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutManager",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "regioncollapsed",
- "type" : "function",
- "desc" : "Fires when a region is collapsed.",
- "sig" : "function (region)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.layout.Manager",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The collapsed region",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "regionexpanded",
- "type" : "function",
- "desc" : "Fires when a region is expanded.",
- "sig" : "function (region)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.layout.Manager",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The expanded region",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "regionresized",
- "type" : "function",
- "desc" : "Fires when the user resizes a region.",
- "sig" : "function (region, newSize)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.layout.Manager",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The resized region",
- "isOptional" : false
- },
- {
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new size (width for east/west, height for north/south)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
}
],
"methods" : [
- {
- "name" : "add",
- "type" : "function",
- "desc" : "Adds a ContentPanel (or subclass) to this layout.",
- "sig" : "(target, panel)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "target",
- "type" : "String",
- "desc" : "The target region key (north, south, east, west or center).",
- "isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel to add",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The added panel"
- }
- ]
- },
{
"name" : "addEvents",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "addRegion",
- "type" : "function",
- "desc" : "Creates and adds a new region if it doesn't already exist.",
- "sig" : "(target, config)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "target",
- "type" : "String",
- "desc" : "The target region key (north, south, east, west or center).",
- "isOptional" : false
- },
- {
- "name" : "config",
- "type" : "Object",
- "desc" : "The regions config object",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "BorderLayoutRegion",
- "desc" : "The new region"
- }
- ]
- },
- {
- "name" : "addxtype",
- "type" : "function",
- "desc" : "Adds a xtype elements to the layout.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'ContentPanel',\n region: 'west',\n items: [ .... ]\n }\n);\n\nlayout.addxtype({\n xtype : 'NestedLayoutPanel',\n region: 'west',\n layout: {\n center: { },\n west: { } \n },\n items : [ ... list of content panels or nested layout panels.. ]\n }\n);\n</code></pre>",
- "sig" : "(cfg)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "cfg",
- "type" : "Object",
- "desc" : "Xtype definition of item to add.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beginUpdate",
- "type" : "function",
- "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
}
]
},
- {
- "name" : "endUpdate",
- "type" : "function",
- "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
- "sig" : "(noLayout)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "noLayout",
- "type" : "Boolean",
- "desc" : "true to disable a layout update",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "findPanel",
- "type" : "function",
- "desc" : "Searches all regions for a panel with the specified id",
- "sig" : "(panelId)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panelId",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel or null if it wasn't found"
- }
- ]
- },
{
"name" : "fireEvent",
"type" : "function",
{
"name" : "getEl",
"type" : "function",
- "desc" : "Returns the Element this layout is bound to.",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Roo.Element",
- "desc" : ""
+ "desc" : "The element"
}
]
},
}
]
},
- {
- "name" : "getRegion",
- "type" : "function",
- "desc" : "Returns the specified region.",
- "sig" : "(target)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "target",
- "type" : "String",
- "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.LayoutRegion",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getViewSize",
- "type" : "function",
- "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "The size as an object {width: (the width), height: (the height)}"
- }
- ]
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "isUpdating",
- "type" : "function",
- "desc" : "Returns true if this layout is currently being updated",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
- },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "layout",
- "type" : "function",
- "desc" : "Performs a layout update.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "remove",
- "type" : "function",
- "desc" : "Remove a ContentPanel (or subclass) to this layout.",
- "sig" : "(target, panel)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "target",
- "type" : "String",
- "desc" : "The target region key (north, south, east, west or center).",
- "isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Number/String/Roo.ContentPanel",
- "desc" : "The index, id or panel to remove",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The removed panel"
- }
- ]
- },
{
"name" : "removeListener",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "showPanel",
- "type" : "function",
- "desc" : "Searches all regions for a panel with the specified id and activates (shows) it.",
- "sig" : "(panelId)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panelId",
- "type" : "String/ContentPanel",
- "desc" : "The panels id or the panel itself",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The shown panel or null"
- }
- ]
- },
{
"name" : "tooltipEl",
"type" : "function",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.panel.Content",
- "Roo.bootstrap.panel.Grid",
- "Roo.bootstrap.panel.Nest",
- "Roo.bootstrap.panel.Nest",
- "Roo.bootstrap.panel.Grid"
- ],
- "tree_parent" : [
- "builder",
- "Roo.bootstrap.panel.Nest",
- "Roo.bootstrap.panel.Nest",
- "Roo.bootstrap.Modal"
- ]
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.layout.Manager" : {
+ "Roo.bootstrap.nav.Sidebar" : {
"props" : [
{
"name" : "actionMode",
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "beforetoggle",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "Fire before toggle the menu",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
+ "desc" : "Fires when the children have been rendered..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "disable",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
+ "desc" : "Fires after the component is destroyed.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "enable",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
+ "desc" : "Fires after the component is disabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "hide",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires after the component is enabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "layout",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires when a layout is performed.",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutManager",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "regioncollapsed",
- "type" : "function",
- "desc" : "Fires when a region is collapsed.",
- "sig" : "function (region)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The collapsed region",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "regionexpanded",
- "type" : "function",
- "desc" : "Fires when a region is expanded.",
- "sig" : "function (region)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The expanded region",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "regionresized",
- "type" : "function",
- "desc" : "Fires when the user resizes a region.",
- "sig" : "function (region, newSize)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The resized region",
- "isOptional" : false
- },
- {
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new size (width for east/west, height for north/south)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "beginUpdate",
- "type" : "function",
- "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Collapse the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
]
},
{
- "name" : "endUpdate",
+ "name" : "expand",
"type" : "function",
- "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
- "sig" : "(noLayout)",
+ "desc" : "Expand the navbar pulldown",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "noLayout",
- "type" : "Boolean",
- "desc" : "true to disable a layout update",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
{
"name" : "getEl",
"type" : "function",
- "desc" : "Returns the Element this layout is bound to.",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Roo.Element",
- "desc" : ""
+ "desc" : "The element"
}
]
},
}
]
},
- {
- "name" : "getRegion",
- "type" : "function",
- "desc" : "Returns the specified region.",
- "sig" : "(target)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "target",
- "type" : "String",
- "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.LayoutRegion",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getViewSize",
- "type" : "function",
- "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "The size as an object {width: (the width), height: (the height)}"
- }
- ]
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "isUpdating",
- "type" : "function",
- "desc" : "Returns true if this layout is currently being updated",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
- },
{
"name" : "isVisible",
"type" : "function",
"returns" : []
}
],
- "isAbstract" : true,
+ "isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.bootstrap.layout.Border"
+ "implementations" : [],
+ "tree_children" : [
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.Link"
],
- "tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.layout.Region" : {
+ "Roo.bootstrap.nav.SidebarItem" : {
"props" : [
{
- "name" : "alwaysShowTabs",
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "active",
"type" : "Boolean",
- "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
- "memberOf" : "",
+ "desc" : "Is item active",
+ "memberOf" : "Roo.bootstrap.nav.Item",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "animate",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "True to animate expand/collapse (defaults to false)",
- "memberOf" : "",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "autoHide",
+ "name" : "animateRef",
"type" : "Boolean",
- "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
- "memberOf" : "",
+ "desc" : "e) link to element default fal",
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "badge",
+ "type" : "String",
+ "desc" : "text inside badge",
+ "memberOf" : "Roo.bootstrap.nav.Item",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "autoScroll",
+ "name" : "badgecls",
+ "type" : "String",
+ "desc" : "w)the extra classes for the bad",
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : [
+ "bg-green",
+ "bg-red",
+ "bg-yellow"
+ ]
+ },
+ {
+ "name" : "button_outline",
"type" : "Boolean",
- "desc" : "True to enable overflow scrolling (defaults to false)",
- "memberOf" : "",
+ "desc" : "show and outlined button",
+ "memberOf" : "Roo.bootstrap.nav.Item",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "closeOnTab",
+ "name" : "button_weight",
+ "type" : "String",
+ "desc" : "k) default no",
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : [
+ "default",
+ "primary",
+ "secondary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "link",
+ "light",
+ "dark"
+ ]
+ },
+ {
+ "name" : "can_build_overlaid",
"type" : "Boolean",
- "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
- "memberOf" : "",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
"name" : "cls",
- "type" : "string",
- "desc" : "Extra CSS classes to add to region",
- "memberOf" : "",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "cmargins",
- "type" : "Object",
- "desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})",
- "memberOf" : "",
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disableTabTips",
- "type" : "Boolean",
- "desc" : "True to disable tab tooltips",
- "memberOf" : "",
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "For North/South panels",
- "memberOf" : "",
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hidden",
+ "name" : "disabled",
"type" : "Boolean",
- "desc" : "True to start the region hidden (defaults to false)",
- "memberOf" : "",
+ "desc" : "Is item disabled",
+ "memberOf" : "Roo.bootstrap.nav.Item",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hideTabs",
- "type" : "Boolean",
- "desc" : "True to hide the tab strip (defaults to false)",
- "memberOf" : "",
+ "name" : "fa",
+ "type" : "String",
+ "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)",
+ "memberOf" : "Roo.bootstrap.nav.Item",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hideWhenEmpty",
- "type" : "Boolean",
- "desc" : "True to hide the region when it has no panels",
- "memberOf" : "",
+ "name" : "glyphicon",
+ "type" : "String",
+ "desc" : "DEPRICATED - use fa",
+ "memberOf" : "Roo.bootstrap.nav.Item",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "margins",
- "type" : "Object",
- "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
- "memberOf" : "",
+ "name" : "href",
+ "type" : "String",
+ "desc" : "link to",
+ "memberOf" : "Roo.bootstrap.nav.Item",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "mgr",
- "type" : "Roo.bootstrap.layout.Manager",
- "desc" : "The manager",
- "memberOf" : "",
+ "name" : "html",
+ "type" : "String",
+ "desc" : "content of button",
+ "memberOf" : "Roo.bootstrap.nav.Item",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "minTabWidth",
- "type" : "Number",
- "desc" : "The minimum tab width (defaults to 40)",
- "memberOf" : "",
+ "name" : "icon",
+ "type" : "String",
+ "desc" : "DEPRICATED - use fa",
+ "memberOf" : "Roo.bootstrap.nav.Item",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "overflow",
+ "name" : "linkcls",
"type" : "String",
- "desc" : "e) if you have menus in the region, then you need to set this to visibl",
- "memberOf" : "",
+ "desc" : "Link Class",
+ "memberOf" : "Roo.bootstrap.nav.Item",
"isOptional" : false,
- "optvals" : [
- "hidden",
- "visible"
- ]
+ "optvals" : []
},
{
- "name" : "preferredTabWidth",
- "type" : "Number",
- "desc" : "The preferred tab width (defaults to 150)",
- "memberOf" : "",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "preservePanels",
- "type" : "Boolean",
- "desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
- "memberOf" : "",
+ "name" : "menu",
+ "type" : "Roo.bootstrap.menu.Menu",
+ "desc" : "a Menu",
+ "memberOf" : "Roo.bootstrap.nav.Item",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "region",
+ "name" : "name",
"type" : "string",
- "desc" : "the region that it inhabits..",
- "memberOf" : "",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "resizeTabs",
+ "name" : "preventDefault",
"type" : "Boolean",
- "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)",
- "memberOf" : "",
+ "desc" : "e) default fal",
+ "memberOf" : "Roo.bootstrap.nav.Item",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "skipConfig",
- "type" : "bool",
- "desc" : "skip config?",
- "memberOf" : "Roo.bootstrap.layout.Basic",
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "split",
- "type" : "Boolean",
- "desc" : "To show the splitter",
- "memberOf" : "",
+ "name" : "tabId",
+ "type" : "String",
+ "desc" : "the tab that this item activates.",
+ "memberOf" : "Roo.bootstrap.nav.Item",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tabPosition",
+ "name" : "tagtype",
"type" : "String",
- "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom",
- "memberOf" : "",
+ "desc" : "n) render as a href or spa",
+ "memberOf" : "Roo.bootstrap.nav.Item",
"isOptional" : false,
"optvals" : [
- "top",
- "bottom"
+ "a",
+ "span"
]
},
{
- "name" : "title",
- "type" : "String",
- "desc" : "The title for the region (overrides panel titles)",
- "memberOf" : "",
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "titlebar",
- "type" : "Boolean",
- "desc" : "True to display a title bar (defaults to true)",
- "memberOf" : "",
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforedestroy",
+ "type" : "function",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "toolbar",
- "type" : "Boolean",
- "desc" : "xtype configuration for a toolbar - shows on right of tabbar",
+ "name" : "beforehide",
+ "type" : "function",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforerender",
+ "type" : "function",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "changed",
+ "type" : "function",
+ "desc" : "Fires when the active item active state changes",
+ "sig" : "function (_self, state)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.nav.SidebarItem",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "state",
+ "type" : "boolean",
+ "desc" : "the new state",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "The raw click event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "For East/West panels",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
- "name" : "add",
+ "name" : "disable",
"type" : "function",
- "desc" : "Adds the passed ContentPanel(s) to this region.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "ContentPanel...",
- "desc" : "The ContentPanel(s) to add (you can pass more than one)",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel added (if only one was added; null otherwise)"
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "addEvents",
+ "name" : "hide",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "render",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "scrollto",
+ "type" : "function",
+ "desc" : "Fires when scroll to element",
+ "sig" : "function (_self, options, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "this",
+ "type" : "Roo.bootstrap.nav.Item",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "scope",
+ "name" : "options",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "animateCollapse",
+ "name" : "show",
"type" : "function",
- "desc" : "Collapses this region.",
- "sig" : "(skipAnim)",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "skipAnim",
- "type" : "Boolean",
- "desc" : "(optional) true to collapse the element without animation (if animate is true)",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "animateExpand",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Expands this region if it was previously collapsed.",
- "sig" : "(e, skipAnim)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event that triggered the expand (or null if calling manually)",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "skipAnim",
- "type" : "Boolean",
- "desc" : "(optional) true to expand the element without animation (if animate is true)",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "getActivePanel",
+ "name" : "disable",
"type" : "function",
- "desc" : "Get the active panel for this region.",
+ "desc" : "Disable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The active panel or null"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getBox",
+ "name" : "enable",
"type" : "function",
- "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)",
- "sig" : "(title)",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "title",
- "type" : "String",
- "desc" : "(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, \"&#160;\")",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "getEl",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Returns the container element for this region.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : ""
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "getPanel",
+ "name" : "focus",
"type" : "function",
- "desc" : "Returns the panel specified or null if it's not in this region.",
- "sig" : "(panel)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Basic",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : ""
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getPosition",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Returns this regions position (north/south/east/west/center).",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Basic",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
{
- "name" : "getTabs",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns the TabPanel component used by this region",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.TabPanel",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "hasListener",
+ "name" : "getId",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "hasPanel",
+ "name" : "getVisibilityEl",
"type" : "function",
- "desc" : "Returns true if the panel is in this region.",
- "sig" : "(panel)",
+ "desc" : "Get the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Basic",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "hasListener",
+ "type" : "function",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Boolean",
- "desc" : ""
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
"name" : "hide",
"type" : "function",
- "desc" : "Hides this region.",
+ "desc" : "Hide a component - adds 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "hidePanel",
+ "name" : "initEvents",
"type" : "function",
- "desc" : "Hides the tab for the specified panel.",
- "sig" : "(panel)",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
"name" : "isVisible",
"type" : "function",
- "desc" : "Returns true if this region is currently visible.",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
"name" : "on",
"returns" : []
},
{
- "name" : "remove",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
- "sig" : "(panel, preservePanel)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "preservePanel",
- "type" : "Boolean",
- "desc" : "Overrides the config preservePanel option",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel that was removed"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "removeListener",
+ "name" : "render",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resizeTo",
+ "name" : "setHtml",
"type" : "function",
- "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
- "sig" : "(newSize)",
+ "desc" : "Set the HTML (text content) of the item",
+ "sig" : "(html)",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Basic",
+ "memberOf" : "Roo.bootstrap.nav.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new width or height",
+ "name" : "html",
+ "type" : "string",
+ "desc" : "content for the nav item",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Shows this region if it was previously hidden.",
+ "desc" : "Set the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "showPanel",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Shows the specified panel.",
- "sig" : "(panelId)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panelId",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The shown panel, or null if a panel could not be found from panelId"
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
}
],
"returns" : []
- },
- {
- "name" : "unhidePanel",
- "type" : "function",
- "desc" : "Unhides the tab for a previously hidden panel.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.layout.Split" : {
+ "Roo.bootstrap.nav.Simplebar" : {
"props" : [
{
- "name" : "alwaysShowTabs",
- "type" : "Boolean",
- "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
- "memberOf" : "Roo.LayoutRegion",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "animate",
- "type" : "Boolean",
- "desc" : "True to animate expand/collapse (defaults to false)",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "autoHide",
- "type" : "Boolean",
- "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) alignme",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
- "name" : "autoScroll",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "True to enable overflow scrolling (defaults to false)",
- "memberOf" : "Roo.LayoutRegion",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "closeOnTab",
+ "name" : "arrangement",
"type" : "Boolean",
- "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
- "memberOf" : "Roo.LayoutRegion",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cmargins",
- "type" : "Object",
- "desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})",
- "memberOf" : "Roo.LayoutRegion",
+ "desc" : "stacked | justified",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "collapsed",
+ "name" : "can_build_overlaid",
"type" : "Boolean",
- "desc" : "True to set the initial display to collapsed (defaults to false)",
- "memberOf" : "Roo.LayoutRegion",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "collapsedTitle",
+ "name" : "cls",
"type" : "String",
- "desc" : "Optional string message to display in the collapsed block of a north or south region",
- "memberOf" : "Roo.LayoutRegion",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "collapsible",
- "type" : "Boolean",
- "desc" : "False to disable collapsing (defaults to true)",
- "memberOf" : "Roo.LayoutRegion",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableTabTips",
- "type" : "Boolean",
- "desc" : "True to disable tab tooltips",
- "memberOf" : "Roo.LayoutRegion",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "floatable",
- "type" : "Boolean",
- "desc" : "False to disable floating (defaults to true)",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "For North/South panels",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "True to start the region hidden (defaults to false)",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hideTabs",
- "type" : "Boolean",
- "desc" : "True to hide the tab strip (defaults to false)",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "hideWhenEmpty",
+ "name" : "inverse",
"type" : "Boolean",
- "desc" : "True to hide the region when it has no panels",
- "memberOf" : "Roo.LayoutRegion",
+ "desc" : "is inverted color",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "margins",
- "type" : "Object",
- "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
- "memberOf" : "Roo.LayoutRegion",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minTabWidth",
- "type" : "Number",
- "desc" : "The minimum tab width (defaults to 40)",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "e) loadMask on the b",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "preferredTabWidth",
- "type" : "Number",
- "desc" : "The preferred tab width (defaults to 150)",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "main",
+ "type" : "Boolean",
+ "desc" : "e) main nav bar? default fal",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "preservePanels",
- "type" : "Boolean",
- "desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "resizeTabs",
- "type" : "Boolean",
- "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "showPin",
- "type" : "Boolean",
- "desc" : "True to show a pin button",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "v) default is n",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "header",
+ "footer",
+ "nav",
+ "div"
+ ]
},
{
- "name" : "split",
- "type" : "Boolean",
- "desc" : "To show the splitter",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tabPosition",
+ "name" : "type",
"type" : "String",
- "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom",
- "memberOf" : "Roo.LayoutRegion",
+ "desc" : "",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : [
- "top",
- "bottom"
+ "nav",
+ "pills",
+ "tabs"
]
},
{
- "name" : "title",
- "type" : "String",
- "desc" : "The title for the region (overrides panel titles)",
- "memberOf" : "Roo.LayoutRegion",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "titlebar",
- "type" : "Boolean",
- "desc" : "True to display a title bar (defaults to true)",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
- "name" : "toolbar",
- "type" : "Boolean",
- "desc" : "xtype configuration for a toolbar - shows on right of tabbar",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "e) default is ligh",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "light",
+ "primary",
+ "secondary",
+ "success",
+ "danger",
+ "warning",
+ "info",
+ "dark",
+ "white"
+ ]
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "For East/West panels",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
{
- "name" : "beforecollapse",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fires when this region before collapse.",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforeremove",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument.",
- "sig" : "function (_self, panel, e)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Object",
- "desc" : "The cancel event object",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "collapsed",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires when this region is collapsed.",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "expanded",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Fires when this region is expanded.",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "invalidated",
+ "name" : "beforetoggle",
"type" : "function",
- "desc" : "Fires when the layout for this region is changed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fire before toggle the menu",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.LayoutRegion",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "panelactivated",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires when a panel is activated.",
- "sig" : "function (_self, panel)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The activated panel",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "paneladded",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires when a panel is added.",
- "sig" : "function (_self, panel)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "panelremoved",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires when a panel is removed.",
- "sig" : "function (_self, panel)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resized",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires when the user resizes this region.",
- "sig" : "function (_self, newSize)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new size (width for east/west, height for north/south)",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "slidehide",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires when this region slides out of view.",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "slideshow",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires when this region is slid into view.",
+ "desc" : "Fires after the component is rendered.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "visibilitychange",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires when this region is shown or hidden",
- "sig" : "function (_self, visibility)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "visibility",
- "type" : "Boolean",
- "desc" : "true or false",
- "isOptional" : false
}
],
"returns" : []
}
],
"methods" : [
- {
- "name" : "add",
- "type" : "function",
- "desc" : "Adds the passed ContentPanel(s) to this region.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "Roo.LayoutRegion",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "ContentPanel...",
- "desc" : "The ContentPanel(s) to add (you can pass more than one)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel added (if only one was added; null otherwise)"
- }
- ]
- },
{
"name" : "addEvents",
"type" : "function",
{
"name" : "collapse",
"type" : "function",
- "desc" : "Collapses this region.",
- "sig" : "(skipAnim)",
+ "desc" : "Collapse the navbar pulldown",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "skipAnim",
- "type" : "Boolean",
- "desc" : "(optional) true to collapse the element without animation (if animate is true)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "expand",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Expands this region if it was previously collapsed.",
- "sig" : "(e, skipAnim)",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event that triggered the expand (or null if calling manually)",
- "isOptional" : false
- },
- {
- "name" : "skipAnim",
- "type" : "Boolean",
- "desc" : "(optional) true to expand the element without animation (if animate is true)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getActivePanel",
+ "name" : "enable",
"type" : "function",
- "desc" : "Get the active panel for this region.",
+ "desc" : "Enable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The active panel or null"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getEl",
+ "name" : "expand",
"type" : "function",
- "desc" : "Returns the container element for this region.",
+ "desc" : "Expand the navbar pulldown",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "fireEvent",
+ "type" : "function",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : ""
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "getPanel",
+ "name" : "focus",
"type" : "function",
- "desc" : "Returns the panel specified or null if it's not in this region.",
- "sig" : "(panel)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : ""
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getPosition",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Returns this regions position (north/south/east/west/center).",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
{
- "name" : "getSplitBar",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns the {@link Roo.SplitBar} for this region.",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.SplitBar",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "getTabs",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns the TabPanel component used by this region",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.TabPanel",
+ "type" : "String",
"desc" : ""
}
]
},
{
- "name" : "hasListener",
+ "name" : "getVisibilityEl",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Get the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "hasPanel",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Returns true if the panel is in this region.",
- "sig" : "(panel)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Boolean",
- "desc" : ""
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
"name" : "hide",
"type" : "function",
- "desc" : "Hides this region.",
+ "desc" : "Hide a component - adds 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "hidePanel",
+ "name" : "initEvents",
"type" : "function",
- "desc" : "Hides the tab for the specified panel.",
- "sig" : "(panel)",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
"name" : "isVisible",
"type" : "function",
- "desc" : "Returns true if this region is currently visible.",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
"name" : "on",
"isPrivate" : false,
"example" : "",
"deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "remove",
- "type" : "function",
- "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
- "sig" : "(panel, preservePanel)",
- "static" : false,
- "memberOf" : "Roo.LayoutRegion",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
- "isOptional" : false
- },
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "preservePanel",
- "type" : "Boolean",
- "desc" : "Overrides the config preservePanel option",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel that was removed"
- }
- ]
+ "returns" : []
},
{
"name" : "removeListener",
"returns" : []
},
{
- "name" : "resizeTo",
+ "name" : "render",
"type" : "function",
- "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
- "sig" : "(newSize)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new width or height",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setCollapsedTitle",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)",
- "sig" : "(title)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "title",
- "type" : "String",
- "desc" : "(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, \"&#160;\")",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Shows this region if it was previously hidden.",
+ "desc" : "Set the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "showPanel",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Shows the specified panel.",
- "sig" : "(panelId)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panelId",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The shown panel, or null if a panel could not be found from panelId"
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
}
],
"returns" : []
- },
- {
- "name" : "unhidePanel",
- "type" : "function",
- "desc" : "Unhides the tab for a previously hidden panel.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "Roo.LayoutRegion",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
+ "implementations" : [
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.PopoverNav",
+ "Roo.bootstrap.form.HtmlEditorToolbar.Standard",
+ "Roo.bootstrap.nav.Headerbar"
+ ],
+ "tree_children" : [
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.Link"
+ ],
"tree_parent" : []
},
- "Roo.bootstrap.menu" : {
+ "Roo.bootstrap.panel" : {
"props" : [],
"events" : [],
"methods" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.menu.Item" : {
+ "Roo.bootstrap.panel.Content" : {
"props" : [
{
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
+ "name" : "adjustments",
+ "type" : "Array",
+ "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "active",
- "type" : "Boolean",
- "desc" : "used on sidebars to highlight active itesm",
+ "name" : "autoCreate",
+ "type" : "Boolean/Object",
+ "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "allowDomMove",
+ "name" : "autoScroll",
"type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
+ "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "can_build_overlaid",
+ "name" : "background",
"type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "True if the panel should not be activated when it is added (defaults to false)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "badges",
+ "type" : "Boolean",
+ "desc" : "render the badges",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "closable",
+ "type" : "Boolean",
+ "desc" : "True if the panel can be closed/removed",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disableClass",
+ "name" : "cls",
"type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
+ "desc" : "extra classes to use",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "fa",
+ "name" : "content",
"type" : "String",
- "desc" : "favicon to show on left of menu item.",
+ "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
- },
- {
- "name" : "href",
- "type" : "String",
- "desc" : "the link",
+ "name" : "fitContainer",
+ "type" : "Boolean",
+ "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "html",
- "type" : "String",
- "desc" : "the menu label",
+ "name" : "fitToFrame",
+ "type" : "Boolean",
+ "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "isContainer",
+ "name" : "iframe",
"type" : "Boolean",
- "desc" : "is it a container - just returns a drop down item..",
+ "desc" : "contents are an iframe - makes showing remote sources/CSS feasible..",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"optvals" : []
},
{
- "name" : "menu",
- "type" : "Roo.bootsrap.Menu",
- "desc" : "the child menu.",
+ "name" : "loadOnce",
+ "type" : "Boolean",
+ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "do not trigger A href on clicks (default false).",
+ "name" : "region",
+ "type" : "String",
+ "desc" : "(center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "resizeEl",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title for this panel",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "toolbar",
+ "type" : "Toolbar",
+ "desc" : "A toolbar for this panel",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "el",
- "parent"
- ]
+ "optvals" : []
},
{
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "url",
+ "type" : "String",
+ "desc" : "Calls {@link #setUrl} with this value",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
{
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerender",
+ "name" : "activate",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "desc" : "Fires when this panel is activated.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "deactivate",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "desc" : "Fires when this panel is activated.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
+ "desc" : "Fires when this tab is created",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "click",
+ "name" : "resize",
"type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (_self, e)\n{\n\n}",
+ "desc" : "Fires when this panel is resized if fitToFrame is true.",
+ "sig" : "function (_self, width, height)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.menu.Item",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The width after any component adjustments",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The height after any component adjustments",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "scroll",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when this content is scrolled",
+ "sig" : "function (_self, scrollEvent)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "scrollEvent",
+ "type" : "Event",
"desc" : "",
"isOptional" : false
}
{
"name" : "destroy",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "desc" : "Destroys this panel",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
{
"name" : "fireEvent",
"type" : "function",
]
},
{
- "name" : "focus",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'Form',\n items: [ .... ]\n }\n);\n\n</code></pre>",
+ "sig" : "(cfg)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "name" : "cfg",
+ "type" : "Object",
+ "desc" : "Xtype definition of item to add.",
"isOptional" : false
}
],
+ "returns" : []
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns this panel's element - used by regiosn to add.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.Element",
+ "desc" : ""
}
]
},
{
- "name" : "getChildContainer",
+ "name" : "getId",
"type" : "function",
- "desc" : "Fetch the element to add children to",
+ "desc" : "Returns this panel's id",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getEl",
+ "name" : "getTitle",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Returns this panel's title",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getId",
+ "name" : "getToolbar",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Returns the toolbar for this Panel if one was configured.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
+ "type" : "Roo.Toolbar",
"desc" : ""
}
]
},
{
- "name" : "getVisibilityEl",
+ "name" : "getUpdateManager",
"type" : "function",
- "desc" : "Get the element that will be used to show or hide",
+ "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.UpdateManager",
+ "desc" : "The UpdateManager"
+ }
+ ]
},
{
"name" : "hasListener",
]
},
{
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "initEvents",
+ "name" : "isClosable",
"type" : "function",
- "desc" : "Initialize Events for the element",
+ "desc" : "Returns true is this panel was configured to be closable",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "isVisible",
+ "name" : "load",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.\nDoes not work with IFRAME contents",
+ "sig" : "(url, params, callback, discardUrl)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "url",
+ "type" : "Object/String/Function",
+ "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\npanel.load({\n url: \"your-url.php\",\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n callback: yourFunction,\n scope: yourObject, //(optional scope)\n discardUrl: false,\n nocache: false,\n text: \"Loading...\",\n timeout: 30,\n scripts: false\n});\n</code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
+ "isOptional" : false
+ },
+ {
+ "name" : "discardUrl",
+ "type" : "Boolean",
+ "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "on",
"params" : [],
"returns" : []
},
+ {
+ "name" : "refresh",
+ "type" : "function",
+ "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "releaseCapture",
"type" : "function",
"returns" : []
},
{
- "name" : "render",
+ "name" : "setContent",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Updates this panel's element (not for iframe)",
+ "sig" : "(content, loadScripts)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "content",
+ "type" : "String",
+ "desc" : "The new content",
+ "isOptional" : false
+ },
+ {
+ "name" : "loadScripts",
+ "type" : "Boolean",
+ "desc" : "(optional) true to look for and process scripts",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "setTitle",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Set this panel's title",
+ "sig" : "(title)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
+ "name" : "title",
+ "type" : "String",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "setVisibilityEl",
- "type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "setVisible",
+ "name" : "setUrl",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
+ "sig" : "(url, params, loadOnce)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
+ "name" : "url",
+ "type" : "String/Function",
+ "desc" : "The URL to load the content from or a function to call to get the URL",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
+ "isOptional" : false
+ },
+ {
+ "name" : "loadOnce",
"type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Roo.UpdateManager|Boolean",
+ "desc" : "The UpdateManager or false if IFRAME"
}
]
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
+ "implementations" : [
+ "Roo.bootstrap.panel.Grid",
+ "Roo.bootstrap.panel.Nest"
+ ],
"tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
"Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
"Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.form.CardUploader",
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.Row",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
"Roo.bootstrap.Column",
- "Roo.bootstrap.TabGroup"
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
],
"tree_parent" : [
- "Roo.bootstrap.menu.Menu"
+ "builder",
+ "Roo.bootstrap.layout.Border"
]
},
- "Roo.bootstrap.menu.Manager" : {
- "props" : [],
- "events" : [],
- "methods" : [
- {
- "name" : "get",
- "type" : "function",
- "desc" : "Returns a {@link Roo.menu.Menu} object",
- "sig" : "(menu)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "menu",
- "type" : "String/Object",
- "desc" : "The string menu id, an existing menu object reference, or a Menu config that will\nbe used to generate and return a new Menu instance.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "hideAll",
- "type" : "function",
- "desc" : "Hides all menus that are currently visible",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.bootstrap.menu.Menu" : {
+ "Roo.bootstrap.panel.Grid" : {
"props" : [
{
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
+ "name" : "adjustments",
+ "type" : "Array",
+ "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "align",
- "type" : "String",
- "desc" : "default tl-bl? == below - how the menu should be aligned.",
- "memberOf" : "",
+ "name" : "autoCreate",
+ "type" : "Boolean/Object",
+ "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "allowDomMove",
+ "name" : "autoScroll",
"type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
+ "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "can_build_overlaid",
+ "name" : "background",
"type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "True if the panel should not be activated when it is added (defaults to false)",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "badges",
+ "type" : "Boolean",
+ "desc" : "render the badges",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "closable",
+ "type" : "Boolean",
+ "desc" : "True if the panel can be closed/removed",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
- },
- {
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component",
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "extra classes to use",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disableClass",
+ "name" : "content",
"type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
+ "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hidden",
- "type" : "bool",
- "desc" : "if the menu should be hidden when rendered.",
- "memberOf" : "",
+ "name" : "fitContainer",
+ "type" : "Boolean",
+ "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
+ "name" : "fitToFrame",
+ "type" : "Boolean",
+ "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
+ "optvals" : []
},
{
- "name" : "hideTrigger",
- "type" : "bool",
- "desc" : "e) default false - hide the carret for trigge",
+ "name" : "grid",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "The grid for this panel",
"memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
+ "optvals" : []
},
{
- "name" : "isLink",
- "type" : "bool",
- "desc" : "e) the menu has link disable auto expand and collaspe (default fals",
- "memberOf" : "",
+ "name" : "iframe",
+ "type" : "Boolean",
+ "desc" : "contents are an iframe - makes showing remote sources/CSS feasible..",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
+ "optvals" : []
},
{
"name" : "listeners",
"optvals" : []
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "registerMenu",
+ "name" : "loadOnce",
"type" : "Boolean",
- "desc" : "True (default) - means that clicking on screen etc. hides it.",
- "memberOf" : "",
+ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "stopEvent",
- "type" : "bool",
- "desc" : "e) Stop event after trigger press (default tru",
- "memberOf" : "",
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
+ "optvals" : []
},
{
- "name" : "style",
+ "name" : "region",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "(center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "resizeEl",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "type",
+ "name" : "title",
"type" : "String",
- "desc" : "u) type of me",
- "memberOf" : "",
+ "desc" : "The title for this panel",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
- "optvals" : [
- "dropdown",
- "treeview",
- "submenu"
- ]
+ "optvals" : []
},
{
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "toolbar",
+ "type" : "Roo.bootstrap.nav.Simplebar",
+ "desc" : "the toolbar at the top of the grid.",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "el",
- "parent"
- ]
+ "optvals" : []
},
{
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "url",
+ "type" : "String",
+ "desc" : "Calls {@link #setUrl} with this value",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
{
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before this menu is hidden (return false to block)",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before this menu is displayed (return false to block)",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "click",
- "type" : "function",
- "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)",
- "sig" : "function (_self, menuItem, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "menuItem",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was clicked",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "disable",
+ "name" : "activate",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
+ "desc" : "Fires when this panel is activated.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "enable",
+ "name" : "deactivate",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
+ "desc" : "Fires when this panel is activated.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "hide",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires after this menu is hidden",
+ "desc" : "Fires when this tab is created",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "itemclick",
- "type" : "function",
- "desc" : "Fires when a menu item contained in this menu is clicked",
- "sig" : "function (baseItem, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "baseItem",
- "type" : "Roo.menu.BaseItem",
- "desc" : "The BaseItem that was clicked",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "mouseout",
+ "name" : "resize",
"type" : "function",
- "desc" : "Fires when the mouse exits this menu",
- "sig" : "function (_self, e, menuItem)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when this panel is resized if fitToFrame is true.",
+ "sig" : "function (_self, width, height)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.Menu",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The width after any component adjustments",
"isOptional" : false
},
{
- "name" : "menuItem",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was clicked",
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The height after any component adjustments",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "mouseover",
+ "name" : "scroll",
"type" : "function",
- "desc" : "Fires when the mouse is hovering over this menu",
- "sig" : "function (_self, e, menuItem)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when this content is scrolled",
+ "sig" : "function (_self, scrollEvent)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
},
{
- "name" : "menuItem",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was clicked",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after this menu is displayed",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.Menu",
+ "name" : "scrollEvent",
+ "type" : "Event",
"desc" : "",
"isOptional" : false
}
{
"name" : "destroy",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "desc" : "Destroys this panel",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "disable",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "enable",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'Form',\n items: [ .... ]\n }\n);\n\n</code></pre>",
+ "sig" : "(cfg)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "cfg",
+ "type" : "Object",
+ "desc" : "Xtype definition of item to add.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Returns this panel's element - used by regiosn to add.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "Roo.Element",
+ "desc" : ""
}
]
},
{
- "name" : "focus",
+ "name" : "getGrid",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Returns the grid for this panel",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.bootstrap.Table",
+ "desc" : ""
}
]
},
{
- "name" : "getChildContainer",
+ "name" : "getId",
"type" : "function",
- "desc" : "Fetch the element to add children to",
+ "desc" : "Returns this panel's id",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getEl",
+ "name" : "getTitle",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Returns this panel's title",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getId",
+ "name" : "getToolbar",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Returns the toolbar for this Panel if one was configured.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
+ "type" : "Roo.Toolbar",
"desc" : ""
}
]
},
{
- "name" : "getVisibilityEl",
+ "name" : "getUpdateManager",
"type" : "function",
- "desc" : "Get the element that will be used to show or hide",
+ "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.UpdateManager",
+ "desc" : "The UpdateManager"
+ }
+ ]
},
{
"name" : "hasListener",
]
},
{
- "name" : "hide",
+ "name" : "isClosable",
"type" : "function",
- "desc" : "Hides this menu and optionally all parent menus",
- "sig" : "(deep)",
+ "desc" : "Returns true is this panel was configured to be closable",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "deep",
+ "name" : "",
"type" : "Boolean",
- "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)",
- "isOptional" : false
+ "desc" : ""
}
- ],
- "returns" : []
- },
- {
- "name" : "initEvents",
- "type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
+ ]
},
{
- "name" : "isVisible",
+ "name" : "load",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.\nDoes not work with IFRAME contents",
+ "sig" : "(url, params, callback, discardUrl)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "url",
+ "type" : "Object/String/Function",
+ "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\npanel.load({\n url: \"your-url.php\",\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n callback: yourFunction,\n scope: yourObject, //(optional scope)\n discardUrl: false,\n nocache: false,\n text: \"Loading...\",\n timeout: 30,\n scripts: false\n});\n</code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
+ "isOptional" : false
+ },
+ {
+ "name" : "discardUrl",
+ "type" : "Boolean",
+ "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "on",
"params" : [],
"returns" : []
},
+ {
+ "name" : "refresh",
+ "type" : "function",
+ "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "releaseCapture",
"type" : "function",
"returns" : []
},
{
- "name" : "render",
+ "name" : "setContent",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Updates this panel's element (not for iframe)",
+ "sig" : "(content, loadScripts)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "content",
+ "type" : "String",
+ "desc" : "The new content",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setDisabled",
- "type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "disabled",
+ "name" : "loadScripts",
"type" : "Boolean",
- "desc" : "",
+ "desc" : "(optional) true to look for and process scripts",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setVisibilityEl",
- "type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "setVisible",
+ "name" : "setTitle",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Set this panel's title",
+ "sig" : "(title)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "title",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "show",
+ "name" : "setUrl",
"type" : "function",
- "desc" : "Displays this menu relative to another element",
- "sig" : "(element, position, parentMenu)",
+ "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
+ "sig" : "(url, params, loadOnce)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "element",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The element to align to",
- "isOptional" : false
- },
- {
- "name" : "position",
- "type" : "String",
- "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)",
+ "name" : "url",
+ "type" : "String/Function",
+ "desc" : "The URL to load the content from or a function to call to get the URL",
"isOptional" : false
},
{
- "name" : "parentMenu",
- "type" : "Roo.menu.Menu",
- "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "showAt",
- "type" : "function",
- "desc" : "Displays this menu at a specific xy position",
- "sig" : "(xyPosition, parentMenu)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "xyPosition",
- "type" : "Array",
- "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)",
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
"isOptional" : false
},
{
- "name" : "parentMenu",
- "type" : "Roo.menu.Menu",
- "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
+ "name" : "loadOnce",
+ "type" : "Boolean",
+ "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Roo.UpdateManager|Boolean",
+ "desc" : "The UpdateManager or false if IFRAME"
}
]
},
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.menu.Item",
- "Roo.bootstrap.menu.Separator"
- ],
- "tree_parent" : [
- "none"
- ]
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.menu.Separator" : {
+ "Roo.bootstrap.panel.Nest" : {
"props" : [
{
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
+ "name" : "adjustments",
+ "type" : "Array",
+ "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
+ "name" : "autoCreate",
+ "type" : "Boolean/Object",
+ "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "can_build_overlaid",
+ "name" : "autoScroll",
"type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "background",
+ "type" : "Boolean",
+ "desc" : "True if the panel should not be activated when it is added (defaults to false)",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "badges",
+ "type" : "Boolean",
+ "desc" : "render the badges",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "closable",
+ "type" : "Boolean",
+ "desc" : "True if the panel can be closed/removed",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disableClass",
+ "name" : "cls",
"type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
+ "desc" : "extra classes to use",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hideMode",
+ "name" : "content",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
+ "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
+ "optvals" : []
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
+ "name" : "fitContainer",
+ "type" : "Boolean",
+ "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "fitToFrame",
+ "type" : "Boolean",
+ "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "iframe",
+ "type" : "Boolean",
+ "desc" : "contents are an iframe - makes showing remote sources/CSS feasible..",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "layout",
+ "type" : "Roo.layout.Border",
+ "desc" : "The layout for this panel",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
"isOptional" : false,
- "optvals" : [
- "el",
- "parent"
- ]
+ "optvals" : []
},
{
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "loadOnce",
+ "type" : "Boolean",
+ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
- }
- ],
- "events" : [
+ },
{
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "region",
+ "type" : "String",
+ "desc" : "(center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "resizeEl",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title for this panel",
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "toolbar",
+ "type" : "Toolbar",
+ "desc" : "A toolbar for this panel",
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "childrenrendered",
+ "name" : "url",
+ "type" : "String",
+ "desc" : "Calls {@link #setUrl} with this value",
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "activate",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
+ "desc" : "Fires when this panel is activated.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "deactivate",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
+ "desc" : "Fires when this panel is activated.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "disable",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
+ "desc" : "Fires when this tab is created",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "enable",
+ "name" : "resize",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when this panel is resized if fitToFrame is true.",
+ "sig" : "function (_self, width, height)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The width after any component adjustments",
+ "isOptional" : false
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The height after any component adjustments",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "scroll",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when this content is scrolled",
+ "sig" : "function (_self, scrollEvent)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "scrollEvent",
+ "type" : "Event",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "addxtype",
+ "type" : "function",
+ "desc" : "Adds a xtype elements to the layout of the nested panel\n<pre><code>\n\npanel.addxtype({\n xtype : 'ContentPanel',\n region: 'west',\n items: [ .... ]\n }\n);\n\npanel.addxtype({\n xtype : 'NestedLayoutPanel',\n region: 'west',\n layout: {\n center: { },\n west: { } \n },\n items : [ ... list of content panels or nested layout panels.. ]\n }\n);\n</code></pre>",
+ "sig" : "(cfg)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "cfg",
+ "type" : "Object",
+ "desc" : "Xtype definition of item to add.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
{
"name" : "destroy",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "desc" : "Destroys this panel",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "disable",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "enable",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'Form',\n items: [ .... ]\n }\n);\n\n</code></pre>",
+ "sig" : "(cfg)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "cfg",
+ "type" : "Object",
+ "desc" : "Xtype definition of item to add.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Returns this panel's element - used by regiosn to add.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "Roo.Element",
+ "desc" : ""
}
]
},
{
- "name" : "focus",
+ "name" : "getId",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Returns this panel's id",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getChildContainer",
+ "name" : "getLayout",
"type" : "function",
- "desc" : "Fetch the element to add children to",
+ "desc" : "Returns the nested BorderLayout for this panel",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Roo.layout.Border",
+ "desc" : ""
}
]
},
{
- "name" : "getEl",
+ "name" : "getTitle",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Returns this panel's title",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getId",
+ "name" : "getToolbar",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Returns the toolbar for this Panel if one was configured.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
+ "type" : "Roo.Toolbar",
"desc" : ""
}
]
},
{
- "name" : "getVisibilityEl",
+ "name" : "getUpdateManager",
"type" : "function",
- "desc" : "Get the element that will be used to show or hide",
+ "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.UpdateManager",
+ "desc" : "The UpdateManager"
+ }
+ ]
},
{
"name" : "hasListener",
]
},
{
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "initEvents",
+ "name" : "isClosable",
"type" : "function",
- "desc" : "Initialize Events for the element",
+ "desc" : "Returns true is this panel was configured to be closable",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "isVisible",
+ "name" : "load",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.\nDoes not work with IFRAME contents",
+ "sig" : "(url, params, callback, discardUrl)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "url",
+ "type" : "Object/String/Function",
+ "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\npanel.load({\n url: \"your-url.php\",\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n callback: yourFunction,\n scope: yourObject, //(optional scope)\n discardUrl: false,\n nocache: false,\n text: \"Loading...\",\n timeout: 30,\n scripts: false\n});\n</code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
+ "isOptional" : false
+ },
+ {
+ "name" : "discardUrl",
+ "type" : "Boolean",
+ "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "on",
"params" : [],
"returns" : []
},
+ {
+ "name" : "refresh",
+ "type" : "function",
+ "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "releaseCapture",
"type" : "function",
"returns" : []
},
{
- "name" : "render",
+ "name" : "setContent",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Updates this panel's element (not for iframe)",
+ "sig" : "(content, loadScripts)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "content",
+ "type" : "String",
+ "desc" : "The new content",
+ "isOptional" : false
+ },
+ {
+ "name" : "loadScripts",
+ "type" : "Boolean",
+ "desc" : "(optional) true to look for and process scripts",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "setTitle",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Set this panel's title",
+ "sig" : "(title)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
+ "name" : "title",
+ "type" : "String",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "setVisibilityEl",
- "type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "setVisible",
+ "name" : "setUrl",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
+ "sig" : "(url, params, loadOnce)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
+ "name" : "url",
+ "type" : "String/Function",
+ "desc" : "The URL to load the content from or a function to call to get the URL",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
+ "isOptional" : false
+ },
+ {
+ "name" : "loadOnce",
"type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Roo.UpdateManager|Boolean",
+ "desc" : "The UpdateManager or false if IFRAME"
}
]
},
"isBuilderTop" : false,
"implementations" : [],
"tree_children" : [],
- "tree_parent" : [
- "Roo.bootstrap.menu.Menu"
- ]
- },
- "Roo.bootstrap.nav" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.nav.Bar" : {
+ "Roo.bootstrap.panel.TabItem" : {
"props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
- },
{
"name" : "listeners",
"type" : "Object",
"memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
- },
- {
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : [
- "el",
- "parent"
- ]
- },
- {
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
}
],
"events" : [
{
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforetoggle",
+ "name" : "activate",
"type" : "function",
- "desc" : "Fire before toggle the menu",
- "sig" : "function (e)\n{\n\n}",
+ "desc" : "Fires when this tab becomes the active tab.",
+ "sig" : "function (tabPanel, _self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
- "desc" : "",
+ "name" : "tabPanel",
+ "type" : "Roo.TabPanel",
+ "desc" : "The parent TabPanel",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.TabPanelItem",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "disable",
+ "name" : "beforeclose",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires before this tab is closed. To cancel the close, set cancel to true on e (e.cancel = true).",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.TabPanelItem",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "Set cancel to true on this object to cancel the close.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "hide",
+ "name" : "close",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires when this tab is closed.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.TabPanelItem",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "render",
+ "name" : "deactivate",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when this tab is no longer the active tab.",
+ "sig" : "function (tabPanel, _self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "tabPanel",
+ "type" : "Roo.TabPanel",
+ "desc" : "The parent TabPanel",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.TabPanelItem",
"desc" : "",
"isOptional" : false
}
],
"methods" : [
{
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "addListener",
- "type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "capture",
- "type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "collapse",
+ "name" : "activate",
"type" : "function",
- "desc" : "Collapse the navbar pulldown",
+ "desc" : "Activates this TabPanelItem -- this <b>does</b> deactivate the currently active TabPanelItem.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "expand",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Expand the navbar pulldown",
- "sig" : "()\n{\n\n}",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "focus",
+ "name" : "capture",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getChildContainer",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fetch the element to add children to",
+ "desc" : "Disables this TabPanelItem -- this does nothing if this is the active TabPanelItem.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
+ "returns" : []
},
{
- "name" : "getEl",
+ "name" : "enable",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Enables this TabPanelItem if it was previously disabled.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "fireEvent",
+ "type" : "function",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "getId",
+ "name" : "getText",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Returns the text for this tab",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
]
},
{
- "name" : "getVisibilityEl",
+ "name" : "getUpdateManager",
"type" : "function",
- "desc" : "Get the element that will be used to show or hide",
+ "desc" : "Gets the {@link Roo.UpdateManager} for the body of this TabPanelItem. Enables you to perform Ajax updates.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.UpdateManager",
+ "desc" : "The UpdateManager"
+ }
+ ]
},
{
"name" : "hasListener",
{
"name" : "hide",
"type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
+ "desc" : "Hides this TabPanelItem -- if you don't activate another TabPanelItem this could look odd.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "initEvents",
+ "name" : "isActive",
"type" : "function",
- "desc" : "Initialize Events for the element",
+ "desc" : "Returns true if this tab is the active tab.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "isVisible",
+ "name" : "isHidden",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
+ "desc" : "Returns true if this tab is \"hidden\"",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
"name" : "on",
"params" : [],
"returns" : []
},
+ {
+ "name" : "refresh",
+ "type" : "function",
+ "desc" : "Forces a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the setUrl method has not been called.\n This does not activate the panel, just updates its content.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "releaseCapture",
"type" : "function",
"returns" : []
},
{
- "name" : "render",
+ "name" : "setContent",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Sets the content for this TabPanelItem.",
+ "sig" : "(content, loadScripts)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "content",
+ "type" : "String",
+ "desc" : "The content",
+ "isOptional" : false
+ },
+ {
+ "name" : "loadScripts",
+ "type" : "Boolean",
+ "desc" : "true to look for and load scripts",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "setHidden",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Show or hide the tab",
+ "sig" : "(hidden)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
+ "name" : "hidden",
"type" : "Boolean",
- "desc" : "",
+ "desc" : "True to hide or false to show.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setVisibilityEl",
+ "name" : "setText",
"type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the text for the tab (Note: this also sets the tooltip text)",
+ "sig" : "(text)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "The tab's text and tooltip",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "setTooltip",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Set the tooltip for the tab.",
+ "sig" : "(tooltip)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "tooltip",
+ "type" : "String",
+ "desc" : "The tab's tooltip",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "show",
+ "name" : "setUrl",
"type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
+ "desc" : "Set a URL to be used to load the content for this TabPanelItem.",
+ "sig" : "(url, params, loadOnce)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "url",
+ "type" : "String/Function",
+ "desc" : "The URL to load the content from, or a function to call to get the URL",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
+ "isOptional" : false
+ },
+ {
+ "name" : "loadOnce",
+ "type" : "Boolean",
+ "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this TabPanelItem is activated. (Defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.UpdateManager",
+ "desc" : "The UpdateManager"
+ }
+ ]
},
{
- "name" : "tooltipEl",
+ "name" : "show",
"type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
+ "desc" : "Shows this TabPanelItem -- this <b>does not</b> deactivate the currently active TabPanelItem.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
+ "returns" : []
},
{
"name" : "un",
"returns" : []
}
],
- "isAbstract" : true,
+ "isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.bootstrap.PagingToolbar",
- "Roo.bootstrap.PopoverNav",
- "Roo.bootstrap.form.HtmlEditorToolbar.Standard",
- "Roo.bootstrap.nav.Headerbar",
- "Roo.bootstrap.nav.Sidebar",
- "Roo.bootstrap.nav.Simplebar"
- ],
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.nav.Group" : {
+ "Roo.bootstrap.panel.Tabs" : {
"props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "left",
- "right"
- ]
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
- },
- {
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
"memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
- },
- {
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "navId",
- "type" : "String",
- "desc" : "- reference Id for navbar.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "pilltype",
- "type" : "Boolean",
- "desc" : "default true (turn to off to disable active toggle)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "type",
- "type" : "String",
- "desc" : "b) default n",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "nav",
- "pills",
- "tab"
- ]
- },
- {
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : [
- "el",
- "parent"
- ]
- },
- {
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
}
],
"events" : [
{
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "changed",
+ "name" : "beforetabchange",
"type" : "function",
- "desc" : "Fires when the active item changes",
- "sig" : "function (_self, selected, prev)\n{\n\n}",
+ "desc" : "Fires before the active tab changes, set cancel to true on the \"e\" parameter to cancel the change",
+ "sig" : "function (_self, e, tab)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.nav.Group",
+ "type" : "Roo.TabPanel",
"desc" : "",
"isOptional" : false
},
{
- "name" : "selected",
- "type" : "Roo.bootstrap.Navbar.Item",
- "desc" : "The item selected",
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "Set cancel to true on this object to cancel the tab change",
"isOptional" : false
},
{
- "name" : "prev",
- "type" : "Roo.bootstrap.Navbar.Item",
- "desc" : "The previously selected item",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "tab",
+ "type" : "Roo.TabPanelItem",
+ "desc" : "The tab being changed to",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "tabchange",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when the active tab changes",
+ "sig" : "function (_self, activePanel)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.TabPanel",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "activePanel",
+ "type" : "Roo.TabPanelItem",
+ "desc" : "The new active tab",
"isOptional" : false
}
],
],
"methods" : [
{
- "name" : "addEvents",
+ "name" : "activate",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Activates a {@link Roo.TabPanelItem}. The currently active one will be deactivated.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to activate.",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.TabPanelItem",
+ "desc" : "The TabPanelItem."
+ }
+ ]
},
{
- "name" : "addItem",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "adds a Navigation item",
- "sig" : "(the)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "the",
- "type" : "Roo.bootstrap.nav.Item",
- "desc" : "navitem to add",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "addTab",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Creates a new {@link Roo.TabPanelItem} by looking for an existing element with the provided id -- if it's not found it creates one.",
+ "sig" : "(id, text, content, closable)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the div to use <b>or create</b>",
"isOptional" : false
},
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "text",
+ "type" : "String",
+ "desc" : "The text for the tab",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "content",
+ "type" : "String",
+ "desc" : "(optional) Content to put in the TabPanelItem body",
+ "isOptional" : false
+ },
+ {
+ "name" : "closable",
+ "type" : "Boolean",
+ "desc" : "(optional) True to create a close icon on the tab",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.TabPanelItem",
+ "desc" : "The created TabPanelItem"
+ }
+ ]
},
{
- "name" : "clearAll",
+ "name" : "addTabItem",
"type" : "function",
- "desc" : "clear all the Navigation item",
- "sig" : "()\n{\n\n}",
+ "desc" : "Adds an existing {@link Roo.TabPanelItem}.",
+ "sig" : "(item)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "item",
+ "type" : "Roo.TabPanelItem",
+ "desc" : "The TabPanelItem to add",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "autoSizeTabs",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "desc" : "Manual call to resize the tabs (if {@link #resizeTabs} is false this does nothing)",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "disable",
+ "name" : "beginUpdate",
"type" : "function",
- "desc" : "Disable this component.",
+ "desc" : "Disables tab resizing while tabs are being added (if {@link #resizeTabs} is false this does nothing)",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "enable",
+ "name" : "capture",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Destroys this TabPanel",
+ "sig" : "(removeEl)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "removeEl",
+ "type" : "Boolean",
+ "desc" : "(optional) True to remove the element from the DOM as well (defaults to undefined)",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
},
{
- "name" : "focus",
+ "name" : "disableTab",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Disables a {@link Roo.TabPanelItem}. It cannot be the active tab, if it is this call is ignored.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to disable.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "get",
+ "name" : "enableTab",
"type" : "function",
- "desc" : "fetch a Navigation Group based on the navigation ID",
- "sig" : "(the)",
- "static" : true,
+ "desc" : "Enables a {@link Roo.TabPanelItem} that is disabled.",
+ "sig" : "(id)",
+ "static" : false,
"memberOf" : "",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "the",
- "type" : "string",
- "desc" : "navgroup to add",
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to enable.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "getActive",
+ "name" : "endUpdate",
"type" : "function",
- "desc" : "gets the active Navigation item",
+ "desc" : "Stops an update and resizes the tabs (if {@link #resizeTabs} is false this does nothing)",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.bootstrap.nav.Item",
- "desc" : "the current navitem"
- }
- ]
+ "returns" : []
},
{
- "name" : "getChildContainer",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "getEl",
+ "name" : "getActiveTab",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Gets the active {@link Roo.TabPanelItem}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "Roo.TabPanelItem",
+ "desc" : "The active TabPanelItem or null if none are active."
}
]
},
{
- "name" : "getId",
+ "name" : "getCount",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Returns the number of tabs in this TabPanel.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
+ "type" : "Number",
"desc" : ""
}
]
},
{
- "name" : "getVisibilityEl",
+ "name" : "getTab",
"type" : "function",
- "desc" : "Get the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the {@link Roo.TabPanelItem} with the specified id/index",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to fetch.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.TabPanelItem",
+ "desc" : ""
+ }
+ ]
},
{
"name" : "hasListener",
]
},
{
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "initEvents",
- "type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isVisible",
+ "name" : "hideTab",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Hides the {@link Roo.TabPanelItem} with the specified id/index",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to hide.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
"params" : [],
"returns" : []
},
- {
- "name" : "register",
- "type" : "function",
- "desc" : "register a Navigation item",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.nav.Item",
- "desc" : "navitem to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "register",
- "type" : "function",
- "desc" : "register a Navigation Group",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.nav.Group",
- "desc" : "navgroup to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "releaseCapture",
"type" : "function",
"returns" : []
},
{
- "name" : "render",
+ "name" : "removeTab",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Removes a {@link Roo.TabPanelItem}.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to remove.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setActiveItem",
+ "name" : "setTabWidth",
"type" : "function",
- "desc" : "sets the active Navigation item",
- "sig" : "(the)",
+ "desc" : "Resizes all the tabs to the passed width",
+ "sig" : "(The)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "the",
- "type" : "Roo.bootstrap.nav.Item",
- "desc" : "new current navitem",
+ "name" : "The",
+ "type" : "Number",
+ "desc" : "new width",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "syncHeight",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Updates the tab body element to fit the height of the container element\nfor overflow scrolling",
+ "sig" : "(targetHeight)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "targetHeight",
+ "type" : "Number",
+ "desc" : "(optional) Override the starting height from the elements height",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setVisibilityEl",
+ "name" : "un",
"type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "unhideTab",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "\"Unhides\" the {@link Roo.TabPanelItem} with the specified id/index.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to unhide.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
"returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.ArrayReader" : {
+ "props" : [
+ {
+ "name" : "fields",
+ "type" : "Array",
+ "desc" : "Array of field definition objects",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "tooltipEl",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "Name of the property within a row object that contains a record identifier value.\nas specified to {@link Roo.data.Record#create},\nor an {@link Roo.data.Record} object\n\n\ncreated using {@link Roo.data.Record#create}.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "newRow",
"type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Create an empty record",
+ "sig" : "(data)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.data.DataReader",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "(optional) - overlay some values",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Roo.data.Record",
+ "desc" : "record created."
}
]
},
{
- "name" : "un",
+ "name" : "readRecords",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Create a data block containing Roo.data.Records from an XML document.",
+ "sig" : "(o)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
+ "name" : "o",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "An Array of row objects which represents the dataset.",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "A data block which is used by an {@link Roo.data.Store} object as\na cache of Roo.data.Records."
+ }
+ ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.nav.Item",
- "Roo.bootstrap.nav.SidebarItem"
- ],
+ "tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.nav.Headerbar" : {
+ "Roo.data.Connection" : {
"props" : [
{
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) alignme",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
- "isOptional" : false,
- "optvals" : [
- "left",
- "right"
- ]
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "arrangement",
- "type" : "Boolean",
- "desc" : "stacked | justified",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autohide",
+ "name" : "autoAbort",
"type" : "Boolean",
- "desc" : "a top nav bar header that hides on scroll.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "brand",
- "type" : "String",
- "desc" : "what is brand",
+ "desc" : "Whether this request should abort any pending requests. (defaults to false)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "brand_href",
- "type" : "String",
- "desc" : "href of the brand",
+ "name" : "defaultHeaders",
+ "type" : "Object",
+ "desc" : "An object containing request headers which are added\n to each request made by this object. (defaults to undefined)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "desktopCenter",
+ "name" : "disableCaching",
"type" : "Boolean",
- "desc" : "should the header be centered on desktop using a container class",
+ "desc" : "True to add a unique cache-buster param to GET requests. (defaults to true)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
- },
- {
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "is inverted color",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "name" : "extraParams",
+ "type" : "Object",
+ "desc" : "An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "loadMask",
- "type" : "Boolean",
- "desc" : "e) loadMask on the b",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "main",
- "type" : "Boolean",
- "desc" : "e) main nav bar? default fal",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "mobilerow",
- "type" : "Roo.bootstrap.Row",
- "desc" : "- a row to display on mobile only..",
+ "name" : "method",
+ "type" : "String",
+ "desc" : "The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "timeout",
+ "type" : "Number",
+ "desc" : "The timeout in milliseconds to be used for requests. (defaults to 30000)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "position",
+ "name" : "url",
"type" : "String",
- "desc" : "p) positi",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "fixed-top",
- "fixed-bottom",
- "static-top"
- ]
- },
- {
- "name" : "srButton",
- "type" : "Boolean",
- "desc" : "generate the (screen reader / mobile) sr-only button default true",
+ "desc" : "The default URL to be used for requests to the server. (defaults to undefined)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
- },
+ }
+ ],
+ "events" : [
{
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
+ "name" : "beforerequest",
+ "type" : "function",
+ "desc" : "Fires before a network request is made to retrieve a data object.",
+ "sig" : "function (conn, options)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "conn",
+ "type" : "Connection",
+ "desc" : "This Connection object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The options config object passed to the {@link #request} method.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "tag",
- "type" : "String",
- "desc" : "v) default is n",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
- "isOptional" : false,
- "optvals" : [
- "header",
- "footer",
- "nav",
- "div"
- ]
+ "name" : "requestcomplete",
+ "type" : "function",
+ "desc" : "Fires if the request was successfully completed.",
+ "sig" : "function (conn, response, options)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "conn",
+ "type" : "Connection",
+ "desc" : "This Connection object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "response",
+ "type" : "Object",
+ "desc" : "The XHR object containing the response data.\nSee {@link http://www.w3.org/TR/XMLHttpRequest/} for details.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The options config object passed to the {@link #request} method.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
+ "name" : "requestexception",
+ "type" : "function",
+ "desc" : "Fires if an error HTTP status was returned from the server.\nSee {@link http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html} for details of HTTP status codes.",
+ "sig" : "function (conn, response, options)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "conn",
+ "type" : "Connection",
+ "desc" : "This Connection object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "response",
+ "type" : "Object",
+ "desc" : "The XHR object containing the response data.\nSee {@link http://www.w3.org/TR/XMLHttpRequest/} for details.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The options config object passed to the {@link #request} method.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
{
- "name" : "type",
- "type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
- "isOptional" : false,
- "optvals" : [
- "nav",
- "pills",
- "tabs"
- ]
+ "name" : "abort",
+ "type" : "function",
+ "desc" : "Aborts any outstanding request.",
+ "sig" : "(transactionId)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "transactionId",
+ "type" : "Number",
+ "desc" : "defaults to the last transaction",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : [
- "el",
- "parent"
- ]
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "weight",
- "type" : "String",
- "desc" : "e) default is ligh",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
- "isOptional" : false,
- "optvals" : [
- "light",
- "primary",
- "secondary",
- "success",
- "danger",
- "warning",
- "info",
- "dark",
- "white"
- ]
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "beforedestroy",
+ "name" : "capture",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforehide",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "eventName",
+ "type" : "String",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "beforerender",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "beforeshow",
+ "name" : "isLoading",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Determine whether this object has a request outstanding.",
+ "sig" : "(transactionId)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "transactionId",
+ "type" : "Number",
+ "desc" : "defaults to the last transaction",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if there is an outstanding request."
+ }
+ ]
},
{
- "name" : "beforetoggle",
+ "name" : "on",
"type" : "function",
- "desc" : "Fire before toggle the menu",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.nav.Bar",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "request",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Sends an HTTP request to a remote server.",
+ "sig" : "(options)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "An object which may contain the following properties:<ul>\n<li><b>url</b> {String} The URL to which to send the request. Defaults to configured URL</li>\n<li><b>params</b> {Object/String/Function} An object containing properties which are used as parameters to the\nrequest, a url encoded string or a function to call to get either.</li>\n<li><b>method</b> {String} The HTTP method to use for the request. Defaults to the configured method, or\nif no method was configured, \"GET\" if no parameters are being sent, and \"POST\" if parameters are being sent.</li>\n<li><b>callback</b> {Function} The function to be called upon receipt of the HTTP response.\nThe callback is called regardless of success or failure and is passed the following parameters:<ul>\n<li>options {Object} The parameter to the request call.</li>\n<li>success {Boolean} True if the request succeeded.</li>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n</ul></li>\n<li><b>success</b> {Function} The function to be called upon success of the request.\nThe callback is passed the following parameters:<ul>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n<li>options {Object} The parameter to the request call.</li>\n</ul></li>\n<li><b>failure</b> {Function} The function to be called upon failure of the request.\nThe callback is passed the following parameters:<ul>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n<li>options {Object} The parameter to the request call.</li>\n</ul></li>\n<li><b>scope</b> {Object} The scope in which to execute the callbacks: The \"this\" object\nfor the callback function. Defaults to the browser window.</li>\n<li><b>form</b> {Object/String} A form object or id to pull parameters from.</li>\n<li><b>isUpload</b> {Boolean} True if the form object is a file upload (will usually be automatically detected).</li>\n<li><b>headers</b> {Object} Request headers to set for the request.</li>\n<li><b>xmlData</b> {Object} XML document to use for the post. Note: This will be used instead of\nparams for the post data. Any params will be appended to the URL.</li>\n<li><b>disableCaching</b> {Boolean} True to add a unique cache-buster param to GET requests.</li>\n</ul>",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "transactionId"
+ }
+ ]
},
{
- "name" : "enable",
+ "name" : "un",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.Ajax"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.DataProxy" : {
+ "props" : [
{
- "name" : "hide",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforeload",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires before a network request is made to retrieve a data object.",
+ "sig" : "function (This, params)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "DataProxy object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "Object",
+ "desc" : "The params parameter to the load function.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "load",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires before the load method's callback is called.",
+ "sig" : "function (This, o, arg)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "DataProxy object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The data object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "arg",
+ "type" : "Object",
+ "desc" : "The callback argument object passed to the load function.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "loadexception",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires if an Exception occurs during data retrieval.",
+ "sig" : "function (This, o, arg, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "DataProxy object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The data object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "arg",
+ "type" : "Object",
+ "desc" : "The callback argument object passed to the load function.",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "The Exception.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "collapse",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Collapse the navbar pulldown",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.bootstrap.nav.Bar",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "destroy",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "disable",
+ "name" : "on",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "enable",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Enable this component.",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "expand",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Expand the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.nav.Bar",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "focus",
+ "name" : "un",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
- },
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : true,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.data.HttpProxy",
+ "Roo.data.MemoryProxy"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.DataReader" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "getChildContainer",
+ "name" : "newRow",
"type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
+ "desc" : "Create an empty record",
+ "sig" : "(data)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "(optional) - overlay some values",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Roo.data.Record",
+ "desc" : "record created."
}
]
+ }
+ ],
+ "isAbstract" : true,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.data.ArrayReader",
+ "Roo.data.JsonReader",
+ "Roo.data.XmlReader"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.HttpProxy" : {
+ "props" : [
+ {
+ "name" : "autoAbort",
+ "type" : "Boolean",
+ "desc" : "Whether this request should abort any pending requests. (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "getEl",
+ "name" : "defaultHeaders",
+ "type" : "Object",
+ "desc" : "An object containing request headers which are added\n to each request made by this object. (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableCaching",
+ "type" : "Boolean",
+ "desc" : "True to add a unique cache-buster param to GET requests. (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "extraParams",
+ "type" : "Object",
+ "desc" : "An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "method",
+ "type" : "String",
+ "desc" : "T) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GE",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "GET",
+ "POST"
+ ]
+ },
+ {
+ "name" : "timeout",
+ "type" : "Number",
+ "desc" : "The timeout in milliseconds to be used for requests. (defaults to 30000)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "url",
+ "type" : "String",
+ "desc" : "The default URL to be used for requests to the server. (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforeload",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires before a network request is made to retrieve a data object.",
+ "sig" : "function (This, params)\n{\n\n}",
+ "memberOf" : "Roo.data.DataProxy",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "DataProxy object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "Object",
+ "desc" : "The params parameter to the load function.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "load",
+ "type" : "function",
+ "desc" : "Fires before the load method's callback is called.",
+ "sig" : "function (This, o, arg)\n{\n\n}",
+ "memberOf" : "Roo.data.DataProxy",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "DataProxy object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The data object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "arg",
+ "type" : "Object",
+ "desc" : "The callback argument object passed to the load function.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "loadexception",
+ "type" : "function",
+ "desc" : "Fires if an Exception occurs during data retrieval.",
+ "sig" : "function (This, o, arg, e)\n{\n\n}",
+ "memberOf" : "Roo.data.DataProxy",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "DataProxy object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The data object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "arg",
+ "type" : "Object",
+ "desc" : "The callback argument object passed to the load function.",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "The Exception.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getId",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
+ "name" : "eventName",
"type" : "String",
- "desc" : ""
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getVisibilityEl",
+ "name" : "capture",
"type" : "function",
- "desc" : "Get the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "hasListener",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The name of the event to check for",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "hide",
+ "name" : "getConnection",
"type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
+ "desc" : "Return the {@link Roo.data.Connection} object being used by this Proxy.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Connection",
+ "desc" : "The Connection object. This object may be used to subscribe to events on\na finer-grained basis than the DataProxy events."
+ }
+ ]
},
{
- "name" : "initEvents",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "isVisible",
+ "name" : "load",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Load data from the configured {@link Roo.data.Connection}, read the data object into\na block of Roo.data.Records using the passed {@link Roo.data.DataReader} implementation, and\nprocess that block using the passed callback.",
+ "sig" : "(params, reader, callback, scope, arg)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "params",
+ "type" : "Object",
+ "desc" : "An object containing properties which are to be used as HTTP parameters\nfor the request to the remote server.",
+ "isOptional" : false
+ },
+ {
+ "name" : "reader",
+ "type" : "Roo.data.DataReader",
+ "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "The function into which to pass the block of Roo.data.Records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "The scope in which to call the callback",
+ "isOptional" : false
+ },
+ {
+ "name" : "arg",
+ "type" : "Object",
+ "desc" : "An optional argument which is passed to the callback as its second parameter.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
],
"returns" : []
},
- {
- "name" : "render",
- "type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setDisabled",
- "type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setVisibilityEl",
- "type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
- },
{
"name" : "un",
"type" : "function",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.nav.Group",
- "Roo.bootstrap.form.Form",
- "Roo.bootstrap.Row",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.TabGroup",
- "Roo.bootstrap.Link"
- ],
+ "tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.nav.Item" : {
+ "Roo.data.JsonReader" : {
"props" : [
{
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "active",
- "type" : "Boolean",
- "desc" : "Is item active",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "animateRef",
- "type" : "Boolean",
- "desc" : "e) link to element default fal",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "badge",
- "type" : "String",
- "desc" : "text inside badge",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "badgecls",
- "type" : "String",
- "desc" : "w)the extra classes for the bad",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "bg-green",
- "bg-red",
- "bg-yellow"
- ]
- },
- {
- "name" : "button_outline",
- "type" : "Boolean",
- "desc" : "show and outlined button",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "button_weight",
- "type" : "String",
- "desc" : "k) default no",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "default",
- "primary",
- "secondary",
- "success",
- "info",
- "warning",
- "danger",
- "link",
- "light",
- "dark"
- ]
- },
- {
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "Is item disabled",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fa",
- "type" : "String",
- "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "glyphicon",
- "type" : "String",
- "desc" : "DEPRICATED - use fa",
+ "name" : "fields",
+ "type" : "Array",
+ "desc" : "Array of field definition objects",
"memberOf" : "",
"isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
+ "optvals" : []
},
{
- "name" : "href",
+ "name" : "id",
"type" : "String",
- "desc" : "link to",
+ "desc" : "Name of the property within a row object that contains a record identifier value.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "html",
+ "name" : "root",
"type" : "String",
- "desc" : "content of button",
+ "desc" : "name of the property which contains the Array of row objects.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "icon",
+ "name" : "successProperty",
"type" : "String",
- "desc" : "DEPRICATED - use fa",
+ "desc" : "Name of the property from which to retrieve the success attribute used by forms.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "linkcls",
+ "name" : "totalProperty",
"type" : "String",
- "desc" : "Link Class",
+ "desc" : "Name of the property from which to retrieve the total number of records\nin the dataset. This is only needed if the whole dataset is not passed in one go, but is being\npaged from the remote server.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "newRow",
+ "type" : "function",
+ "desc" : "Create an empty record",
+ "sig" : "(data)",
+ "static" : false,
+ "memberOf" : "Roo.data.DataReader",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "(optional) - overlay some values",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.data.Record",
+ "desc" : "record created."
+ }
+ ]
},
{
- "name" : "listeners",
+ "name" : "read",
+ "type" : "function",
+ "desc" : "This method is only used by a DataProxy which has retrieved data from a remote server.",
+ "sig" : "(response)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "response",
+ "type" : "Object",
+ "desc" : "The XHR object which contains the JSON data in its responseText.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "data A data block which is used by an Roo.data.Store object as\na cache of Roo.data.Records."
+ }
+ ]
+ },
+ {
+ "name" : "readRecords",
+ "type" : "function",
+ "desc" : "Create a data block containing Roo.data.Records from an XML document.",
+ "sig" : "(o)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "An object which contains an Array of row objects in the property specified\nin the config as 'root, and optionally a property, specified in the config as 'totalProperty'\nwhich contains the total size of the dataset.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "data A data block which is used by an Roo.data.Store object as\na cache of Roo.data.Records."
+ }
+ ]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.JsonStore" : {
+ "props" : [
+ {
+ "name" : "baseParams",
"type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
+ "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request",
+ "memberOf" : "Roo.data.Store",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "menu",
- "type" : "Roo.bootstrap.menu.Menu",
- "desc" : "a Menu",
+ "name" : "data",
+ "type" : "Array",
+ "desc" : "Inline data to be loaded when the store is initialized.",
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fields",
+ "type" : "Array",
+ "desc" : "An array of field definition objects, or field name strings.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "isLocal",
+ "type" : "boolean",
+ "desc" : "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
+ "memberOf" : "Roo.data.Store",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "e) default fal",
- "memberOf" : "",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
+ "optvals" : []
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "multiSort",
+ "type" : "Boolean",
+ "desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)",
+ "memberOf" : "Roo.data.Store",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tabId",
- "type" : "String",
- "desc" : "the tab that this item activates.",
- "memberOf" : "",
+ "name" : "proxy",
+ "type" : "Roo.data.DataProxy",
+ "desc" : "The Proxy object which provides access to a data object.",
+ "memberOf" : "Roo.data.Store",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tagtype",
- "type" : "String",
- "desc" : "n) render as a href or spa",
- "memberOf" : "",
+ "name" : "pruneModifiedRecords",
+ "type" : "boolean",
+ "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
+ "memberOf" : "Roo.data.Store",
"isOptional" : false,
- "optvals" : [
- "a",
- "span"
- ]
+ "optvals" : []
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "reader",
+ "type" : "Roo.data.DataReader",
+ "desc" : "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.",
+ "memberOf" : "Roo.data.Store",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "remoteSort",
+ "type" : "boolean",
+ "desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
+ "memberOf" : "Roo.data.Store",
"isOptional" : false,
- "optvals" : [
- "el",
- "parent"
- ]
+ "optvals" : []
},
{
- "name" : "xattr",
+ "name" : "sortInfo",
"type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
+ "memberOf" : "Roo.data.Store",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
{
- "name" : "beforedestroy",
+ "name" : "add",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when Records have been added to the Store",
+ "sig" : "function (_self, records, index)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Store",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "The array of Records added",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index at which the record(s) were added",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "beforeload",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.",
+ "sig" : "function (_self, options)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Store",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "changed",
+ "name" : "beforeloadadd",
"type" : "function",
- "desc" : "Fires when the active item active state changes",
- "sig" : "function (_self, state)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after a new set of Records has been loaded.",
+ "sig" : "function (_self, records, options)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.nav.Item",
+ "type" : "Store",
"desc" : "",
"isOptional" : false
},
{
- "name" : "state",
- "type" : "boolean",
- "desc" : "the new state",
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "The Records that were loaded",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
- "desc" : "",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "click",
+ "name" : "clear",
"type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when the data cache has been cleared.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Store",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "datachanged",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
+ "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Store",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "disable",
+ "name" : "load",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires after a new set of Records has been loaded, before they are added to the store.",
+ "sig" : "function (_self, records, options)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Store",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "The Records that were loaded",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enable",
+ "name" : "loadexception",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args",
+ "sig" : "function (, ret, opts, jsonData)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "",
+ "type" : "Proxy",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "ret",
+ "type" : "Object",
+ "desc" : "return data from JsonData.reader() - success, totalRecords, records",
+ "isOptional" : false
+ },
+ {
+ "name" : "opts",
+ "type" : "Object",
+ "desc" : "- load Options",
+ "isOptional" : false
+ },
+ {
+ "name" : "jsonData",
+ "type" : "Object",
+ "desc" : "from your request (normally this contains the Exception)",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "hide",
+ "name" : "metachange",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.",
+ "sig" : "function (_self, meta)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Store",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "meta",
+ "type" : "Object",
+ "desc" : "The JSON metadata",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "remove",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a Record has been removed from the Store",
+ "sig" : "function (_self, record, index)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Store",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The Record that was removed",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index at which the record was removed",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "scrollto",
+ "name" : "update",
"type" : "function",
- "desc" : "Fires when scroll to element",
- "sig" : "function (_self, options, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when a Record has been updated",
+ "sig" : "function (_self, record, operation)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.nav.Item",
+ "type" : "Store",
"desc" : "",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "",
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The Record that was updated",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "operation",
+ "type" : "String",
+ "desc" : "The update operation being performed. Value may be one of:\n<pre><code>\n Roo.data.Record.EDIT\n Roo.data.Record.REJECT\n Roo.data.Record.COMMIT\n</code></pre>",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "show",
+ "name" : "add",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Add Records to the Store and fires the add event.",
+ "sig" : "(records)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "An Array of Roo.data.Record objects to add to the cache.",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "clearFilter",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Revert to a view of the Record cache with no filtering applied.",
+ "sig" : "(suppressEvent)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "suppressEvent",
+ "type" : "Boolean",
+ "desc" : "If true the filter is cleared silently without notifying listeners",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "collect",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Collects unique values for a particular dataIndex from this store.",
+ "sig" : "(dataIndex, allowNull, bypassFilter)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "dataIndex",
+ "type" : "String",
+ "desc" : "The property to collect",
+ "isOptional" : false
+ },
+ {
+ "name" : "allowNull",
+ "type" : "Boolean",
+ "desc" : "(optional) Pass true to allow null, undefined or empty string values",
+ "isOptional" : false
+ },
+ {
+ "name" : "bypassFilter",
+ "type" : "Boolean",
+ "desc" : "(optional) Pass true to collect from all records, even ones which are filtered",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Array",
+ "desc" : "An array of the unique values"
}
]
},
{
- "name" : "enable",
+ "name" : "commitChanges",
"type" : "function",
- "desc" : "Enable this component.",
+ "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "each",
+ "type" : "function",
+ "desc" : "Calls the specified function for each of the Records in the cache.",
+ "sig" : "(fn, scope)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call. The Record is passed as the first parameter.\nReturning <em>false</em> aborts and exits the iteration.",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to call the function (defaults to the Record).",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "filter",
+ "type" : "function",
+ "desc" : "Filter the records by a specified property.",
+ "sig" : "(field, value, anyMatch)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "field",
+ "type" : "String",
+ "desc" : "A field on your records",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "String/RegExp",
+ "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
+ "isOptional" : false
+ },
+ {
+ "name" : "anyMatch",
+ "type" : "Boolean",
+ "desc" : "True to match any part not just the beginning",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "filterBy",
+ "type" : "function",
+ "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.",
+ "sig" : "(fn, scope)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to be called, it will receive 2 args (record, id)",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the function (defaults to this)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
"name" : "fireEvent",
]
},
{
- "name" : "focus",
+ "name" : "getAt",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Get the Record at the specified index.",
+ "sig" : "(index)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the Record to find.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.data.Record",
+ "desc" : "The Record at the passed index. Returns undefined if not found."
}
]
},
{
- "name" : "getChildContainer",
+ "name" : "getById",
"type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
+ "desc" : "Get the Record with the specified id.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the Record to find.",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Roo.data.Record",
+ "desc" : "The Record with the passed id. Returns undefined if not found."
}
]
},
{
- "name" : "getEl",
+ "name" : "getCount",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Gets the number of cached records.\n<p>\n<em>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size</em>",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "getModifiedRecords",
+ "type" : "function",
+ "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "Roo.data.Record[]",
+ "desc" : "An array of Records containing outstanding modifications."
}
]
},
{
- "name" : "getId",
+ "name" : "getRange",
"type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns a range of Records between specified indices.",
+ "sig" : "(startIndex, endIndex)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "startIndex",
+ "type" : "Number",
+ "desc" : "(optional) The starting index (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "endIndex",
+ "type" : "Number",
+ "desc" : "(optional) The ending index (defaults to the last Record in the Store)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Roo.data.Record[]",
+ "desc" : "An array of Records"
}
]
},
{
- "name" : "getVisibilityEl",
+ "name" : "getSortState",
"type" : "function",
- "desc" : "Get the element that will be used to show or hide",
+ "desc" : "Returns the sort state of the Store as an object with two properties:\n<pre><code>\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n</code></pre>",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "getTotalCount",
+ "type" : "function",
+ "desc" : "Gets the total number of records in the dataset as returned by the server.\n<p>\n<em>If using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size</em>",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
]
},
{
- "name" : "hide",
+ "name" : "indexOf",
"type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
+ "desc" : "Get the index within the cache of the passed Record.",
+ "sig" : "(record)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The Roo.data.Record object to to find.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The index of the passed Record. Returns -1 if not found."
+ }
+ ]
+ },
+ {
+ "name" : "indexOfId",
+ "type" : "function",
+ "desc" : "Get the index within the cache of the Record with the passed id.",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the Record to find.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The index of the Record. Returns -1 if not found."
+ }
+ ]
+ },
+ {
+ "name" : "insert",
+ "type" : "function",
+ "desc" : "Inserts Records to the Store at the given index and fires the add event.",
+ "sig" : "(index, records)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The start index at which to insert the passed Records.",
+ "isOptional" : false
+ },
+ {
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "An Array of Roo.data.Record objects to add to the cache.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "initEvents",
+ "name" : "load",
"type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
+ "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n<p>\nIf using remote paging, then the first load call must specify the <em>start</em>\nand <em>limit</em> properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n<p>\n<strong>It is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.</strong>\n<p>",
+ "sig" : "(options)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "An object containing properties which control loading options:<ul>\n<li>params {Object} An object containing properties to pass as HTTP parameters to a remote data source.</li>\n<li>params.data {Object} if you are using a MemoryProxy / JsonReader, use this as the data to load stuff..\n<pre>\n {\n data : data, // array of key=>value data like JsonReader\n total : data.length,\n success : true\n \n }\n </pre>\n }.</li>\n<li>callback {Function} A function to be called after the Records have been loaded. The callback is\npassed the following arguments:<ul>\n<li>r : Roo.data.Record[]</li>\n<li>options: Options object from the load call</li>\n<li>success: Boolean success indicator</li></ul></li>\n<li>scope {Object} Scope with which to call the callback (defaults to the Store object)</li>\n<li>add {Boolean} indicator to append loaded records rather than replace the current cache.</li>\n</ul>",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "isVisible",
+ "name" : "loadData",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
+ "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.",
+ "sig" : "(data, append)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "The data block from which to read the Records. The format of the data expected\nis dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.",
+ "isOptional" : false
+ },
+ {
+ "name" : "append",
+ "type" : "Boolean",
+ "desc" : "True to append the new Records rather than replace the existing cache.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "loadDataFromChildren",
+ "type" : "function",
+ "desc" : "using 'cn' the nested child reader read the child array into it's child stores.",
+ "sig" : "(rec)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "rec",
+ "type" : "Object",
+ "desc" : "The record with a 'children array",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "on",
+ "type" : "function",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "on",
+ "name" : "query",
+ "type" : "function",
+ "desc" : "Query the records by a specified property.",
+ "sig" : "(field, value, anyMatch)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "field",
+ "type" : "String",
+ "desc" : "A field on your records",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "String/RegExp",
+ "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
+ "isOptional" : false
+ },
+ {
+ "name" : "anyMatch",
+ "type" : "Boolean",
+ "desc" : "True to match any part not just the beginning",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "MixedCollection",
+ "desc" : "Returns an Roo.util.MixedCollection of the matched records"
+ }
+ ]
+ },
+ {
+ "name" : "queryBy",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.",
+ "sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
+ "name" : "fn",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The function to be called, it will receive 2 args (record, id)",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "desc" : "(optional) The scope of the function (defaults to this)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "MixedCollection",
+ "desc" : "Returns an Roo.util.MixedCollection of the matched records"
+ }
+ ]
},
{
- "name" : "purgeListeners",
+ "name" : "rejectChanges",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Cancel outstanding changes on all changed records.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "reload",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.",
+ "sig" : "(options)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
+ "name" : "options",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "(optional) An object containing properties which may override the options\nused in the last load operation. See {@link #load} for details (defaults to null, in which case\nthe most recently used options are reused).",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "remove",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Remove a Record from the Store and fires the remove event.",
+ "sig" : "(record)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "record",
+ "type" : "Ext.data.Record",
+ "desc" : "The Roo.data.Record object to remove from the cache.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "removeAll",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Remove all Records from the Store and fires the clear event.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setHtml",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Set the HTML (text content) of the item",
- "sig" : "(html)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "html",
- "type" : "string",
- "desc" : "content for the nav item",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setVisibilityEl",
+ "name" : "setDefaultSort",
"type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the default sort column and order to be used by the next load operation.",
+ "sig" : "(fieldName, dir)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "fieldName",
+ "type" : "String",
+ "desc" : "The name of the field to sort by.",
+ "isOptional" : false
+ },
+ {
+ "name" : "dir",
+ "type" : "String",
+ "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "sort",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.",
+ "sig" : "(fieldName, dir)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "fieldName",
+ "type" : "String",
+ "desc" : "The name of the field to sort by.",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "dir",
+ "type" : "String",
+ "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ ],
"returns" : []
},
{
- "name" : "tooltipEl",
+ "name" : "sum",
"type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sums the value of <i>property</i> for each record between start and end and returns the result.",
+ "sig" : "(property, start, end)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "property",
+ "type" : "String",
+ "desc" : "A field on your records",
+ "isOptional" : false
+ },
+ {
+ "name" : "start",
+ "type" : "Number",
+ "desc" : "The record index to start at (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "end",
+ "type" : "Number",
+ "desc" : "The last record index to include (defaults to length - 1)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Number",
+ "desc" : "The sum"
}
]
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.bootstrap.nav.SidebarItem"
- ],
- "tree_children" : [
- "Roo.bootstrap.Button",
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.form.CardUploader"
- ],
- "tree_parent" : [
- "Roo.bootstrap.nav.Group"
- ]
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.nav.ProgressBar" : {
+ "Roo.data.MemoryProxy" : {
"props" : [
{
- "name" : "NavProgressBar:bullets[]",
- "type" : "Roo.bootstrap.nav.ProgressItem",
- "desc" : "Bullets for the Nav Progress bar for the toolbar",
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "The data object which the Reader uses to construct a block of Roo.data.Records.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
- },
{
"name" : "listeners",
"type" : "Object",
"memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
- },
- {
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : [
- "el",
- "parent"
- ]
- },
- {
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
}
],
"events" : [
{
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerender",
+ "name" : "beforeload",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires before a network request is made to retrieve a data object.",
+ "sig" : "function (This, params)\n{\n\n}",
+ "memberOf" : "Roo.data.DataProxy",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "DataProxy object.",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "params",
+ "type" : "Object",
+ "desc" : "The params parameter to the load function.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "changed",
+ "name" : "load",
"type" : "function",
- "desc" : "Fires when the active item changes",
- "sig" : "function (_self, selected, prev)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires before the load method's callback is called.",
+ "sig" : "function (This, o, arg)\n{\n\n}",
+ "memberOf" : "Roo.data.DataProxy",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.nav.ProgressBar",
- "desc" : "",
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "DataProxy object.",
"isOptional" : false
},
{
- "name" : "selected",
- "type" : "Roo.bootstrap.nav.ProgressItem",
- "desc" : "The item selected",
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The data object.",
"isOptional" : false
},
{
- "name" : "prev",
- "type" : "Roo.bootstrap.nav.ProgressItem",
- "desc" : "The previously selected item",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "arg",
+ "type" : "Object",
+ "desc" : "The callback argument object passed to the load function.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enable",
+ "name" : "loadexception",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires if an Exception occurs during data retrieval.",
+ "sig" : "function (This, o, arg, e)\n{\n\n}",
+ "memberOf" : "Roo.data.DataProxy",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "DataProxy object.",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The data object.",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "arg",
+ "type" : "Object",
+ "desc" : "The callback argument object passed to the load function.",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "The Exception.",
"isOptional" : false
}
],
],
"returns" : []
},
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
{
"name" : "fireEvent",
"type" : "function",
}
]
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "getChildContainer",
- "type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
- },
- {
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
- }
- ]
- },
- {
- "name" : "getId",
- "type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getVisibilityEl",
- "type" : "function",
- "desc" : "Get the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "hasListener",
"type" : "function",
]
},
{
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "initEvents",
- "type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isVisible",
+ "name" : "load",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Load data from the requested source (in this case an in-memory\ndata object passed to the constructor), read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback.",
+ "sig" : "(params, reader, callback, scope, arg)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "params",
+ "type" : "Object",
+ "desc" : "This parameter is not used by the MemoryProxy class.",
+ "isOptional" : false
+ },
+ {
+ "name" : "reader",
+ "type" : "Roo.data.DataReader",
+ "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "The function into which to pass the block of Roo.data.records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "The scope in which to call the callback",
+ "isOptional" : false
+ },
+ {
+ "name" : "arg",
+ "type" : "Object",
+ "desc" : "An optional argument which is passed to the callback as its second parameter.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
"type" : "Function",
"desc" : "The handler to remove",
"isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setDisabled",
- "type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setVisibilityEl",
- "type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
"name" : "un",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.nav.ProgressBarItem"
- ],
+ "tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.nav.ProgressBarItem" : {
+ "Roo.data.Node" : {
"props" : [
{
- "name" : "actionMode",
+ "name" : "id",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "active",
- "type" : "Boolean",
- "desc" : "e) Is item active default fal",
+ "desc" : "The id for this node. If one is not specified, one is generated.",
"memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
"optvals" : []
},
{
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabled",
+ "name" : "leaf",
"type" : "Boolean",
- "desc" : "e) Is item active default fal",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
- },
- {
- "name" : "html",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "icon",
- "type" : "String",
- "desc" : "show icon instead of number",
+ "desc" : "true if this node is a leaf and does not have children",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
- },
- {
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "position",
- "type" : "String",
- "desc" : "m) text position default bott",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "top",
- "bottom"
- ]
- },
- {
- "name" : "rid",
- "type" : "String",
- "desc" : "the reference id",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : [
- "el",
- "parent"
- ]
- },
- {
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
}
],
"events" : [
{
- "name" : "beforedestroy",
+ "name" : "append",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a new child node is appended",
+ "sig" : "function (tree, _self, node, index)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
"name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The newly appended node",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the newly appended node",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "beforeappend",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "Fires before a new child is appended, return false to cancel the append.",
+ "sig" : "function (tree, _self, node)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
{
"name" : "this",
- "type" : "Roo.bootstrap.Component",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node to be appended",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "click",
+ "name" : "beforeinsert",
"type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (_self, e)\n{\n\n}",
+ "desc" : "Fires before a new child is inserted, return false to cancel the insert.",
+ "sig" : "function (tree, _self, node, refNode)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
{
"name" : "this",
- "type" : "Roo.bootstrap.nav.ProgressBarItem",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node to be inserted",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "refNode",
+ "type" : "Node",
+ "desc" : "The child node the node is being inserted before",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "beforemove",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires before this node is moved to a new location in the tree. Return false to cancel the move.",
+ "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
{
"name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldParent",
+ "type" : "Node",
+ "desc" : "The parent of this node",
+ "isOptional" : false
+ },
+ {
+ "name" : "newParent",
+ "type" : "Node",
+ "desc" : "The new parent this node is moving to",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index it is being moved to",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enable",
+ "name" : "beforeremove",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires before a child is removed, return false to cancel the remove.",
+ "sig" : "function (tree, _self, node)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
{
"name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node to be removed",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "hide",
+ "name" : "insert",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a new child node is inserted.",
+ "sig" : "function (tree, _self, node, refNode)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
{
"name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node inserted",
+ "isOptional" : false
+ },
+ {
+ "name" : "refNode",
+ "type" : "Node",
+ "desc" : "The child node the node was inserted before",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "move",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when this node is moved to a new location in the tree",
+ "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
{
"name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldParent",
+ "type" : "Node",
+ "desc" : "The old parent of this node",
+ "isOptional" : false
+ },
+ {
+ "name" : "newParent",
+ "type" : "Node",
+ "desc" : "The new parent of this node",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index it was moved to",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "remove",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a child node is removed",
+ "sig" : "function (tree, _self, node)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
{
"name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The removed node",
"isOptional" : false
}
],
],
"returns" : []
},
+ {
+ "name" : "appendChild",
+ "type" : "function",
+ "desc" : "Insert node(s) as the last child node of this node.",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "node",
+ "type" : "Node/Array",
+ "desc" : "The node or Array of nodes to append",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Node",
+ "desc" : "The appended node if single append, or null if an array was passed"
+ }
+ ]
+ },
+ {
+ "name" : "bubble",
+ "type" : "function",
+ "desc" : "Bubbles up the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe bubble is stopped.",
+ "sig" : "(fn, scope, args)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the function (defaults to current node)",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Array",
+ "desc" : "(optional) The args to call the function with (default to passing the current node)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "cascade",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Cascades down the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe cascade is stopped on that branch.",
+ "sig" : "(fn, scope, args)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the function (defaults to current node)",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Array",
+ "desc" : "(optional) The args to call the function with (default to passing the current node)",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "contains",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns true if this node is an ancestor (at any point) of the passed node.",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : ""
}
]
},
{
- "name" : "enable",
+ "name" : "eachChild",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Interates the child nodes of this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe iteration stops.",
+ "sig" : "(fn, scope, args)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the function (defaults to current node)",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Array",
+ "desc" : "(optional) The args to call the function with (default to passing the current node)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "findChild",
+ "type" : "function",
+ "desc" : "Finds the first child that has the attribute with the specified value.",
+ "sig" : "(attribute, value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "attribute",
+ "type" : "String",
+ "desc" : "The attribute name",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to search for",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Node",
+ "desc" : "The found child or null if none was found"
+ }
+ ]
+ },
+ {
+ "name" : "findChildBy",
+ "type" : "function",
+ "desc" : "Finds the first child by a custom function. The child matches if the function passed\nreturns true.",
+ "sig" : "(fn, scope)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Node",
+ "desc" : "The found child or null if none was found"
}
]
},
]
},
{
- "name" : "focus",
+ "name" : "getDepth",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Returns depth of this node (the root node has a depth of 0)",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getOwnerTree",
+ "type" : "function",
+ "desc" : "Returns the tree this node is in.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Tree",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getPath",
+ "type" : "function",
+ "desc" : "Returns the path for this node. The path can be used to expand or select this node programmatically.",
+ "sig" : "(attr)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "selectText",
+ "name" : "attr",
+ "type" : "String",
+ "desc" : "(optional) The attr to use for the path (defaults to the node's id)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "The path"
+ }
+ ]
+ },
+ {
+ "name" : "hasListener",
+ "type" : "function",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
"type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
+ },
+ {
+ "name" : "indexOf",
+ "type" : "function",
+ "desc" : "Returns the index of a child node",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Number",
+ "desc" : "The index of the node or -1 if it was not found"
}
]
},
{
- "name" : "getChildContainer",
+ "name" : "insertBefore",
"type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
+ "desc" : "Inserts the first node before the second node in this nodes childNodes collection.",
+ "sig" : "(node, refNode)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The node to insert",
+ "isOptional" : false
+ },
+ {
+ "name" : "refNode",
+ "type" : "Node",
+ "desc" : "The node to insert before (if null the node is appended)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Node",
+ "desc" : "The inserted node"
}
]
},
{
- "name" : "getEl",
+ "name" : "isAncestor",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Returns true if the passed node is an ancestor (at any point) of this node.",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "isFirst",
+ "type" : "function",
+ "desc" : "Returns true if this node is the first child of its parent",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "Boolean",
+ "desc" : ""
}
]
},
{
- "name" : "getId",
+ "name" : "isLast",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Returns true if this node is the last child of its parent",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
+ "type" : "Boolean",
"desc" : ""
}
]
},
{
- "name" : "getVisibilityEl",
+ "name" : "isLeaf",
"type" : "function",
- "desc" : "Get the element that will be used to show or hide",
+ "desc" : "Returns true if this node is a leaf",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "hasListener",
+ "name" : "item",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Returns the child node at the specified index.",
+ "sig" : "(index)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "Node",
+ "desc" : ""
}
]
},
{
- "name" : "hide",
+ "name" : "on",
"type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "initEvents",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Initialize Events for the element",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "isVisible",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeChild",
+ "type" : "function",
+ "desc" : "Removes a child node from this node.",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The node to remove",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Node",
+ "desc" : "The removed node"
+ }
+ ]
},
{
- "name" : "on",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "replaceChild",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Replaces one child node in this node with another.",
+ "sig" : "(newChild, oldChild)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "newChild",
+ "type" : "Node",
+ "desc" : "The replacement node",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldChild",
+ "type" : "Node",
+ "desc" : "The node to replace",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Node",
+ "desc" : "The replaced node"
+ }
+ ]
},
{
- "name" : "releaseCapture",
+ "name" : "sort",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Sorts this nodes children using the supplied sort function",
+ "sig" : "(fn, scope)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "un",
"type" : "function",
- "desc" : "Removes a listener",
+ "desc" : "Removes a listener (shorthand for removeListener)",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
}
],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.tree.AsyncTreeNode",
+ "Roo.tree.TreeNode"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.Record" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "render",
+ "name" : "commit",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Usually called by the {@link Roo.data.Store} which owns the Record.\nCommits all changes made to the Record since either creation, or the last commit operation.\n<p>\nDevelopers should subscribe to the {@link Roo.data.Store#update} event to have their code notified\nof commit operations.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "copy",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Creates a copy of this record.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "(optional) A new record id if you don't want to use this record's id",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Record",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "setVisibilityEl",
+ "name" : "create",
"type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
+ "desc" : "Generate a constructor for a specific record layout.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Array",
+ "desc" : "An Array of field definition objects which specify field names, and optionally,\ndata types, and a mapping for an {@link Roo.data.Reader} to extract the field's value from a data object.\nEach field definition object may contain the following properties: <ul>\n<li><b>name</b> : String<p style=\"margin-left:1em\">The name by which the field is referenced within the Record. This is referenced by,\nfor example the <em>dataIndex</em> property in column definition objects passed to {@link Roo.grid.ColumnModel}</p></li>\n<li><b>mapping</b> : String<p style=\"margin-left:1em\"> A path specification for use by the {@link Roo.data.Reader} implementation\nthat is creating the Record to access the data value from the data object. If an {@link Roo.data.JsonReader}\nis being used, then this is a string containing the javascript expression to reference the data relative to \nthe record item's root. If an {@link Roo.data.XmlReader} is being used, this is an {@link Roo.DomQuery} path\nto the data item relative to the record element. If the mapping expression is the same as the field name,\nthis may be omitted.</p></li>\n<li><b>type</b> : String<p style=\"margin-left:1em\"> The data type for conversion to displayable value. Possible values are\n<ul><li>auto (Default, implies no conversion)</li>\n<li>string</li>\n<li>int</li>\n<li>float</li>\n<li>boolean</li>\n<li>date</li></ul></p></li>\n<li><b>sortType</b> : Mixed<p style=\"margin-left:1em\"> A member of {@link Roo.data.SortTypes}.</p></li>\n<li><b>sortDir</b> : String<p style=\"margin-left:1em\"> Initial direction to sort. \"ASC\" or \"DESC\"</p></li>\n<li><b>convert</b> : Function<p style=\"margin-left:1em\"> A function which converts the value provided\nby the Reader into an object that will be stored in the Record. It is passed the\nfollowing parameters:<ul>\n<li><b>v</b> : Mixed<p style=\"margin-left:1em\">The data value as read by the Reader.</p></li>\n</ul></p></li>\n<li><b>dateFormat</b> : String<p style=\"margin-left:1em\"> A format String for the Date.parseDate function.</p></li>\n</ul>\n<br>usage:<br><pre><code>\nvar TopicRecord = Roo.data.Record.create(\n {name: 'title', mapping: 'topic_title'},\n {name: 'author', mapping: 'username'},\n {name: 'totalPosts', mapping: 'topic_replies', type: 'int'},\n {name: 'lastPost', mapping: 'post_time', type: 'date'},\n {name: 'lastPoster', mapping: 'user2'},\n {name: 'excerpt', mapping: 'post_text'}\n);\n\nvar myNewRecord = new TopicRecord({\n title: 'Do my job please',\n author: 'noobie',\n totalPosts: 1,\n lastPost: new Date(),\n lastPoster: 'Animal',\n excerpt: 'No way dude!'\n});\nmyStore.add(myNewRecord);\n</code></pre>",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "get",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Get the value of the named field.",
+ "sig" : "(name)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The name of the field to get the value of.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Object",
+ "desc" : "The value of the field."
}
]
},
{
- "name" : "show",
+ "name" : "reject",
"type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
+ "desc" : "Usually called by the {@link Roo.data.Store} which owns the Record.\nRejects all changes made to the Record since either creation, or the last commit operation.\nModified fields are reverted to their original values.\n<p>\nDevelopers should subscribe to the {@link Roo.data.Store#update} event to have their code notified\nof reject operations.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "tooltipEl",
+ "name" : "set",
"type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Set the named field to the specified value.",
+ "sig" : "(name, value)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The name of the field to set.",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "Object",
+ "desc" : "The value to set the field to.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.ScriptTagProxy" : {
+ "props" : [
+ {
+ "name" : "callbackParam",
+ "type" : "String",
+ "desc" : "The name of the parameter to pass to the server which tells\nthe server the name of the callback function set up by the load call to process the returned data object.\nDefaults to \"callback\".<p>The server-side processing must read this parameter value, and generate\njavascript output which calls this named function passing the data object as its only parameter.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "un",
+ "name" : "nocache",
+ "type" : "Boolean",
+ "desc" : "Defaults to true. Disable cacheing by adding a unique parameter\nname to the request.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "timeout",
+ "type" : "Number",
+ "desc" : "The number of milliseconds to wait for a response. Defaults to 30 seconds.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "url",
+ "type" : "String",
+ "desc" : "The URL from which to request the data object.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "abort",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Abort the current server request.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "load",
+ "type" : "function",
+ "desc" : "Load data from the configured URL, read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback.",
+ "sig" : "(params, reader, callback, scope, arg)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "params",
+ "type" : "Object",
+ "desc" : "An object containing properties which are to be used as HTTP parameters\nfor the request to the remote server.",
"isOptional" : false
},
{
- "name" : "handler",
+ "name" : "reader",
+ "type" : "Roo.data.DataReader",
+ "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
"type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "The function into which to pass the block of Roo.data.Records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "The scope in which to call the callback",
+ "isOptional" : false
+ },
+ {
+ "name" : "arg",
+ "type" : "Object",
+ "desc" : "An optional argument which is passed to the callback as its second parameter.",
"isOptional" : false
}
],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.nav.Sidebar" : {
+ "Roo.data.SimpleStore" : {
"props" : [
{
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
+ "name" : "an",
+ "type" : "Object",
+ "desc" : "existing reader (eg. copied from another store)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "baseParams",
+ "type" : "Object",
+ "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request",
+ "memberOf" : "Roo.data.Store",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "data",
+ "type" : "Array",
+ "desc" : "The multi-dimensional array of data",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "fields",
+ "type" : "Array",
+ "desc" : "An array of field definition objects, or field name strings.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "id",
+ "type" : "Number",
+ "desc" : "The array index of the record id. Leave blank to auto generate ids.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
+ "name" : "isLocal",
+ "type" : "boolean",
+ "desc" : "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
+ "memberOf" : "Roo.data.Store",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
- },
{
"name" : "listeners",
"type" : "Object",
"optvals" : []
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "multiSort",
+ "type" : "Boolean",
+ "desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)",
+ "memberOf" : "Roo.data.Store",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "proxy",
+ "type" : "Roo.data.DataProxy",
+ "desc" : "[not-required]",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "pruneModifiedRecords",
+ "type" : "boolean",
+ "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
+ "memberOf" : "Roo.data.Store",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "reader",
+ "type" : "Roo.data.Reader",
+ "desc" : "[not-required]",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "el",
- "parent"
- ]
+ "optvals" : []
},
{
- "name" : "xattr",
+ "name" : "remoteSort",
+ "type" : "boolean",
+ "desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sortInfo",
"type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
+ "memberOf" : "Roo.data.Store",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
{
- "name" : "beforedestroy",
+ "name" : "add",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when Records have been added to the Store",
+ "sig" : "function (_self, records, index)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Store",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "The array of Records added",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index at which the record(s) were added",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "beforeload",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.",
+ "sig" : "function (_self, options)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Store",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "beforeloadadd",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires after a new set of Records has been loaded.",
+ "sig" : "function (_self, records, options)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Store",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "The Records that were loaded",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforetoggle",
+ "name" : "clear",
"type" : "function",
- "desc" : "Fire before toggle the menu",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.nav.Bar",
+ "desc" : "Fires when the data cache has been cleared.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Store",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "datachanged",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
+ "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "type" : "Store",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "load",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires after a new set of Records has been loaded, before they are added to the store.",
+ "sig" : "function (_self, records, options)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Store",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "The Records that were loaded",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "loadexception",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args",
+ "sig" : "function (, ret, opts, jsonData)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "",
+ "type" : "Proxy",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "ret",
+ "type" : "Object",
+ "desc" : "return data from JsonData.reader() - success, totalRecords, records",
+ "isOptional" : false
+ },
+ {
+ "name" : "opts",
+ "type" : "Object",
+ "desc" : "- load Options",
+ "isOptional" : false
+ },
+ {
+ "name" : "jsonData",
+ "type" : "Object",
+ "desc" : "from your request (normally this contains the Exception)",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enable",
+ "name" : "metachange",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.",
+ "sig" : "function (_self, meta)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Store",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "meta",
+ "type" : "Object",
+ "desc" : "The JSON metadata",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "hide",
+ "name" : "remove",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a Record has been removed from the Store",
+ "sig" : "function (_self, record, index)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Store",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The Record that was removed",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index at which the record was removed",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "update",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a Record has been updated",
+ "sig" : "function (_self, record, operation)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Store",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The Record that was updated",
+ "isOptional" : false
+ },
+ {
+ "name" : "operation",
+ "type" : "String",
+ "desc" : "The update operation being performed. Value may be one of:\n<pre><code>\n Roo.data.Record.EDIT\n Roo.data.Record.REJECT\n Roo.data.Record.COMMIT\n</code></pre>",
+ "isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "show",
+ "name" : "add",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Add Records to the Store and fires the add event.",
+ "sig" : "(records)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "An Array of Roo.data.Record objects to add to the cache.",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
"name" : "addEvents",
"type" : "function",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : []
+ },
+ {
+ "name" : "clearFilter",
+ "type" : "function",
+ "desc" : "Revert to a view of the Record cache with no filtering applied.",
+ "sig" : "(suppressEvent)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "suppressEvent",
+ "type" : "Boolean",
+ "desc" : "If true the filter is cleared silently without notifying listeners",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "collect",
+ "type" : "function",
+ "desc" : "Collects unique values for a particular dataIndex from this store.",
+ "sig" : "(dataIndex, allowNull, bypassFilter)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "dataIndex",
+ "type" : "String",
+ "desc" : "The property to collect",
+ "isOptional" : false
+ },
+ {
+ "name" : "allowNull",
+ "type" : "Boolean",
+ "desc" : "(optional) Pass true to allow null, undefined or empty string values",
+ "isOptional" : false
+ },
+ {
+ "name" : "bypassFilter",
+ "type" : "Boolean",
+ "desc" : "(optional) Pass true to collect from all records, even ones which are filtered",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "An array of the unique values"
+ }
+ ]
+ },
+ {
+ "name" : "commitChanges",
+ "type" : "function",
+ "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "each",
+ "type" : "function",
+ "desc" : "Calls the specified function for each of the Records in the cache.",
+ "sig" : "(fn, scope)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call. The Record is passed as the first parameter.\nReturning <em>false</em> aborts and exits the iteration.",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to call the function (defaults to the Record).",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "filter",
+ "type" : "function",
+ "desc" : "Filter the records by a specified property.",
+ "sig" : "(field, value, anyMatch)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "field",
+ "type" : "String",
+ "desc" : "A field on your records",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "String/RegExp",
+ "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
+ "isOptional" : false
+ },
+ {
+ "name" : "anyMatch",
+ "type" : "Boolean",
+ "desc" : "True to match any part not just the beginning",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "filterBy",
+ "type" : "function",
+ "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.",
+ "sig" : "(fn, scope)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to be called, it will receive 2 args (record, id)",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the function (defaults to this)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "fireEvent",
+ "type" : "function",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
+ },
+ {
+ "name" : "getAt",
+ "type" : "function",
+ "desc" : "Get the Record at the specified index.",
+ "sig" : "(index)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the Record to find.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.data.Record",
+ "desc" : "The Record at the passed index. Returns undefined if not found."
+ }
+ ]
+ },
+ {
+ "name" : "getById",
+ "type" : "function",
+ "desc" : "Get the Record with the specified id.",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the Record to find.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.data.Record",
+ "desc" : "The Record with the passed id. Returns undefined if not found."
+ }
+ ]
+ },
+ {
+ "name" : "getCount",
+ "type" : "function",
+ "desc" : "Gets the number of cached records.\n<p>\n<em>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size</em>",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "getModifiedRecords",
+ "type" : "function",
+ "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.data.Record[]",
+ "desc" : "An array of Records containing outstanding modifications."
+ }
+ ]
+ },
+ {
+ "name" : "getRange",
+ "type" : "function",
+ "desc" : "Returns a range of Records between specified indices.",
+ "sig" : "(startIndex, endIndex)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "startIndex",
+ "type" : "Number",
+ "desc" : "(optional) The starting index (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "endIndex",
+ "type" : "Number",
+ "desc" : "(optional) The ending index (defaults to the last Record in the Store)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.data.Record[]",
+ "desc" : "An array of Records"
+ }
+ ]
},
{
- "name" : "collapse",
+ "name" : "getSortState",
"type" : "function",
- "desc" : "Collapse the navbar pulldown",
+ "desc" : "Returns the sort state of the Store as an object with two properties:\n<pre><code>\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n</code></pre>",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.nav.Bar",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "getTotalCount",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "desc" : "Gets the total number of records in the dataset as returned by the server.\n<p>\n<em>If using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size</em>",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "disable",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "enable",
+ "name" : "indexOf",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Get the index within the cache of the passed Record.",
+ "sig" : "(record)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The Roo.data.Record object to to find.",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Number",
+ "desc" : "The index of the passed Record. Returns -1 if not found."
}
]
},
{
- "name" : "expand",
+ "name" : "indexOfId",
"type" : "function",
- "desc" : "Expand the navbar pulldown",
- "sig" : "()\n{\n\n}",
+ "desc" : "Get the index within the cache of the Record with the passed id.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.bootstrap.nav.Bar",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the Record to find.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The index of the Record. Returns -1 if not found."
+ }
+ ]
},
{
- "name" : "fireEvent",
+ "name" : "insert",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Inserts Records to the Store at the given index and fires the add event.",
+ "sig" : "(index, records)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The start index at which to insert the passed Records.",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "An Array of Roo.data.Record objects to add to the cache.",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "load",
+ "type" : "function",
+ "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n<p>\nIf using remote paging, then the first load call must specify the <em>start</em>\nand <em>limit</em> properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n<p>\n<strong>It is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.</strong>\n<p>",
+ "sig" : "(options)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "An object containing properties which control loading options:<ul>\n<li>params {Object} An object containing properties to pass as HTTP parameters to a remote data source.</li>\n<li>params.data {Object} if you are using a MemoryProxy / JsonReader, use this as the data to load stuff..\n<pre>\n {\n data : data, // array of key=>value data like JsonReader\n total : data.length,\n success : true\n \n }\n </pre>\n }.</li>\n<li>callback {Function} A function to be called after the Records have been loaded. The callback is\npassed the following arguments:<ul>\n<li>r : Roo.data.Record[]</li>\n<li>options: Options object from the load call</li>\n<li>success: Boolean success indicator</li></ul></li>\n<li>scope {Object} Scope with which to call the callback (defaults to the Store object)</li>\n<li>add {Boolean} indicator to append loaded records rather than replace the current cache.</li>\n</ul>",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "focus",
+ "name" : "loadData",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.",
+ "sig" : "(data, append)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "selectText",
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "The data block from which to read the Records. The format of the data expected\nis dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.",
+ "isOptional" : false
+ },
+ {
+ "name" : "append",
"type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "desc" : "True to append the new Records rather than replace the existing cache.",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "loadDataFromChildren",
+ "type" : "function",
+ "desc" : "using 'cn' the nested child reader read the child array into it's child stores.",
+ "sig" : "(rec)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "rec",
+ "type" : "Object",
+ "desc" : "The record with a 'children array",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getChildContainer",
+ "name" : "on",
"type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getEl",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "query",
+ "type" : "function",
+ "desc" : "Query the records by a specified property.",
+ "sig" : "(field, value, anyMatch)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "field",
+ "type" : "String",
+ "desc" : "A field on your records",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "String/RegExp",
+ "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
+ "isOptional" : false
+ },
+ {
+ "name" : "anyMatch",
+ "type" : "Boolean",
+ "desc" : "True to match any part not just the beginning",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "MixedCollection",
+ "desc" : "Returns an Roo.util.MixedCollection of the matched records"
}
]
},
{
- "name" : "getId",
+ "name" : "queryBy",
"type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.",
+ "sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to be called, it will receive 2 args (record, id)",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the function (defaults to this)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "MixedCollection",
+ "desc" : "Returns an Roo.util.MixedCollection of the matched records"
}
]
},
{
- "name" : "getVisibilityEl",
+ "name" : "rejectChanges",
"type" : "function",
- "desc" : "Get the element that will be used to show or hide",
+ "desc" : "Cancel outstanding changes on all changed records.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "hasListener",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
"memberOf" : "Roo.util.Observable",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "hide",
+ "name" : "reload",
"type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
+ "desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.",
+ "sig" : "(options)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing properties which may override the options\nused in the last load operation. See {@link #load} for details (defaults to null, in which case\nthe most recently used options are reused).",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "initEvents",
+ "name" : "remove",
"type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
+ "desc" : "Remove a Record from the Store and fires the remove event.",
+ "sig" : "(record)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "record",
+ "type" : "Ext.data.Record",
+ "desc" : "The Roo.data.Record object to remove from the cache.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "isVisible",
+ "name" : "removeAll",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
+ "desc" : "Remove all Records from the Store and fires the clear event.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "on",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setDefaultSort",
+ "type" : "function",
+ "desc" : "Sets the default sort column and order to be used by the next load operation.",
+ "sig" : "(fieldName, dir)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "fieldName",
+ "type" : "String",
+ "desc" : "The name of the field to sort by.",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "dir",
+ "type" : "String",
+ "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "sort",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.",
+ "sig" : "(fieldName, dir)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "fieldName",
+ "type" : "String",
+ "desc" : "The name of the field to sort by.",
+ "isOptional" : false
+ },
+ {
+ "name" : "dir",
+ "type" : "String",
+ "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "sum",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Sums the value of <i>property</i> for each record between start and end and returns the result.",
+ "sig" : "(property, start, end)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "property",
+ "type" : "String",
+ "desc" : "A field on your records",
+ "isOptional" : false
+ },
+ {
+ "name" : "start",
+ "type" : "Number",
+ "desc" : "The record index to start at (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "end",
+ "type" : "Number",
+ "desc" : "The last record index to include (defaults to length - 1)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The sum"
+ }
+ ]
},
{
- "name" : "removeListener",
+ "name" : "un",
"type" : "function",
- "desc" : "Removes a listener",
+ "desc" : "Removes a listener (shorthand for removeListener)",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
}
],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.SortTypes" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "render",
+ "name" : "asDate",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
+ "desc" : "Date sorting",
+ "sig" : "(s)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "s",
+ "type" : "Mixed",
+ "desc" : "The value being converted",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The comparison value"
+ }
+ ]
},
{
- "name" : "setDisabled",
+ "name" : "asFloat",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
+ "desc" : "Float sorting",
+ "sig" : "(s)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "s",
+ "type" : "Mixed",
+ "desc" : "The value being converted",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Float",
+ "desc" : "The comparison value"
+ }
+ ]
},
{
- "name" : "setVisibilityEl",
+ "name" : "asInt",
"type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
+ "desc" : "Integer sorting",
+ "sig" : "(s)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "s",
+ "type" : "Mixed",
+ "desc" : "The value being converted",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The comparison value"
+ }
+ ]
},
{
- "name" : "setVisible",
+ "name" : "asText",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
+ "desc" : "Strips all HTML tags to sort on text only",
+ "sig" : "(s)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "s",
+ "type" : "Mixed",
+ "desc" : "The value being converted",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "String",
+ "desc" : "The comparison value"
}
]
},
{
- "name" : "show",
+ "name" : "asUCString",
"type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
+ "desc" : "Case insensitive string",
+ "sig" : "(s)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "s",
+ "type" : "Mixed",
+ "desc" : "The value being converted",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "The comparison value"
+ }
+ ]
},
{
- "name" : "tooltipEl",
+ "name" : "asUCText",
"type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
+ "desc" : "Strips all HTML tags to sort on text only - Case insensitive",
+ "sig" : "(s)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "s",
+ "type" : "Mixed",
+ "desc" : "The value being converted",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "String",
+ "desc" : "The comparison value"
}
]
},
{
- "name" : "un",
+ "name" : "none",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
+ "desc" : "Default sort that does nothing",
+ "sig" : "(s)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "s",
+ "type" : "Mixed",
+ "desc" : "The value being converted",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "The comparison value"
+ }
+ ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.nav.Group",
- "Roo.bootstrap.form.Form",
- "Roo.bootstrap.Row",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.TabGroup",
- "Roo.bootstrap.Link"
- ],
+ "tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.nav.SidebarItem" : {
+ "Roo.data.Store" : {
"props" : [
{
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "active",
- "type" : "Boolean",
- "desc" : "Is item active",
- "memberOf" : "Roo.bootstrap.nav.Item",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "animateRef",
- "type" : "Boolean",
- "desc" : "e) link to element default fal",
- "memberOf" : "Roo.bootstrap.nav.Item",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "badge",
- "type" : "String",
- "desc" : "text inside badge",
- "memberOf" : "Roo.bootstrap.nav.Item",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "badgecls",
- "type" : "String",
- "desc" : "w)the extra classes for the bad",
- "memberOf" : "Roo.bootstrap.nav.Item",
- "isOptional" : false,
- "optvals" : [
- "bg-green",
- "bg-red",
- "bg-yellow"
- ]
- },
- {
- "name" : "button_outline",
- "type" : "Boolean",
- "desc" : "show and outlined button",
- "memberOf" : "Roo.bootstrap.nav.Item",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "button_weight",
- "type" : "String",
- "desc" : "k) default no",
- "memberOf" : "Roo.bootstrap.nav.Item",
- "isOptional" : false,
- "optvals" : [
- "default",
- "primary",
- "secondary",
- "success",
- "info",
- "warning",
- "danger",
- "link",
- "light",
- "dark"
- ]
- },
- {
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "Is item disabled",
- "memberOf" : "Roo.bootstrap.nav.Item",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fa",
- "type" : "String",
- "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)",
- "memberOf" : "Roo.bootstrap.nav.Item",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "glyphicon",
- "type" : "String",
- "desc" : "DEPRICATED - use fa",
- "memberOf" : "Roo.bootstrap.nav.Item",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
- },
- {
- "name" : "href",
- "type" : "String",
- "desc" : "link to",
- "memberOf" : "Roo.bootstrap.nav.Item",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "html",
- "type" : "String",
- "desc" : "content of button",
- "memberOf" : "Roo.bootstrap.nav.Item",
+ "name" : "baseParams",
+ "type" : "Object",
+ "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "icon",
- "type" : "String",
- "desc" : "DEPRICATED - use fa",
- "memberOf" : "Roo.bootstrap.nav.Item",
+ "name" : "data",
+ "type" : "Array",
+ "desc" : "Inline data to be loaded when the store is initialized.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "linkcls",
- "type" : "String",
- "desc" : "Link Class",
- "memberOf" : "Roo.bootstrap.nav.Item",
+ "name" : "isLocal",
+ "type" : "boolean",
+ "desc" : "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "menu",
- "type" : "Roo.bootstrap.menu.Menu",
- "desc" : "a Menu",
- "memberOf" : "Roo.bootstrap.nav.Item",
+ "name" : "multiSort",
+ "type" : "Boolean",
+ "desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "proxy",
+ "type" : "Roo.data.DataProxy",
+ "desc" : "The Proxy object which provides access to a data object.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "e) default fal",
- "memberOf" : "Roo.bootstrap.nav.Item",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "pruneModifiedRecords",
+ "type" : "boolean",
+ "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tabId",
- "type" : "String",
- "desc" : "the tab that this item activates.",
- "memberOf" : "Roo.bootstrap.nav.Item",
+ "name" : "reader",
+ "type" : "Roo.data.DataReader",
+ "desc" : "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tagtype",
- "type" : "String",
- "desc" : "n) render as a href or spa",
- "memberOf" : "Roo.bootstrap.nav.Item",
- "isOptional" : false,
- "optvals" : [
- "a",
- "span"
- ]
- },
- {
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "remoteSort",
+ "type" : "boolean",
+ "desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : [
- "el",
- "parent"
- ]
- },
- {
- "name" : "xattr",
+ "name" : "sortInfo",
"type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
{
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeshow",
+ "name" : "add",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when Records have been added to the Store",
+ "sig" : "function (_self, records, index)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Store",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "The array of Records added",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index at which the record(s) were added",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "changed",
+ "name" : "beforeload",
"type" : "function",
- "desc" : "Fires when the active item active state changes",
- "sig" : "function (_self, state)\n{\n\n}",
+ "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.",
+ "sig" : "function (_self, options)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.nav.SidebarItem",
+ "type" : "Store",
"desc" : "",
"isOptional" : false
},
{
- "name" : "state",
- "type" : "boolean",
- "desc" : "the new state",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "beforeloadadd",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "Fires after a new set of Records has been loaded.",
+ "sig" : "function (_self, records, options)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "type" : "Store",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "The Records that were loaded",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "click",
+ "name" : "clear",
"type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
+ "desc" : "Fires when the data cache has been cleared.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Store",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "datachanged",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
+ "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Store",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "disable",
+ "name" : "load",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires after a new set of Records has been loaded, before they are added to the store.",
+ "sig" : "function (_self, records, options)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Store",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "The Records that were loaded",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enable",
+ "name" : "loadexception",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args",
+ "sig" : "function (, ret, opts, jsonData)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "",
+ "type" : "Proxy",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "ret",
+ "type" : "Object",
+ "desc" : "return data from JsonData.reader() - success, totalRecords, records",
+ "isOptional" : false
+ },
+ {
+ "name" : "opts",
+ "type" : "Object",
+ "desc" : "- load Options",
+ "isOptional" : false
+ },
+ {
+ "name" : "jsonData",
+ "type" : "Object",
+ "desc" : "from your request (normally this contains the Exception)",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "hide",
+ "name" : "metachange",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.",
+ "sig" : "function (_self, meta)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Store",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "meta",
+ "type" : "Object",
+ "desc" : "The JSON metadata",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "remove",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a Record has been removed from the Store",
+ "sig" : "function (_self, record, index)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Store",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The Record that was removed",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index at which the record was removed",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "scrollto",
+ "name" : "update",
"type" : "function",
- "desc" : "Fires when scroll to element",
- "sig" : "function (_self, options, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.nav.Item",
+ "desc" : "Fires when a Record has been updated",
+ "sig" : "function (_self, record, operation)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.nav.Item",
+ "type" : "Store",
"desc" : "",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "",
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The Record that was updated",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "operation",
+ "type" : "String",
+ "desc" : "The update operation being performed. Value may be one of:\n<pre><code>\n Roo.data.Record.EDIT\n Roo.data.Record.REJECT\n Roo.data.Record.COMMIT\n</code></pre>",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "show",
+ "name" : "add",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Add Records to the Store and fires the add event.",
+ "sig" : "(records)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "An Array of Roo.data.Record objects to add to the cache.",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "clearFilter",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Revert to a view of the Record cache with no filtering applied.",
+ "sig" : "(suppressEvent)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "suppressEvent",
+ "type" : "Boolean",
+ "desc" : "If true the filter is cleared silently without notifying listeners",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "collect",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Collects unique values for a particular dataIndex from this store.",
+ "sig" : "(dataIndex, allowNull, bypassFilter)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "dataIndex",
+ "type" : "String",
+ "desc" : "The property to collect",
+ "isOptional" : false
+ },
+ {
+ "name" : "allowNull",
+ "type" : "Boolean",
+ "desc" : "(optional) Pass true to allow null, undefined or empty string values",
+ "isOptional" : false
+ },
+ {
+ "name" : "bypassFilter",
+ "type" : "Boolean",
+ "desc" : "(optional) Pass true to collect from all records, even ones which are filtered",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Array",
+ "desc" : "An array of the unique values"
}
]
},
{
- "name" : "enable",
+ "name" : "commitChanges",
"type" : "function",
- "desc" : "Enable this component.",
+ "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "each",
+ "type" : "function",
+ "desc" : "Calls the specified function for each of the Records in the cache.",
+ "sig" : "(fn, scope)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call. The Record is passed as the first parameter.\nReturning <em>false</em> aborts and exits the iteration.",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to call the function (defaults to the Record).",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "filter",
+ "type" : "function",
+ "desc" : "Filter the records by a specified property.",
+ "sig" : "(field, value, anyMatch)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "field",
+ "type" : "String",
+ "desc" : "A field on your records",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "String/RegExp",
+ "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
+ "isOptional" : false
+ },
+ {
+ "name" : "anyMatch",
+ "type" : "Boolean",
+ "desc" : "True to match any part not just the beginning",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "filterBy",
+ "type" : "function",
+ "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.",
+ "sig" : "(fn, scope)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to be called, it will receive 2 args (record, id)",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the function (defaults to this)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
"name" : "fireEvent",
]
},
{
- "name" : "focus",
+ "name" : "getAt",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Get the Record at the specified index.",
+ "sig" : "(index)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the Record to find.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.data.Record",
+ "desc" : "The Record at the passed index. Returns undefined if not found."
}
]
},
{
- "name" : "getChildContainer",
+ "name" : "getById",
"type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
+ "desc" : "Get the Record with the specified id.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the Record to find.",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Roo.data.Record",
+ "desc" : "The Record with the passed id. Returns undefined if not found."
}
]
},
{
- "name" : "getEl",
+ "name" : "getCount",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Gets the number of cached records.\n<p>\n<em>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size</em>",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "getModifiedRecords",
+ "type" : "function",
+ "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "Roo.data.Record[]",
+ "desc" : "An array of Records containing outstanding modifications."
}
]
},
{
- "name" : "getId",
+ "name" : "getRange",
"type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns a range of Records between specified indices.",
+ "sig" : "(startIndex, endIndex)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "startIndex",
+ "type" : "Number",
+ "desc" : "(optional) The starting index (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "endIndex",
+ "type" : "Number",
+ "desc" : "(optional) The ending index (defaults to the last Record in the Store)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Roo.data.Record[]",
+ "desc" : "An array of Records"
}
]
},
{
- "name" : "getVisibilityEl",
+ "name" : "getSortState",
"type" : "function",
- "desc" : "Get the element that will be used to show or hide",
+ "desc" : "Returns the sort state of the Store as an object with two properties:\n<pre><code>\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n</code></pre>",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "getTotalCount",
+ "type" : "function",
+ "desc" : "Gets the total number of records in the dataset as returned by the server.\n<p>\n<em>If using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size</em>",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
]
},
{
- "name" : "hide",
+ "name" : "indexOf",
"type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
+ "desc" : "Get the index within the cache of the passed Record.",
+ "sig" : "(record)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The Roo.data.Record object to to find.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The index of the passed Record. Returns -1 if not found."
+ }
+ ]
},
{
- "name" : "initEvents",
+ "name" : "indexOfId",
"type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
+ "desc" : "Get the index within the cache of the Record with the passed id.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the Record to find.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The index of the Record. Returns -1 if not found."
+ }
+ ]
},
{
- "name" : "isVisible",
+ "name" : "insert",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Inserts Records to the Store at the given index and fires the add event.",
+ "sig" : "(index, records)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The start index at which to insert the passed Records.",
+ "isOptional" : false
+ },
+ {
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "An Array of Roo.data.Record objects to add to the cache.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "on",
+ "name" : "load",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n<p>\nIf using remote paging, then the first load call must specify the <em>start</em>\nand <em>limit</em> properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n<p>\n<strong>It is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.</strong>\n<p>",
+ "sig" : "(options)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
{
"name" : "options",
"type" : "Object",
- "desc" : "(optional)",
+ "desc" : "An object containing properties which control loading options:<ul>\n<li>params {Object} An object containing properties to pass as HTTP parameters to a remote data source.</li>\n<li>params.data {Object} if you are using a MemoryProxy / JsonReader, use this as the data to load stuff..\n<pre>\n {\n data : data, // array of key=>value data like JsonReader\n total : data.length,\n success : true\n \n }\n </pre>\n }.</li>\n<li>callback {Function} A function to be called after the Records have been loaded. The callback is\npassed the following arguments:<ul>\n<li>r : Roo.data.Record[]</li>\n<li>options: Options object from the load call</li>\n<li>success: Boolean success indicator</li></ul></li>\n<li>scope {Object} Scope with which to call the callback (defaults to the Store object)</li>\n<li>add {Boolean} indicator to append loaded records rather than replace the current cache.</li>\n</ul>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "loadData",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.",
+ "sig" : "(data, append)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "The data block from which to read the Records. The format of the data expected\nis dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.",
+ "isOptional" : false
+ },
+ {
+ "name" : "append",
+ "type" : "Boolean",
+ "desc" : "True to append the new Records rather than replace the existing cache.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "loadDataFromChildren",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "using 'cn' the nested child reader read the child array into it's child stores.",
+ "sig" : "(rec)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "rec",
+ "type" : "Object",
+ "desc" : "The record with a 'children array",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "on",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "query",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Query the records by a specified property.",
+ "sig" : "(field, value, anyMatch)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
+ "name" : "field",
+ "type" : "String",
+ "desc" : "A field on your records",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "String/RegExp",
+ "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
+ "isOptional" : false
+ },
+ {
+ "name" : "anyMatch",
"type" : "Boolean",
- "desc" : "",
+ "desc" : "True to match any part not just the beginning",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "MixedCollection",
+ "desc" : "Returns an Roo.util.MixedCollection of the matched records"
+ }
+ ]
},
{
- "name" : "setHtml",
+ "name" : "queryBy",
"type" : "function",
- "desc" : "Set the HTML (text content) of the item",
- "sig" : "(html)",
+ "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.",
+ "sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "Roo.bootstrap.nav.Item",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "html",
- "type" : "string",
- "desc" : "content for the nav item",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to be called, it will receive 2 args (record, id)",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the function (defaults to this)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "MixedCollection",
+ "desc" : "Returns an Roo.util.MixedCollection of the matched records"
+ }
+ ]
},
{
- "name" : "setVisibilityEl",
+ "name" : "rejectChanges",
"type" : "function",
- "desc" : "Set the element that will be used to show or hide",
+ "desc" : "Cancel outstanding changes on all changed records.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
"returns" : []
},
{
- "name" : "tooltipEl",
+ "name" : "reload",
"type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.",
+ "sig" : "(options)",
"static" : false,
- "memberOf" : "Roo.bootstrap.nav.Item",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing properties which may override the options\nused in the last load operation. See {@link #load} for details (defaults to null, in which case\nthe most recently used options are reused).",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "un",
+ "name" : "remove",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Remove a Record from the Store and fires the remove event.",
+ "sig" : "(record)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.bootstrap.nav.Simplebar" : {
- "props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) alignme",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "left",
- "right"
- ]
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "arrangement",
- "type" : "Boolean",
- "desc" : "stacked | justified",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
- },
- {
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "is inverted color",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "loadMask",
- "type" : "Boolean",
- "desc" : "e) loadMask on the b",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "main",
- "type" : "Boolean",
- "desc" : "e) main nav bar? default fal",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "tag",
- "type" : "String",
- "desc" : "v) default is n",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "header",
- "footer",
- "nav",
- "div"
- ]
- },
- {
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "type",
- "type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "nav",
- "pills",
- "tabs"
- ]
- },
- {
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : [
- "el",
- "parent"
- ]
+ "params" : [
+ {
+ "name" : "record",
+ "type" : "Ext.data.Record",
+ "desc" : "The Roo.data.Record object to remove from the cache.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "weight",
- "type" : "String",
- "desc" : "e) default is ligh",
+ "name" : "removeAll",
+ "type" : "function",
+ "desc" : "Remove all Records from the Store and fires the clear event.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "light",
- "primary",
- "secondary",
- "success",
- "danger",
- "warning",
- "info",
- "dark",
- "white"
- ]
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "beforedestroy",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforehide",
+ "name" : "setDefaultSort",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Sets the default sort column and order to be used by the next load operation.",
+ "sig" : "(fieldName, dir)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "fieldName",
+ "type" : "String",
+ "desc" : "The name of the field to sort by.",
+ "isOptional" : false
+ },
+ {
+ "name" : "dir",
+ "type" : "String",
+ "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "sort",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.",
+ "sig" : "(fieldName, dir)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "fieldName",
+ "type" : "String",
+ "desc" : "The name of the field to sort by.",
+ "isOptional" : false
+ },
+ {
+ "name" : "dir",
+ "type" : "String",
+ "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "sum",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Sums the value of <i>property</i> for each record between start and end and returns the result.",
+ "sig" : "(property, start, end)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "property",
+ "type" : "String",
+ "desc" : "A field on your records",
+ "isOptional" : false
+ },
+ {
+ "name" : "start",
+ "type" : "Number",
+ "desc" : "The record index to start at (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "end",
+ "type" : "Number",
+ "desc" : "The last record index to include (defaults to length - 1)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The sum"
+ }
+ ]
},
{
- "name" : "beforetoggle",
+ "name" : "un",
"type" : "function",
- "desc" : "Fire before toggle the menu",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.nav.Bar",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.data.JsonStore",
+ "Roo.data.SimpleStore"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.Tree" : {
+ "props" : [
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "append",
+ "type" : "function",
+ "desc" : "Fires when a new child node is appended to a node in this tree.",
+ "sig" : "function (tree, parent, node, index)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
+ {
+ "name" : "parent",
+ "type" : "Node",
+ "desc" : "The parent node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The newly appended node",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the newly appended node",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "beforeappend",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "Fires before a new child is appended to a node in this tree, return false to cancel the append.",
+ "sig" : "function (tree, parent, node)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
+ {
+ "name" : "parent",
+ "type" : "Node",
+ "desc" : "The parent node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node to be appended",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "beforeinsert",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires before a new child is inserted in a node in this tree, return false to cancel the insert.",
+ "sig" : "function (tree, parent, node, refNode)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
+ {
+ "name" : "parent",
+ "type" : "Node",
+ "desc" : "The parent node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node to be inserted",
+ "isOptional" : false
+ },
+ {
+ "name" : "refNode",
+ "type" : "Node",
+ "desc" : "The child node the node is being inserted before",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "beforemove",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires before a node is moved to a new location in the tree. Return false to cancel the move.",
+ "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The node being moved",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldParent",
+ "type" : "Node",
+ "desc" : "The parent of the node",
+ "isOptional" : false
+ },
+ {
+ "name" : "newParent",
+ "type" : "Node",
+ "desc" : "The new parent the node is moving to",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index it is being moved to",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enable",
+ "name" : "beforeremove",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires before a child is removed from a node in this tree, return false to cancel the remove.",
+ "sig" : "function (tree, parent, node)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
+ {
+ "name" : "parent",
+ "type" : "Node",
+ "desc" : "The parent node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node to be removed",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "hide",
+ "name" : "insert",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a new child node is inserted in a node in this tree.",
+ "sig" : "function (tree, parent, node, refNode)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
+ {
+ "name" : "parent",
+ "type" : "Node",
+ "desc" : "The parent node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node inserted",
+ "isOptional" : false
+ },
+ {
+ "name" : "refNode",
+ "type" : "Node",
+ "desc" : "The child node the node was inserted before",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "move",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a node is moved to a new location in the tree",
+ "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The node moved",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldParent",
+ "type" : "Node",
+ "desc" : "The old parent of this node",
+ "isOptional" : false
+ },
+ {
+ "name" : "newParent",
+ "type" : "Node",
+ "desc" : "The new parent of this node",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index it was moved to",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "remove",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a child node is removed from a node in this tree.",
+ "sig" : "function (tree, parent, node)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
+ {
+ "name" : "parent",
+ "type" : "Node",
+ "desc" : "The parent node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node removed",
"isOptional" : false
}
],
],
"returns" : []
},
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Collapse the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.nav.Bar",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expand the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.nav.Bar",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "fireEvent",
"type" : "function",
]
},
{
- "name" : "focus",
+ "name" : "getNodeById",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Gets a node in this tree by its id.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "getChildContainer",
- "type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
- },
- {
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "Node",
+ "desc" : ""
}
]
},
{
- "name" : "getId",
+ "name" : "getRootNode",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Returns the root node for this tree.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
+ "type" : "Node",
"desc" : ""
}
]
},
- {
- "name" : "getVisibilityEl",
- "type" : "function",
- "desc" : "Get the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "hasListener",
"type" : "function",
}
]
},
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "initEvents",
- "type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
"returns" : []
},
{
- "name" : "render",
- "type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setDisabled",
+ "name" : "setRootNode",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Sets the root node for this tree.",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
+ "name" : "node",
+ "type" : "Node",
"desc" : "",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "setVisibilityEl",
- "type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Node",
+ "desc" : ""
}
]
},
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [
- "Roo.bootstrap.PagingToolbar",
- "Roo.bootstrap.PopoverNav",
- "Roo.bootstrap.form.HtmlEditorToolbar.Standard",
- "Roo.bootstrap.nav.Headerbar"
- ],
- "tree_children" : [
- "Roo.bootstrap.nav.Group",
- "Roo.bootstrap.form.Form",
- "Roo.bootstrap.Row",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.TabGroup",
- "Roo.bootstrap.Link"
+ "Roo.tree.ColumnTree",
+ "Roo.tree.TreePanel"
],
- "tree_parent" : []
- },
- "Roo.bootstrap.panel" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.panel.Content" : {
- "props" : [
- {
- "name" : "adjustments",
- "type" : "Array",
- "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoCreate",
- "type" : "Boolean/Object",
- "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoScroll",
- "type" : "Boolean",
- "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "background",
- "type" : "Boolean",
- "desc" : "True if the panel should not be activated when it is added (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "badges",
- "type" : "Boolean",
- "desc" : "render the badges",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "closable",
- "type" : "Boolean",
- "desc" : "True if the panel can be closed/removed",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "extra classes to use",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "content",
- "type" : "String",
- "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fitContainer",
- "type" : "Boolean",
- "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fitToFrame",
- "type" : "Boolean",
- "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "iframe",
- "type" : "Boolean",
- "desc" : "contents are an iframe - makes showing remote sources/CSS feasible..",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "loadOnce",
- "type" : "Boolean",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "region",
- "type" : "String",
- "desc" : "(center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "resizeEl",
- "type" : "String/HTMLElement/Element",
- "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
+ "Roo.data.XmlReader" : {
+ "props" : [
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The DomQuery path relative from the record element to the element that contains\na record identifier value.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "title",
+ "name" : "record",
"type" : "String",
- "desc" : "The title for this panel",
+ "desc" : "The DomQuery path to the repeated element which contains record information.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "toolbar",
- "type" : "Toolbar",
- "desc" : "A toolbar for this panel",
+ "name" : "success",
+ "type" : "String",
+ "desc" : "The DomQuery path to the success attribute used by forms.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "url",
+ "name" : "totalRecords",
"type" : "String",
- "desc" : "Calls {@link #setUrl} with this value",
+ "desc" : "The DomQuery path from which to retrieve the total number of records\nin the dataset. This is only needed if the whole dataset is not passed in one go, but is being\npaged from the remote server.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
}
],
- "events" : [
+ "events" : [],
+ "methods" : [
{
- "name" : "activate",
+ "name" : "newRow",
"type" : "function",
- "desc" : "Fires when this panel is activated.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Create an empty record",
+ "sig" : "(data)",
+ "static" : false,
+ "memberOf" : "Roo.data.DataReader",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "(optional) - overlay some values",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.data.Record",
+ "desc" : "record created."
+ }
+ ]
},
{
- "name" : "deactivate",
+ "name" : "read",
"type" : "function",
- "desc" : "Fires when this panel is activated.",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "This method is only used by a DataProxy which has retrieved data from a remote server.",
+ "sig" : "(response)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
+ "name" : "response",
+ "type" : "Object",
+ "desc" : "The XHR object which contains the parsed XML document. The response is expected\nto contain a method called 'responseXML' that returns an XML document object.",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "records A data block which is used by an {@link Roo.data.Store} as\na cache of Roo.data.Records."
+ }
+ ]
},
{
- "name" : "render",
+ "name" : "readRecords",
"type" : "function",
- "desc" : "Fires when this tab is created",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Create a data block containing Roo.data.Records from an XML document.",
+ "sig" : "(doc)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
+ "name" : "doc",
+ "type" : "Object",
+ "desc" : "A parsed XML document.",
"isOptional" : false
}
],
- "returns" : []
- },
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "records A data block which is used by an {@link Roo.data.Store} as\na cache of Roo.data.Records."
+ }
+ ]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.dd" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.dd.DD" : {
+ "props" : [
{
- "name" : "resize",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Fires when this panel is resized if fitToFrame is true.",
- "sig" : "function (_self, width, height)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The width after any component adjustments",
- "isOptional" : false
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "The height after any component adjustments",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "scroll",
+ "name" : "addInvalidHandleClass",
"type" : "function",
- "desc" : "Fires when this content is scrolled",
- "sig" : "function (_self, scrollEvent)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Lets you specify a css class of elements that will not initiate a drag",
+ "sig" : "(cssClass)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the elements you wish to ignore",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "addInvalidHandleId",
+ "type" : "function",
+ "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "scrollEvent",
- "type" : "Event",
- "desc" : "",
+ "name" : "id",
+ "type" : "string",
+ "desc" : "the element id of the element you wish to ignore",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "addEvents",
+ "name" : "addInvalidHandleType",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
+ "sig" : "(tagName)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to exclude",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "addToGroup",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
+ "sig" : "(sGroup)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "sGroup",
+ "type" : "",
+ "desc" : "{string} the name of the group",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "alignElWithMouse",
"type" : "function",
- "desc" : "Destroys this panel",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
+ "sig" : "(el, iPageX, iPageY)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "HTMLElement",
+ "desc" : "the element to move",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the mousedown or drag event",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the mousedown or drag event",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "applyConfig",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "getChildContainer",
+ "name" : "autoOffset",
"type" : "function",
- "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'Form',\n items: [ .... ]\n }\n);\n\n</code></pre>",
- "sig" : "(cfg)",
+ "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked",
+ "sig" : "(iPageX, iPageY)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "cfg",
- "type" : "Object",
- "desc" : "Xtype definition of item to add.",
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the click",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the click",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "getEl",
+ "name" : "cachePosition",
"type" : "function",
- "desc" : "Returns this panel's element - used by regiosn to add.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.",
+ "sig" : "(iPageX, iPageY)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : ""
+ "name" : "iPageX",
+ "type" : "",
+ "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageY",
+ "type" : "",
+ "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getId",
+ "name" : "capture",
"type" : "function",
- "desc" : "Returns this panel's id",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : ""
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getTitle",
+ "name" : "clearConstraints",
"type" : "function",
- "desc" : "Returns this panel's title",
+ "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getToolbar",
+ "name" : "clearTicks",
"type" : "function",
- "desc" : "Returns the toolbar for this Panel if one was configured.",
+ "desc" : "Clears any tick interval defined for this instance",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Toolbar",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getUpdateManager",
+ "name" : "endDrag",
"type" : "function",
- "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fired when we are done dragging the object",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.UpdateManager",
- "desc" : "The UpdateManager"
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The name of the event to check for",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "isClosable",
+ "name" : "getDragEl",
"type" : "function",
- "desc" : "Returns true is this panel was configured to be closable",
+ "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "type" : "HTMLElement",
+ "desc" : "the html element"
}
]
},
{
- "name" : "load",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.\nDoes not work with IFRAME contents",
- "sig" : "(url, params, callback, discardUrl)",
+ "desc" : "Returns a reference to the linked element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "url",
- "type" : "Object/String/Function",
- "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\npanel.load({\n url: \"your-url.php\",\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n callback: yourFunction,\n scope: yourObject, //(optional scope)\n discardUrl: false,\n nocache: false,\n text: \"Loading...\",\n timeout: 30,\n scripts: false\n});\n</code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
- "isOptional" : false
- },
- {
- "name" : "discardUrl",
- "type" : "Boolean",
- "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "this"
+ "type" : "HTMLElement",
+ "desc" : "the html element"
}
]
},
{
- "name" : "on",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "refresh",
+ "name" : "init",
"type" : "function",
- "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
+ "sig" : "(id, sGroup, config)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the linked element",
+ "isOptional" : false
+ },
+ {
+ "name" : "sGroup",
+ "type" : "String",
+ "desc" : "the group of related items",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "object",
+ "desc" : "configuration attributes",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "initTarget",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
+ "sig" : "(id, sGroup, config)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the linked element",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "sGroup",
+ "type" : "String",
+ "desc" : "the group of related items",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "config",
+ "type" : "object",
+ "desc" : "configuration attributes",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setContent",
+ "name" : "isLocked",
"type" : "function",
- "desc" : "Updates this panel's element (not for iframe)",
- "sig" : "(content, loadScripts)",
+ "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "content",
- "type" : "String",
- "desc" : "The new content",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "loadScripts",
- "type" : "Boolean",
- "desc" : "(optional) true to look for and process scripts",
- "isOptional" : false
+ "name" : "",
+ "type" : "boolean",
+ "desc" : "true if this obj or all drag/drop is locked, else\nfalse"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setTitle",
+ "name" : "isTarget",
"type" : "function",
- "desc" : "Set this panel's title",
- "sig" : "(title)",
+ "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "title",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setUrl",
+ "name" : "isValidHandleChild",
"type" : "function",
- "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
- "sig" : "(url, params, loadOnce)",
+ "desc" : "Checks the tag exclusion list to see if this click should be ignored",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "url",
- "type" : "String/Function",
- "desc" : "The URL to load the content from or a function to call to get the URL",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
- "isOptional" : false
- },
- {
- "name" : "loadOnce",
- "type" : "Boolean",
- "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)",
+ "name" : "node",
+ "type" : "HTMLElement",
+ "desc" : "the HTMLElement to evaluate",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.UpdateManager|Boolean",
- "desc" : "The UpdateManager or false if IFRAME"
+ "type" : "boolean",
+ "desc" : "true if this is a valid tag type, false if not"
}
]
},
{
- "name" : "un",
+ "name" : "lock",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Lock this instance",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "on",
+ "type" : "function",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.bootstrap.panel.Grid",
- "Roo.bootstrap.panel.Nest"
- ],
- "tree_children" : [
- "Roo.bootstrap.Alert",
- "Roo.bootstrap.BezierSignature",
- "Roo.bootstrap.Brick",
- "Roo.bootstrap.Button",
- "Roo.bootstrap.ButtonGroup",
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.Calendar",
- "Roo.bootstrap.Card",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.DocumentManager",
- "Roo.bootstrap.DocumentSlider",
- "Roo.bootstrap.DocumentViewer",
- "Roo.bootstrap.DropTarget",
- "Roo.bootstrap.Element",
- "Roo.bootstrap.Graph",
- "Roo.bootstrap.Header",
- "Roo.bootstrap.Img",
- "Roo.bootstrap.LayoutMasonry",
- "Roo.bootstrap.LayoutMasonryAuto",
- "Roo.bootstrap.Link",
- "Roo.bootstrap.LocationPicker",
- "Roo.bootstrap.MasonryBrick",
- "Roo.bootstrap.MessageBar",
- "Roo.bootstrap.Pagination",
- "Roo.bootstrap.PaginationItem",
- "Roo.bootstrap.PagingToolbar",
- "Roo.bootstrap.Progress",
- "Roo.bootstrap.ProgressBar",
- "Roo.bootstrap.Row",
- "Roo.bootstrap.Slider",
- "Roo.bootstrap.TabGroup",
- "Roo.bootstrap.TabPanel",
- "Roo.bootstrap.Table",
- "Roo.bootstrap.UploadCropbox",
- "Roo.bootstrap.breadcrumb.Nav",
- "Roo.bootstrap.dash.NumberBox",
- "Roo.bootstrap.dash.TabBox",
- "Roo.bootstrap.dash.TabPane",
- "Roo.bootstrap.form.CardUploader",
- "Roo.bootstrap.form.CheckBox",
- "Roo.bootstrap.form.ComboBox",
- "Roo.bootstrap.form.DateField",
- "Roo.bootstrap.form.DateSplitField",
- "Roo.bootstrap.form.FieldLabel",
- "Roo.bootstrap.form.Form",
- "Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.Input",
- "Roo.bootstrap.form.Markdown",
- "Roo.bootstrap.form.MoneyField",
- "Roo.bootstrap.form.MonthField",
- "Roo.bootstrap.form.NumberField",
- "Roo.bootstrap.form.Password",
- "Roo.bootstrap.form.PhoneInput",
- "Roo.bootstrap.form.Radio",
- "Roo.bootstrap.form.RadioSet",
- "Roo.bootstrap.form.SecurePass",
- "Roo.bootstrap.form.TextArea",
- "Roo.bootstrap.form.TimeField",
- "Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.nav.Group",
- "Roo.bootstrap.nav.Headerbar",
- "Roo.bootstrap.nav.ProgressBar",
- "Roo.bootstrap.nav.ProgressBarItem",
- "Roo.bootstrap.nav.Sidebar",
- "Roo.bootstrap.nav.SidebarItem",
- "Roo.bootstrap.nav.Simplebar"
- ],
- "tree_parent" : [
- "builder",
- "Roo.bootstrap.layout.Border"
- ]
- },
- "Roo.bootstrap.panel.Grid" : {
- "props" : [
- {
- "name" : "adjustments",
- "type" : "Array",
- "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoCreate",
- "type" : "Boolean/Object",
- "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoScroll",
- "type" : "Boolean",
- "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "background",
- "type" : "Boolean",
- "desc" : "True if the panel should not be activated when it is added (defaults to false)",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "badges",
- "type" : "Boolean",
- "desc" : "render the badges",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "closable",
- "type" : "Boolean",
- "desc" : "True if the panel can be closed/removed",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "extra classes to use",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "content",
- "type" : "String",
- "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fitContainer",
- "type" : "Boolean",
- "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fitToFrame",
- "type" : "Boolean",
- "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "grid",
- "type" : "Roo.bootstrap.Table",
- "desc" : "The grid for this panel",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "iframe",
- "type" : "Boolean",
- "desc" : "contents are an iframe - makes showing remote sources/CSS feasible..",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "loadOnce",
- "type" : "Boolean",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "region",
- "type" : "String",
- "desc" : "(center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "resizeEl",
- "type" : "String/HTMLElement/Element",
- "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "title",
- "type" : "String",
- "desc" : "The title for this panel",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "toolbar",
- "type" : "Roo.bootstrap.nav.Simplebar",
- "desc" : "the toolbar at the top of the grid.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "url",
- "type" : "String",
- "desc" : "Calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "activate",
- "type" : "function",
- "desc" : "Fires when this panel is activated.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "deactivate",
- "type" : "function",
- "desc" : "Fires when this panel is activated.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "onAvailable",
"type" : "function",
- "desc" : "Fires when this tab is created",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "resize",
+ "name" : "onDrag",
"type" : "function",
- "desc" : "Fires when this panel is resized if fitToFrame is true.",
- "sig" : "function (_self, width, height)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The width after any component adjustments",
- "isOptional" : false
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "The height after any component adjustments",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "scroll",
+ "name" : "onDragDrop",
"type" : "function",
- "desc" : "Fires when this content is scrolled",
- "sig" : "function (_self, scrollEvent)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
},
{
- "name" : "scrollEvent",
- "type" : "Event",
- "desc" : "",
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "addEvents",
+ "name" : "onDragEnter",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "onDragOut",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Abstract method called when we are no longer hovering over an element",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "onDragOver",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "onInvalidDrop",
"type" : "function",
- "desc" : "Destroys this panel",
- "sig" : "()\n{\n\n}",
+ "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "onMouseDown",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousedown event",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
},
{
- "name" : "getChildContainer",
+ "name" : "onMouseUp",
"type" : "function",
- "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'Form',\n items: [ .... ]\n }\n);\n\n</code></pre>",
- "sig" : "(cfg)",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "cfg",
- "type" : "Object",
- "desc" : "Xtype definition of item to add.",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "getEl",
+ "name" : "padding",
"type" : "function",
- "desc" : "Returns this panel's element - used by regiosn to add.",
+ "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getGrid",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Returns the grid for this panel",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.bootstrap.Table",
- "desc" : ""
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getId",
+ "name" : "removeFromGroup",
"type" : "function",
- "desc" : "Returns this panel's id",
- "sig" : "()\n{\n\n}",
+ "desc" : "Remove's this instance from the supplied interaction group",
+ "sig" : "(sGroup)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : ""
+ "name" : "sGroup",
+ "type" : "string",
+ "desc" : "The group to drop",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getTitle",
+ "name" : "removeInvalidHandleClass",
"type" : "function",
- "desc" : "Returns this panel's title",
- "sig" : "()\n{\n\n}",
+ "desc" : "Unsets an invalid css class",
+ "sig" : "(cssClass)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : ""
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the element(s) you wish to\nre-enable",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getToolbar",
+ "name" : "removeInvalidHandleId",
"type" : "function",
- "desc" : "Returns the toolbar for this Panel if one was configured.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Unsets an invalid handle id",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Toolbar",
- "desc" : ""
+ "name" : "id",
+ "type" : "string",
+ "desc" : "the id of the element to re-enable",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getUpdateManager",
+ "name" : "removeInvalidHandleType",
"type" : "function",
- "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
+ "sig" : "(tagName)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.UpdateManager",
- "desc" : "The UpdateManager"
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to unexclude",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The name of the event to check for",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "isClosable",
+ "name" : "resetConstraints",
"type" : "function",
- "desc" : "Returns true is this panel was configured to be closable",
- "sig" : "()\n{\n\n}",
+ "desc" : "resetConstraints must be called if you manually reposition a dd element.",
+ "sig" : "(maintainOffset)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "name" : "maintainOffset",
+ "type" : "boolean",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "load",
+ "name" : "setDelta",
"type" : "function",
- "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.\nDoes not work with IFRAME contents",
- "sig" : "(url, params, callback, discardUrl)",
+ "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)",
+ "sig" : "(iDeltaX, iDeltaY)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "url",
- "type" : "Object/String/Function",
- "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\npanel.load({\n url: \"your-url.php\",\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n callback: yourFunction,\n scope: yourObject, //(optional scope)\n discardUrl: false,\n nocache: false,\n text: \"Loading...\",\n timeout: 30,\n scripts: false\n});\n</code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
+ "name" : "iDeltaX",
+ "type" : "int",
+ "desc" : "the distance from the left",
"isOptional" : false
},
{
- "name" : "discardUrl",
- "type" : "Boolean",
- "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
+ "name" : "iDeltaY",
+ "type" : "int",
+ "desc" : "the distance from the top",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "on",
+ "name" : "setDragElId",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "id",
+ "type" : "",
+ "desc" : "{string} the id of the element that will be used to initiate the drag",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setDragElPos",
+ "type" : "function",
+ "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
+ "sig" : "(iPageX, iPageY)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the mousedown or drag event",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the mousedown or drag event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "setHandleElId",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "",
+ "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "refresh",
+ "name" : "setInitPosition",
"type" : "function",
- "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Stores the initial placement of the linked element.",
+ "sig" : "(diffX, diffY)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "diffX",
+ "type" : "int",
+ "desc" : "the X offset, default 0",
+ "isOptional" : false
+ },
+ {
+ "name" : "diffY",
+ "type" : "int",
+ "desc" : "the Y offset, default 0",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "setOuterHandleElId",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the element that will be used to initiate the drag",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "setPadding",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
+ "sig" : "(iTop, iRight, iBot, iLeft)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "iTop",
+ "type" : "int",
+ "desc" : "Top pad",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "Right pad",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "iBot",
+ "type" : "int",
+ "desc" : "Bot pad",
+ "isOptional" : false
+ },
+ {
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "Left pad",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setContent",
+ "name" : "setXConstraint",
"type" : "function",
- "desc" : "Updates this panel's element (not for iframe)",
- "sig" : "(content, loadScripts)",
+ "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
+ "sig" : "(iLeft, iRight, iTickSize)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "content",
- "type" : "String",
- "desc" : "The new content",
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the left",
"isOptional" : false
},
{
- "name" : "loadScripts",
- "type" : "Boolean",
- "desc" : "(optional) true to look for and process scripts",
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the\nright",
+ "isOptional" : false
+ },
+ {
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setTitle",
+ "name" : "setYConstraint",
"type" : "function",
- "desc" : "Set this panel's title",
- "sig" : "(title)",
+ "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
+ "sig" : "(iUp, iDown, iTickSize)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "title",
- "type" : "String",
- "desc" : "",
+ "name" : "iUp",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move up",
+ "isOptional" : false
+ },
+ {
+ "name" : "iDown",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move down",
+ "isOptional" : false
+ },
+ {
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setUrl",
+ "name" : "startDrag",
"type" : "function",
- "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
- "sig" : "(url, params, loadOnce)",
+ "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
+ "sig" : "(X, Y)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "url",
- "type" : "String/Function",
- "desc" : "The URL to load the content from or a function to call to get the URL",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
+ "name" : "X",
+ "type" : "int",
+ "desc" : "click location",
"isOptional" : false
},
{
- "name" : "loadOnce",
- "type" : "Boolean",
- "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)",
+ "name" : "Y",
+ "type" : "int",
+ "desc" : "click location",
"isOptional" : false
}
],
+ "returns" : []
+ },
+ {
+ "name" : "toString",
+ "type" : "function",
+ "desc" : "toString method",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.UpdateManager|Boolean",
- "desc" : "The UpdateManager or false if IFRAME"
+ "type" : "string",
+ "desc" : "string representation of the dd obj"
}
]
},
}
],
"returns" : []
+ },
+ {
+ "name" : "unlock",
+ "type" : "function",
+ "desc" : "Unlock this instace",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "unreg",
+ "type" : "function",
+ "desc" : "Remove all drag and drop hooks for this element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
+ "implementations" : [
+ "Roo.dd.DDProxy",
+ "Roo.dd.DragSource",
+ "Roo.dd.DragZone",
+ "Roo.grid.SplitDragZone"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.panel.Nest" : {
+ "Roo.dd.DDProxy" : {
"props" : [
- {
- "name" : "adjustments",
- "type" : "Array",
- "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoCreate",
- "type" : "Boolean/Object",
- "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoScroll",
- "type" : "Boolean",
- "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "background",
- "type" : "Boolean",
- "desc" : "True if the panel should not be activated when it is added (defaults to false)",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "badges",
- "type" : "Boolean",
- "desc" : "render the badges",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "closable",
- "type" : "Boolean",
- "desc" : "True if the panel can be closed/removed",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "extra classes to use",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "content",
- "type" : "String",
- "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fitContainer",
- "type" : "Boolean",
- "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fitToFrame",
- "type" : "Boolean",
- "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "iframe",
- "type" : "Boolean",
- "desc" : "contents are an iframe - makes showing remote sources/CSS feasible..",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "layout",
- "type" : "Roo.BorderLayout",
- "desc" : "The layout for this panel",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
"memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
- },
- {
- "name" : "loadOnce",
- "type" : "Boolean",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "region",
- "type" : "String",
- "desc" : "(center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "resizeEl",
- "type" : "String/HTMLElement/Element",
- "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "title",
- "type" : "String",
- "desc" : "The title for this panel",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "toolbar",
- "type" : "Toolbar",
- "desc" : "A toolbar for this panel",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "url",
- "type" : "String",
- "desc" : "Calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
}
],
- "events" : [
- {
- "name" : "activate",
- "type" : "function",
- "desc" : "Fires when this panel is activated.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
+ "events" : [],
+ "methods" : [
{
- "name" : "deactivate",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Fires when this panel is activated.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "addInvalidHandleClass",
"type" : "function",
- "desc" : "Fires when this tab is created",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "desc" : "Lets you specify a css class of elements that will not initiate a drag",
+ "sig" : "(cssClass)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the elements you wish to ignore",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resize",
+ "name" : "addInvalidHandleId",
"type" : "function",
- "desc" : "Fires when this panel is resized if fitToFrame is true.",
- "sig" : "function (_self, width, height)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The width after any component adjustments",
- "isOptional" : false
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "The height after any component adjustments",
+ "name" : "id",
+ "type" : "string",
+ "desc" : "the element id of the element you wish to ignore",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "scroll",
- "type" : "function",
- "desc" : "Fires when this content is scrolled",
- "sig" : "function (_self, scrollEvent)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "scrollEvent",
- "type" : "Event",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "methods" : [
- {
- "name" : "addEvents",
+ "name" : "addInvalidHandleType",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
+ "sig" : "(tagName)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to exclude",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addxtype",
+ "name" : "addToGroup",
"type" : "function",
- "desc" : "Adds a xtype elements to the layout of the nested panel\n<pre><code>\n\npanel.addxtype({\n xtype : 'ContentPanel',\n region: 'west',\n items: [ .... ]\n }\n);\n\npanel.addxtype({\n xtype : 'NestedLayoutPanel',\n region: 'west',\n layout: {\n center: { },\n west: { } \n },\n items : [ ... list of content panels or nested layout panels.. ]\n }\n);\n</code></pre>",
- "sig" : "(cfg)",
+ "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
+ "sig" : "(sGroup)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "cfg",
- "type" : "Object",
- "desc" : "Xtype definition of item to add.",
+ "name" : "sGroup",
+ "type" : "",
+ "desc" : "{string} the name of the group",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "alignElWithMouse",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
+ "sig" : "(el, iPageX, iPageY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DD",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
+ "name" : "el",
+ "type" : "HTMLElement",
+ "desc" : "the element to move",
"isOptional" : false
},
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the mousedown or drag event",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the mousedown or drag event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "applyConfig",
"type" : "function",
- "desc" : "Destroys this panel",
+ "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "autoOffset",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked",
+ "sig" : "(iPageX, iPageY)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the click",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the click",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
},
{
- "name" : "getChildContainer",
+ "name" : "cachePosition",
"type" : "function",
- "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'Form',\n items: [ .... ]\n }\n);\n\n</code></pre>",
- "sig" : "(cfg)",
+ "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.",
+ "sig" : "(iPageX, iPageY)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "cfg",
+ "name" : "iPageX",
+ "type" : "",
+ "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageY",
+ "type" : "",
+ "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "capture",
+ "type" : "function",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
"type" : "Object",
- "desc" : "Xtype definition of item to add.",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "getEl",
+ "name" : "clearConstraints",
"type" : "function",
- "desc" : "Returns this panel's element - used by regiosn to add.",
+ "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getId",
+ "name" : "clearTicks",
"type" : "function",
- "desc" : "Returns this panel's id",
+ "desc" : "Clears any tick interval defined for this instance",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getLayout",
+ "name" : "createFrame",
"type" : "function",
- "desc" : "Returns the nested BorderLayout for this panel",
+ "desc" : "Creates the proxy element if it does not yet exist",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "endDrag",
+ "type" : "function",
+ "desc" : "Fired when we are done dragging the object",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.BorderLayout",
- "desc" : ""
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getTitle",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Returns this panel's title",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "getToolbar",
+ "name" : "getDragEl",
"type" : "function",
- "desc" : "Returns the toolbar for this Panel if one was configured.",
+ "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Toolbar",
- "desc" : ""
+ "type" : "HTMLElement",
+ "desc" : "the html element"
}
]
},
{
- "name" : "getUpdateManager",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
+ "desc" : "Returns a reference to the linked element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.UpdateManager",
- "desc" : "The UpdateManager"
+ "type" : "HTMLElement",
+ "desc" : "the html element"
}
]
},
]
},
{
- "name" : "isClosable",
+ "name" : "init",
"type" : "function",
- "desc" : "Returns true is this panel was configured to be closable",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
+ "sig" : "(id, sGroup, config)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the linked element",
+ "isOptional" : false
+ },
+ {
+ "name" : "sGroup",
+ "type" : "String",
+ "desc" : "the group of related items",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "object",
+ "desc" : "configuration attributes",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "load",
+ "name" : "initFrame",
"type" : "function",
- "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.\nDoes not work with IFRAME contents",
- "sig" : "(url, params, callback, discardUrl)",
+ "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "url",
- "type" : "Object/String/Function",
- "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\npanel.load({\n url: \"your-url.php\",\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n callback: yourFunction,\n scope: yourObject, //(optional scope)\n discardUrl: false,\n nocache: false,\n text: \"Loading...\",\n timeout: 30,\n scripts: false\n});\n</code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
- "isOptional" : false
- },
- {
- "name" : "discardUrl",
- "type" : "Boolean",
- "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "this"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "on",
+ "name" : "initTarget",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
+ "sig" : "(id, sGroup, config)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the linked element",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "sGroup",
+ "type" : "String",
+ "desc" : "the group of related items",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "config",
+ "type" : "object",
+ "desc" : "configuration attributes",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "isLocked",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "boolean",
+ "desc" : "true if this obj or all drag/drop is locked, else\nfalse"
+ }
+ ]
},
{
- "name" : "refresh",
+ "name" : "isTarget",
"type" : "function",
- "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
+ "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "isValidHandleChild",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Checks the tag exclusion list to see if this click should be ignored",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "node",
+ "type" : "HTMLElement",
+ "desc" : "the HTMLElement to evaluate",
"isOptional" : false
}
],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "boolean",
+ "desc" : "true if this is a valid tag type, false if not"
+ }
+ ]
+ },
+ {
+ "name" : "lock",
+ "type" : "function",
+ "desc" : "Lock this instance",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "on",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setContent",
+ "name" : "onAvailable",
"type" : "function",
- "desc" : "Updates this panel's element (not for iframe)",
- "sig" : "(content, loadScripts)",
+ "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "content",
- "type" : "String",
- "desc" : "The new content",
- "isOptional" : false
- },
- {
- "name" : "loadScripts",
- "type" : "Boolean",
- "desc" : "(optional) true to look for and process scripts",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setTitle",
+ "name" : "onDrag",
"type" : "function",
- "desc" : "Set this panel's title",
- "sig" : "(title)",
+ "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "title",
- "type" : "String",
- "desc" : "",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setUrl",
+ "name" : "onDragDrop",
"type" : "function",
- "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
- "sig" : "(url, params, loadOnce)",
+ "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "url",
- "type" : "String/Function",
- "desc" : "The URL to load the content from or a function to call to get the URL",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
},
{
- "name" : "loadOnce",
- "type" : "Boolean",
- "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)",
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.UpdateManager|Boolean",
- "desc" : "The UpdateManager or false if IFRAME"
- }
- ]
+ "returns" : []
},
{
- "name" : "un",
+ "name" : "onDragEnter",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.bootstrap.panel.TabItem" : {
- "props" : [
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "activate",
- "type" : "function",
- "desc" : "Fires when this tab becomes the active tab.",
- "sig" : "function (tabPanel, _self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "tabPanel",
- "type" : "Roo.TabPanel",
- "desc" : "The parent TabPanel",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
},
{
- "name" : "this",
- "type" : "Roo.TabPanelItem",
- "desc" : "",
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeclose",
+ "name" : "onDragOut",
"type" : "function",
- "desc" : "Fires before this tab is closed. To cancel the close, set cancel to true on e (e.cancel = true).",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Abstract method called when we are no longer hovering over an element",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
- {
- "name" : "this",
- "type" : "Roo.TabPanelItem",
- "desc" : "",
- "isOptional" : false
- },
{
"name" : "e",
- "type" : "Object",
- "desc" : "Set cancel to true on this object to cancel the close.",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "close",
- "type" : "function",
- "desc" : "Fires when this tab is closed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.TabPanelItem",
- "desc" : "",
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "deactivate",
+ "name" : "onDragOver",
"type" : "function",
- "desc" : "Fires when this tab is no longer the active tab.",
- "sig" : "function (tabPanel, _self)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "tabPanel",
- "type" : "Roo.TabPanel",
- "desc" : "The parent TabPanel",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
},
{
- "name" : "this",
- "type" : "Roo.TabPanelItem",
- "desc" : "",
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
- {
- "name" : "activate",
- "type" : "function",
- "desc" : "Activates this TabPanelItem -- this <b>does</b> deactivate the currently active TabPanelItem.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
},
{
- "name" : "addEvents",
+ "name" : "onInvalidDrop",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "onMouseDown",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousedown event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "onMouseUp",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "padding",
"type" : "function",
- "desc" : "Disables this TabPanelItem -- this does nothing if this is the active TabPanelItem.",
+ "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "enable",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Enables this TabPanelItem if it was previously disabled.",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
"memberOf" : "Roo.util.Observable",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
},
{
- "name" : "getText",
+ "name" : "removeFromGroup",
"type" : "function",
- "desc" : "Returns the text for this tab",
- "sig" : "()\n{\n\n}",
+ "desc" : "Remove's this instance from the supplied interaction group",
+ "sig" : "(sGroup)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : ""
+ "name" : "sGroup",
+ "type" : "string",
+ "desc" : "The group to drop",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getUpdateManager",
+ "name" : "removeInvalidHandleClass",
"type" : "function",
- "desc" : "Gets the {@link Roo.UpdateManager} for the body of this TabPanelItem. Enables you to perform Ajax updates.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Unsets an invalid css class",
+ "sig" : "(cssClass)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.UpdateManager",
- "desc" : "The UpdateManager"
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the element(s) you wish to\nre-enable",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "removeInvalidHandleId",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Unsets an invalid handle id",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "id",
+ "type" : "string",
+ "desc" : "the id of the element to re-enable",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "hide",
+ "name" : "removeInvalidHandleType",
"type" : "function",
- "desc" : "Hides this TabPanelItem -- if you don't activate another TabPanelItem this could look odd.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
+ "sig" : "(tagName)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to unexclude",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "isActive",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Returns true if this tab is the active tab.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "isHidden",
+ "name" : "resetConstraints",
"type" : "function",
- "desc" : "Returns true if this tab is \"hidden\"",
- "sig" : "()\n{\n\n}",
+ "desc" : "resetConstraints must be called if you manually reposition a dd element.",
+ "sig" : "(maintainOffset)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "name" : "maintainOffset",
+ "type" : "boolean",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "on",
+ "name" : "setDelta",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)",
+ "sig" : "(iDeltaX, iDeltaY)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "iDeltaX",
+ "type" : "int",
+ "desc" : "the distance from the left",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "iDeltaY",
+ "type" : "int",
+ "desc" : "the distance from the top",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "setDragElId",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "",
+ "desc" : "{string} the id of the element that will be used to initiate the drag",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "refresh",
+ "name" : "setDragElPos",
"type" : "function",
- "desc" : "Forces a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the setUrl method has not been called.\n This does not activate the panel, just updates its content.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
+ "sig" : "(iPageX, iPageY)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the mousedown or drag event",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the mousedown or drag event",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "setHandleElId",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "id",
+ "type" : "",
+ "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "setInitPosition",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Stores the initial placement of the linked element.",
+ "sig" : "(diffX, diffY)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "diffX",
+ "type" : "int",
+ "desc" : "the X offset, default 0",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "diffY",
+ "type" : "int",
+ "desc" : "the Y offset, default 0",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setContent",
+ "name" : "setOuterHandleElId",
"type" : "function",
- "desc" : "Sets the content for this TabPanelItem.",
- "sig" : "(content, loadScripts)",
+ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "content",
- "type" : "String",
- "desc" : "The content",
- "isOptional" : false
- },
- {
- "name" : "loadScripts",
- "type" : "Boolean",
- "desc" : "true to look for and load scripts",
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the element that will be used to initiate the drag",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setHidden",
+ "name" : "setPadding",
"type" : "function",
- "desc" : "Show or hide the tab",
- "sig" : "(hidden)",
+ "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
+ "sig" : "(iTop, iRight, iBot, iLeft)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "True to hide or false to show.",
+ "name" : "iTop",
+ "type" : "int",
+ "desc" : "Top pad",
+ "isOptional" : false
+ },
+ {
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "Right pad",
+ "isOptional" : false
+ },
+ {
+ "name" : "iBot",
+ "type" : "int",
+ "desc" : "Bot pad",
+ "isOptional" : false
+ },
+ {
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "Left pad",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setText",
+ "name" : "setXConstraint",
"type" : "function",
- "desc" : "Sets the text for the tab (Note: this also sets the tooltip text)",
- "sig" : "(text)",
+ "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
+ "sig" : "(iLeft, iRight, iTickSize)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "text",
- "type" : "String",
- "desc" : "The tab's text and tooltip",
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the left",
+ "isOptional" : false
+ },
+ {
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the\nright",
+ "isOptional" : false
+ },
+ {
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setTooltip",
+ "name" : "setYConstraint",
"type" : "function",
- "desc" : "Set the tooltip for the tab.",
- "sig" : "(tooltip)",
+ "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
+ "sig" : "(iUp, iDown, iTickSize)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "tooltip",
- "type" : "String",
- "desc" : "The tab's tooltip",
+ "name" : "iUp",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move up",
+ "isOptional" : false
+ },
+ {
+ "name" : "iDown",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move down",
+ "isOptional" : false
+ },
+ {
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setUrl",
+ "name" : "startDrag",
"type" : "function",
- "desc" : "Set a URL to be used to load the content for this TabPanelItem.",
- "sig" : "(url, params, loadOnce)",
+ "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
+ "sig" : "(X, Y)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "url",
- "type" : "String/Function",
- "desc" : "The URL to load the content from, or a function to call to get the URL",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
+ "name" : "X",
+ "type" : "int",
+ "desc" : "click location",
"isOptional" : false
},
{
- "name" : "loadOnce",
- "type" : "Boolean",
- "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this TabPanelItem is activated. (Defaults to false)",
+ "name" : "Y",
+ "type" : "int",
+ "desc" : "click location",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.UpdateManager",
- "desc" : "The UpdateManager"
- }
- ]
+ "returns" : []
},
{
- "name" : "show",
+ "name" : "toString",
"type" : "function",
- "desc" : "Shows this TabPanelItem -- this <b>does not</b> deactivate the currently active TabPanelItem.",
+ "desc" : "toString method",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "string",
+ "desc" : "string representation of the dd obj"
+ }
+ ]
},
{
"name" : "un",
}
],
"returns" : []
+ },
+ {
+ "name" : "unlock",
+ "type" : "function",
+ "desc" : "Unlock this instace",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "unreg",
+ "type" : "function",
+ "desc" : "Remove all drag and drop hooks for this element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
+ "implementations" : [
+ "Roo.dd.DragSource",
+ "Roo.dd.DragZone",
+ "Roo.grid.SplitDragZone"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.panel.Tabs" : {
+ "Roo.dd.DDTarget" : {
"props" : [
{
"name" : "listeners",
"optvals" : []
}
],
- "events" : [
+ "events" : [],
+ "methods" : [
{
- "name" : "beforetabchange",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Fires before the active tab changes, set cancel to true on the \"e\" parameter to cancel the change",
- "sig" : "function (_self, e, tab)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.TabPanel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
+ "name" : "object",
"type" : "Object",
- "desc" : "Set cancel to true on this object to cancel the tab change",
- "isOptional" : false
- },
- {
- "name" : "tab",
- "type" : "Roo.TabPanelItem",
- "desc" : "The tab being changed to",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "tabchange",
+ "name" : "addInvalidHandleClass",
"type" : "function",
- "desc" : "Fires when the active tab changes",
- "sig" : "function (_self, activePanel)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Lets you specify a css class of elements that will not initiate a drag",
+ "sig" : "(cssClass)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.TabPanel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "activePanel",
- "type" : "Roo.TabPanelItem",
- "desc" : "The new active tab",
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the elements you wish to ignore",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "activate",
+ "name" : "addInvalidHandleId",
"type" : "function",
- "desc" : "Activates a {@link Roo.TabPanelItem}. The currently active one will be deactivated.",
+ "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
"sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [
{
"name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to activate.",
+ "type" : "string",
+ "desc" : "the element id of the element you wish to ignore",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.TabPanelItem",
- "desc" : "The TabPanelItem."
- }
- ]
+ "returns" : []
},
{
- "name" : "addEvents",
+ "name" : "addInvalidHandleType",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
+ "sig" : "(tagName)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to exclude",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addTab",
- "type" : "function",
- "desc" : "Creates a new {@link Roo.TabPanelItem} by looking for an existing element with the provided id -- if it's not found it creates one.",
- "sig" : "(id, text, content, closable)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the div to use <b>or create</b>",
- "isOptional" : false
- },
- {
- "name" : "text",
- "type" : "String",
- "desc" : "The text for the tab",
- "isOptional" : false
- },
- {
- "name" : "content",
- "type" : "String",
- "desc" : "(optional) Content to put in the TabPanelItem body",
- "isOptional" : false
- },
- {
- "name" : "closable",
- "type" : "Boolean",
- "desc" : "(optional) True to create a close icon on the tab",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.TabPanelItem",
- "desc" : "The created TabPanelItem"
- }
- ]
- },
- {
- "name" : "addTabItem",
+ "name" : "addToGroup",
"type" : "function",
- "desc" : "Adds an existing {@link Roo.TabPanelItem}.",
- "sig" : "(item)",
+ "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
+ "sig" : "(sGroup)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "item",
- "type" : "Roo.TabPanelItem",
- "desc" : "The TabPanelItem to add",
+ "name" : "sGroup",
+ "type" : "",
+ "desc" : "{string} the name of the group",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "autoSizeTabs",
- "type" : "function",
- "desc" : "Manual call to resize the tabs (if {@link #resizeTabs} is false this does nothing)",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "beginUpdate",
+ "name" : "applyConfig",
"type" : "function",
- "desc" : "Disables tab resizing while tabs are being added (if {@link #resizeTabs} is false this does nothing)",
+ "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "clearConstraints",
"type" : "function",
- "desc" : "Destroys this TabPanel",
- "sig" : "(removeEl)",
+ "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "removeEl",
- "type" : "Boolean",
- "desc" : "(optional) True to remove the element from the DOM as well (defaults to undefined)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "disableTab",
+ "name" : "clearTicks",
"type" : "function",
- "desc" : "Disables a {@link Roo.TabPanelItem}. It cannot be the active tab, if it is this call is ignored.",
- "sig" : "(id)",
+ "desc" : "Clears any tick interval defined for this instance",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to disable.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "enableTab",
+ "name" : "endDrag",
"type" : "function",
- "desc" : "Enables a {@link Roo.TabPanelItem} that is disabled.",
- "sig" : "(id)",
+ "desc" : "Fired when we are done dragging the object",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to enable.",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "endUpdate",
- "type" : "function",
- "desc" : "Stops an update and resizes the tabs (if {@link #resizeTabs} is false this does nothing)",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "fireEvent",
"type" : "function",
]
},
{
- "name" : "getActiveTab",
+ "name" : "getDragEl",
"type" : "function",
- "desc" : "Gets the active {@link Roo.TabPanelItem}.",
+ "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.TabPanelItem",
- "desc" : "The active TabPanelItem or null if none are active."
+ "type" : "HTMLElement",
+ "desc" : "the html element"
}
]
},
{
- "name" : "getCount",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns the number of tabs in this TabPanel.",
+ "desc" : "Returns a reference to the linked element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getTab",
- "type" : "function",
- "desc" : "Returns the {@link Roo.TabPanelItem} with the specified id/index",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to fetch.",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.TabPanelItem",
- "desc" : ""
+ "type" : "HTMLElement",
+ "desc" : "the html element"
}
]
},
]
},
{
- "name" : "hideTab",
+ "name" : "init",
"type" : "function",
- "desc" : "Hides the {@link Roo.TabPanelItem} with the specified id/index",
- "sig" : "(id)",
+ "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
+ "sig" : "(id, sGroup, config)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [
{
"name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to hide.",
+ "type" : "",
+ "desc" : "the id of the linked element",
+ "isOptional" : false
+ },
+ {
+ "name" : "sGroup",
+ "type" : "String",
+ "desc" : "the group of related items",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "object",
+ "desc" : "configuration attributes",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "on",
+ "name" : "initTarget",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
+ "sig" : "(id, sGroup, config)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the linked element",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "sGroup",
+ "type" : "String",
+ "desc" : "the group of related items",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "config",
+ "type" : "object",
+ "desc" : "configuration attributes",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "isLocked",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ "returns" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
+ "name" : "",
+ "type" : "boolean",
+ "desc" : "true if this obj or all drag/drop is locked, else\nfalse"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "removeListener",
+ "name" : "isTarget",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "removeTab",
+ "name" : "isValidHandleChild",
"type" : "function",
- "desc" : "Removes a {@link Roo.TabPanelItem}.",
- "sig" : "(id)",
+ "desc" : "Checks the tag exclusion list to see if this click should be ignored",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to remove.",
+ "name" : "node",
+ "type" : "HTMLElement",
+ "desc" : "the HTMLElement to evaluate",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "setTabWidth",
- "type" : "function",
- "desc" : "Resizes all the tabs to the passed width",
- "sig" : "(The)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ "returns" : [
{
- "name" : "The",
- "type" : "Number",
- "desc" : "new width",
- "isOptional" : false
+ "name" : "",
+ "type" : "boolean",
+ "desc" : "true if this is a valid tag type, false if not"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "syncHeight",
+ "name" : "lock",
"type" : "function",
- "desc" : "Updates the tab body element to fit the height of the container element\nfor overflow scrolling",
- "sig" : "(targetHeight)",
+ "desc" : "Lock this instance",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "targetHeight",
- "type" : "Number",
- "desc" : "(optional) Override the starting height from the elements height",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "un",
+ "name" : "on",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "unhideTab",
+ "name" : "onAvailable",
"type" : "function",
- "desc" : "\"Unhides\" the {@link Roo.TabPanelItem} with the specified id/index.",
- "sig" : "(id)",
+ "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to unhide.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.ArrayReader" : {
- "props" : [
- {
- "name" : "fields",
- "type" : "Array",
- "desc" : "Array of field definition objects",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
},
{
- "name" : "id",
- "type" : "String",
- "desc" : "Name of the property within a row object that contains a record identifier value.\nas specified to {@link Roo.data.Record#create},\nor an {@link Roo.data.Record} object\n\n\ncreated using {@link Roo.data.Record#create}.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
- {
- "name" : "newRow",
+ "name" : "onDrag",
"type" : "function",
- "desc" : "Create an empty record",
- "sig" : "(data)",
+ "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.data.DataReader",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "data",
- "type" : "Object",
- "desc" : "(optional) - overlay some values",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.data.Record",
- "desc" : "record created."
- }
- ]
+ "returns" : []
},
{
- "name" : "readRecords",
+ "name" : "onDragDrop",
"type" : "function",
- "desc" : "Create a data block containing Roo.data.Records from an XML document.",
- "sig" : "(o)",
+ "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Object",
- "desc" : "An Array of row objects which represents the dataset.",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "A data block which is used by an {@link Roo.data.Store} object as\na cache of Roo.data.Records."
- }
- ]
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.Connection" : {
- "props" : [
- {
- "name" : "autoAbort",
- "type" : "Boolean",
- "desc" : "Whether this request should abort any pending requests. (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "defaultHeaders",
- "type" : "Object",
- "desc" : "An object containing request headers which are added\n to each request made by this object. (defaults to undefined)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableCaching",
- "type" : "Boolean",
- "desc" : "True to add a unique cache-buster param to GET requests. (defaults to true)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "extraParams",
- "type" : "Object",
- "desc" : "An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "method",
- "type" : "String",
- "desc" : "The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "timeout",
- "type" : "Number",
- "desc" : "The timeout in milliseconds to be used for requests. (defaults to 30000)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "url",
- "type" : "String",
- "desc" : "The default URL to be used for requests to the server. (defaults to undefined)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "beforerequest",
- "type" : "function",
- "desc" : "Fires before a network request is made to retrieve a data object.",
- "sig" : "function (conn, options)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "conn",
- "type" : "Connection",
- "desc" : "This Connection object.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "The options config object passed to the {@link #request} method.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "requestcomplete",
- "type" : "function",
- "desc" : "Fires if the request was successfully completed.",
- "sig" : "function (conn, response, options)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "conn",
- "type" : "Connection",
- "desc" : "This Connection object.",
- "isOptional" : false
- },
- {
- "name" : "response",
- "type" : "Object",
- "desc" : "The XHR object containing the response data.\nSee {@link http://www.w3.org/TR/XMLHttpRequest/} for details.",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "The options config object passed to the {@link #request} method.",
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "requestexception",
- "type" : "function",
- "desc" : "Fires if an error HTTP status was returned from the server.\nSee {@link http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html} for details of HTTP status codes.",
- "sig" : "function (conn, response, options)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "conn",
- "type" : "Connection",
- "desc" : "This Connection object.",
- "isOptional" : false
- },
- {
- "name" : "response",
- "type" : "Object",
- "desc" : "The XHR object containing the response data.\nSee {@link http://www.w3.org/TR/XMLHttpRequest/} for details.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "The options config object passed to the {@link #request} method.",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "methods" : [
- {
- "name" : "abort",
+ "name" : "onDragEnter",
"type" : "function",
- "desc" : "Aborts any outstanding request.",
- "sig" : "(transactionId)",
+ "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "transactionId",
- "type" : "Number",
- "desc" : "defaults to the last transaction",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "onDragOut",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Abstract method called when we are no longer hovering over an element",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "onDragOver",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "onInvalidDrop",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "onMouseDown",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousedown event",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "isLoading",
+ "name" : "onMouseUp",
"type" : "function",
- "desc" : "Determine whether this object has a request outstanding.",
- "sig" : "(transactionId)",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "transactionId",
- "type" : "Number",
- "desc" : "defaults to the last transaction",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if there is an outstanding request."
- }
- ]
+ "returns" : []
},
{
- "name" : "on",
+ "name" : "padding",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "removeFromGroup",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Remove's this instance from the supplied interaction group",
+ "sig" : "(sGroup)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "sGroup",
+ "type" : "string",
+ "desc" : "The group to drop",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "request",
+ "name" : "removeInvalidHandleClass",
"type" : "function",
- "desc" : "Sends an HTTP request to a remote server.",
- "sig" : "(options)",
+ "desc" : "Unsets an invalid css class",
+ "sig" : "(cssClass)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "An object which may contain the following properties:<ul>\n<li><b>url</b> {String} The URL to which to send the request. Defaults to configured URL</li>\n<li><b>params</b> {Object/String/Function} An object containing properties which are used as parameters to the\nrequest, a url encoded string or a function to call to get either.</li>\n<li><b>method</b> {String} The HTTP method to use for the request. Defaults to the configured method, or\nif no method was configured, \"GET\" if no parameters are being sent, and \"POST\" if parameters are being sent.</li>\n<li><b>callback</b> {Function} The function to be called upon receipt of the HTTP response.\nThe callback is called regardless of success or failure and is passed the following parameters:<ul>\n<li>options {Object} The parameter to the request call.</li>\n<li>success {Boolean} True if the request succeeded.</li>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n</ul></li>\n<li><b>success</b> {Function} The function to be called upon success of the request.\nThe callback is passed the following parameters:<ul>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n<li>options {Object} The parameter to the request call.</li>\n</ul></li>\n<li><b>failure</b> {Function} The function to be called upon failure of the request.\nThe callback is passed the following parameters:<ul>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n<li>options {Object} The parameter to the request call.</li>\n</ul></li>\n<li><b>scope</b> {Object} The scope in which to execute the callbacks: The \"this\" object\nfor the callback function. Defaults to the browser window.</li>\n<li><b>form</b> {Object/String} A form object or id to pull parameters from.</li>\n<li><b>isUpload</b> {Boolean} True if the form object is a file upload (will usually be automatically detected).</li>\n<li><b>headers</b> {Object} Request headers to set for the request.</li>\n<li><b>xmlData</b> {Object} XML document to use for the post. Note: This will be used instead of\nparams for the post data. Any params will be appended to the URL.</li>\n<li><b>disableCaching</b> {Boolean} True to add a unique cache-buster param to GET requests.</li>\n</ul>",
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the element(s) you wish to\nre-enable",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "transactionId"
- }
- ]
+ "returns" : []
},
{
- "name" : "un",
+ "name" : "removeInvalidHandleId",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Unsets an invalid handle id",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "id",
+ "type" : "string",
+ "desc" : "the id of the element to re-enable",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.Ajax"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.DataProxy" : {
- "props" : [
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
+ },
{
- "name" : "beforeload",
+ "name" : "removeInvalidHandleType",
"type" : "function",
- "desc" : "Fires before a network request is made to retrieve a data object.",
- "sig" : "function (This, params)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
+ "sig" : "(tagName)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "This",
- "type" : "Object",
- "desc" : "DataProxy object.",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "Object",
- "desc" : "The params parameter to the load function.",
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to unexclude",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "load",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Fires before the load method's callback is called.",
- "sig" : "function (This, o, arg)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "This",
- "type" : "Object",
- "desc" : "DataProxy object.",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "o",
- "type" : "Object",
- "desc" : "The data object.",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "arg",
+ "name" : "scope",
"type" : "Object",
- "desc" : "The callback argument object passed to the load function.",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "loadexception",
+ "name" : "resetConstraints",
"type" : "function",
- "desc" : "Fires if an Exception occurs during data retrieval.",
- "sig" : "function (This, o, arg, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "resetConstraints must be called if you manually reposition a dd element.",
+ "sig" : "(maintainOffset)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "This",
- "type" : "Object",
- "desc" : "DataProxy object.",
- "isOptional" : false
- },
- {
- "name" : "o",
- "type" : "Object",
- "desc" : "The data object.",
- "isOptional" : false
- },
- {
- "name" : "arg",
- "type" : "Object",
- "desc" : "The callback argument object passed to the load function.",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Object",
- "desc" : "The Exception.",
+ "name" : "maintainOffset",
+ "type" : "boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "addEvents",
+ "name" : "setDragElId",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "id",
+ "type" : "",
+ "desc" : "{string} the id of the element that will be used to initiate the drag",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "setHandleElId",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "id",
+ "type" : "",
+ "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "setInitPosition",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Stores the initial placement of the linked element.",
+ "sig" : "(diffX, diffY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "diffX",
+ "type" : "int",
+ "desc" : "the X offset, default 0",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "diffY",
+ "type" : "int",
+ "desc" : "the Y offset, default 0",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "setOuterHandleElId",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the element that will be used to initiate the drag",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "setPadding",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
+ "sig" : "(iTop, iRight, iBot, iLeft)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "iTop",
+ "type" : "int",
+ "desc" : "Top pad",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "Right pad",
+ "isOptional" : false
+ },
+ {
+ "name" : "iBot",
+ "type" : "int",
+ "desc" : "Bot pad",
+ "isOptional" : false
+ },
+ {
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "Left pad",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "on",
+ "name" : "setXConstraint",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
+ "sig" : "(iLeft, iRight, iTickSize)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the left",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the\nright",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "setYConstraint",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
+ "sig" : "(iUp, iDown, iTickSize)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "iUp",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move up",
+ "isOptional" : false
+ },
+ {
+ "name" : "iDown",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move down",
+ "isOptional" : false
+ },
+ {
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "startDrag",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
+ "sig" : "(X, Y)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "X",
+ "type" : "int",
+ "desc" : "click location",
+ "isOptional" : false
+ },
+ {
+ "name" : "Y",
+ "type" : "int",
+ "desc" : "click location",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "toString",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "toString method",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
+ "name" : "",
+ "type" : "string",
+ "desc" : "string representation of the dd obj"
}
- ],
- "returns" : []
+ ]
},
{
"name" : "un",
}
],
"returns" : []
- }
- ],
- "isAbstract" : true,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.data.HttpProxy",
- "Roo.data.MemoryProxy"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.DataReader" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "newRow",
+ "name" : "unlock",
"type" : "function",
- "desc" : "Create an empty record",
- "sig" : "(data)",
+ "desc" : "Unlock this instace",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "(optional) - overlay some values",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.data.Record",
- "desc" : "record created."
- }
- ]
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "unreg",
+ "type" : "function",
+ "desc" : "Remove all drag and drop hooks for this element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
}
],
- "isAbstract" : true,
+ "isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [
- "Roo.data.ArrayReader",
- "Roo.data.JsonReader",
- "Roo.data.XmlReader"
+ "Roo.dd.DropTarget",
+ "Roo.dd.DropZone"
],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.data.HttpProxy" : {
+ "Roo.dd.DragDrop" : {
"props" : [
- {
- "name" : "autoAbort",
- "type" : "Boolean",
- "desc" : "Whether this request should abort any pending requests. (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "defaultHeaders",
- "type" : "Object",
- "desc" : "An object containing request headers which are added\n to each request made by this object. (defaults to undefined)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableCaching",
- "type" : "Boolean",
- "desc" : "True to add a unique cache-buster param to GET requests. (defaults to true)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "extraParams",
- "type" : "Object",
- "desc" : "An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
"memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
- },
- {
- "name" : "method",
- "type" : "String",
- "desc" : "T) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GE",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "GET",
- "POST"
- ]
- },
- {
- "name" : "timeout",
- "type" : "Number",
- "desc" : "The timeout in milliseconds to be used for requests. (defaults to 30000)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "url",
- "type" : "String",
- "desc" : "The default URL to be used for requests to the server. (defaults to undefined)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
}
],
- "events" : [
+ "events" : [],
+ "methods" : [
{
- "name" : "beforeload",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Fires before a network request is made to retrieve a data object.",
- "sig" : "function (This, params)\n{\n\n}",
- "memberOf" : "Roo.data.DataProxy",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "This",
- "type" : "Object",
- "desc" : "DataProxy object.",
- "isOptional" : false
- },
- {
- "name" : "params",
+ "name" : "object",
"type" : "Object",
- "desc" : "The params parameter to the load function.",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "load",
+ "name" : "addInvalidHandleClass",
"type" : "function",
- "desc" : "Fires before the load method's callback is called.",
- "sig" : "function (This, o, arg)\n{\n\n}",
- "memberOf" : "Roo.data.DataProxy",
+ "desc" : "Lets you specify a css class of elements that will not initiate a drag",
+ "sig" : "(cssClass)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "This",
- "type" : "Object",
- "desc" : "DataProxy object.",
- "isOptional" : false
- },
- {
- "name" : "o",
- "type" : "Object",
- "desc" : "The data object.",
- "isOptional" : false
- },
- {
- "name" : "arg",
- "type" : "Object",
- "desc" : "The callback argument object passed to the load function.",
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the elements you wish to ignore",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "loadexception",
+ "name" : "addInvalidHandleId",
"type" : "function",
- "desc" : "Fires if an Exception occurs during data retrieval.",
- "sig" : "function (This, o, arg, e)\n{\n\n}",
- "memberOf" : "Roo.data.DataProxy",
+ "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "This",
- "type" : "Object",
- "desc" : "DataProxy object.",
- "isOptional" : false
- },
- {
- "name" : "o",
- "type" : "Object",
- "desc" : "The data object.",
- "isOptional" : false
- },
- {
- "name" : "arg",
- "type" : "Object",
- "desc" : "The callback argument object passed to the load function.",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Object",
- "desc" : "The Exception.",
+ "name" : "id",
+ "type" : "string",
+ "desc" : "the element id of the element you wish to ignore",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "addEvents",
+ "name" : "addInvalidHandleType",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
+ "sig" : "(tagName)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to exclude",
"isOptional" : false
}
],
],
"returns" : []
},
+ {
+ "name" : "addToGroup",
+ "type" : "function",
+ "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
+ "sig" : "(sGroup)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "sGroup",
+ "type" : "",
+ "desc" : "{string} the name of the group",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "applyConfig",
+ "type" : "function",
+ "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "clearConstraints",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "getConnection",
+ "name" : "clearTicks",
"type" : "function",
- "desc" : "Return the {@link Roo.data.Connection} object being used by this Proxy.",
+ "desc" : "Clears any tick interval defined for this instance",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Connection",
- "desc" : "The Connection object. This object may be used to subscribe to events on\na finer-grained basis than the DataProxy events."
- }
- ]
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "endDrag",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Fired when we are done dragging the object",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "load",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Load data from the configured {@link Roo.data.Connection}, read the data object into\na block of Roo.data.Records using the passed {@link Roo.data.DataReader} implementation, and\nprocess that block using the passed callback.",
- "sig" : "(params, reader, callback, scope, arg)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "params",
- "type" : "Object",
- "desc" : "An object containing properties which are to be used as HTTP parameters\nfor the request to the remote server.",
- "isOptional" : false
- },
- {
- "name" : "reader",
- "type" : "Roo.data.DataReader",
- "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "The function into which to pass the block of Roo.data.Records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "The scope in which to call the callback",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "arg",
- "type" : "Object",
- "desc" : "An optional argument which is passed to the callback as its second parameter.",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "on",
+ "name" : "getDragEl",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
- "isOptional" : false
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "the html element"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "purgeListeners",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Returns a reference to the linked element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "the html element"
+ }
+ ]
},
{
- "name" : "releaseCapture",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
"memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "removeListener",
+ "name" : "init",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
+ "sig" : "(id, sGroup, config)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the linked element",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "sGroup",
+ "type" : "String",
+ "desc" : "the group of related items",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "config",
+ "type" : "object",
+ "desc" : "configuration attributes",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "un",
+ "name" : "initTarget",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
+ "sig" : "(id, sGroup, config)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the linked element",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "sGroup",
+ "type" : "String",
+ "desc" : "the group of related items",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "config",
+ "type" : "object",
+ "desc" : "configuration attributes",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.JsonReader" : {
- "props" : [
- {
- "name" : "fields",
- "type" : "Array",
- "desc" : "Array of field definition objects",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "id",
- "type" : "String",
- "desc" : "Name of the property within a row object that contains a record identifier value.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "root",
- "type" : "String",
- "desc" : "name of the property which contains the Array of row objects.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "successProperty",
- "type" : "String",
- "desc" : "Name of the property from which to retrieve the success attribute used by forms.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
},
{
- "name" : "totalProperty",
- "type" : "String",
- "desc" : "Name of the property from which to retrieve the total number of records\nin the dataset. This is only needed if the whole dataset is not passed in one go, but is being\npaged from the remote server.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
- {
- "name" : "newRow",
+ "name" : "isLocked",
"type" : "function",
- "desc" : "Create an empty record",
- "sig" : "(data)",
+ "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.DataReader",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "(optional) - overlay some values",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.data.Record",
- "desc" : "record created."
+ "type" : "boolean",
+ "desc" : "true if this obj or all drag/drop is locked, else\nfalse"
}
]
},
{
- "name" : "read",
+ "name" : "isTarget",
"type" : "function",
- "desc" : "This method is only used by a DataProxy which has retrieved data from a remote server.",
- "sig" : "(response)",
+ "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "response",
- "type" : "Object",
- "desc" : "The XHR object which contains the JSON data in its responseText.",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "data A data block which is used by an Roo.data.Store object as\na cache of Roo.data.Records."
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "readRecords",
+ "name" : "isValidHandleChild",
"type" : "function",
- "desc" : "Create a data block containing Roo.data.Records from an XML document.",
- "sig" : "(o)",
+ "desc" : "Checks the tag exclusion list to see if this click should be ignored",
+ "sig" : "(node)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Object",
- "desc" : "An object which contains an Array of row objects in the property specified\nin the config as 'root, and optionally a property, specified in the config as 'totalProperty'\nwhich contains the total size of the dataset.",
+ "name" : "node",
+ "type" : "HTMLElement",
+ "desc" : "the HTMLElement to evaluate",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "data A data block which is used by an Roo.data.Store object as\na cache of Roo.data.Records."
+ "type" : "boolean",
+ "desc" : "true if this is a valid tag type, false if not"
}
]
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.JsonStore" : {
- "props" : [
- {
- "name" : "baseParams",
- "type" : "Object",
- "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request",
- "memberOf" : "Roo.data.Store",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "data",
- "type" : "Array",
- "desc" : "Inline data to be loaded when the store is initialized.",
- "memberOf" : "Roo.data.Store",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fields",
- "type" : "Array",
- "desc" : "An array of field definition objects, or field name strings.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "isLocal",
- "type" : "boolean",
- "desc" : "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
- "memberOf" : "Roo.data.Store",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "multiSort",
- "type" : "Boolean",
- "desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)",
- "memberOf" : "Roo.data.Store",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "proxy",
- "type" : "Roo.data.DataProxy",
- "desc" : "The Proxy object which provides access to a data object.",
- "memberOf" : "Roo.data.Store",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "pruneModifiedRecords",
- "type" : "boolean",
- "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
- "memberOf" : "Roo.data.Store",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "reader",
- "type" : "Roo.data.DataReader",
- "desc" : "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.",
- "memberOf" : "Roo.data.Store",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "remoteSort",
- "type" : "boolean",
- "desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
- "memberOf" : "Roo.data.Store",
- "isOptional" : false,
- "optvals" : []
},
{
- "name" : "sortInfo",
- "type" : "Object",
- "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
- "memberOf" : "Roo.data.Store",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "add",
+ "name" : "lock",
"type" : "function",
- "desc" : "Fires when Records have been added to the Store",
- "sig" : "function (_self, records, index)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Lock this instance",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Store",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "The array of Records added",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index at which the record(s) were added",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "beforeload",
+ "name" : "on",
"type" : "function",
- "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.",
- "sig" : "function (_self, options)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "The loading options that were specified (see {@link #load} for details)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeloadadd",
- "type" : "function",
- "desc" : "Fires after a new set of Records has been loaded.",
- "sig" : "function (_self, records, options)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "The Records that were loaded",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
},
{
"name" : "options",
"type" : "Object",
- "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "clear",
+ "name" : "onAvailable",
"type" : "function",
- "desc" : "Fires when the data cache has been cleared.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Store",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "datachanged",
+ "name" : "onDrag",
"type" : "function",
- "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "load",
+ "name" : "onDragDrop",
"type" : "function",
- "desc" : "Fires after a new set of Records has been loaded, before they are added to the store.",
- "sig" : "function (_self, records, options)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "The Records that were loaded",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "loadexception",
+ "name" : "onDragEnter",
"type" : "function",
- "desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args",
- "sig" : "function (, ret, opts, jsonData)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "",
- "type" : "Proxy",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "ret",
- "type" : "Object",
- "desc" : "return data from JsonData.reader() - success, totalRecords, records",
- "isOptional" : false
- },
- {
- "name" : "opts",
- "type" : "Object",
- "desc" : "- load Options",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
},
{
- "name" : "jsonData",
- "type" : "Object",
- "desc" : "from your request (normally this contains the Exception)",
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "metachange",
+ "name" : "onDragOut",
"type" : "function",
- "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.",
- "sig" : "function (_self, meta)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Abstract method called when we are no longer hovering over an element",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
},
{
- "name" : "meta",
- "type" : "Object",
- "desc" : "The JSON metadata",
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "onDragOver",
"type" : "function",
- "desc" : "Fires when a Record has been removed from the Store",
- "sig" : "function (_self, record, index)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The Record that was removed",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
},
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The index at which the record was removed",
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "update",
+ "name" : "onInvalidDrop",
"type" : "function",
- "desc" : "Fires when a Record has been updated",
- "sig" : "function (_self, record, operation)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The Record that was updated",
- "isOptional" : false
- },
- {
- "name" : "operation",
- "type" : "String",
- "desc" : "The update operation being performed. Value may be one of:\n<pre><code>\n Roo.data.Record.EDIT\n Roo.data.Record.REJECT\n Roo.data.Record.COMMIT\n</code></pre>",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "add",
+ "name" : "onMouseDown",
"type" : "function",
- "desc" : "Add Records to the Store and fires the add event.",
- "sig" : "(records)",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "An Array of Roo.data.Record objects to add to the cache.",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousedown event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addEvents",
+ "name" : "onMouseUp",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "padding",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
"static" : true,
"memberOf" : "Roo.util.Observable",
"isStatic" : true,
{
"name" : "o",
"type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "clearFilter",
+ "name" : "removeFromGroup",
"type" : "function",
- "desc" : "Revert to a view of the Record cache with no filtering applied.",
- "sig" : "(suppressEvent)",
+ "desc" : "Remove's this instance from the supplied interaction group",
+ "sig" : "(sGroup)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "suppressEvent",
- "type" : "Boolean",
- "desc" : "If true the filter is cleared silently without notifying listeners",
+ "name" : "sGroup",
+ "type" : "string",
+ "desc" : "The group to drop",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "collect",
+ "name" : "removeInvalidHandleClass",
"type" : "function",
- "desc" : "Collects unique values for a particular dataIndex from this store.",
- "sig" : "(dataIndex, allowNull, bypassFilter)",
+ "desc" : "Unsets an invalid css class",
+ "sig" : "(cssClass)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "dataIndex",
- "type" : "String",
- "desc" : "The property to collect",
- "isOptional" : false
- },
- {
- "name" : "allowNull",
- "type" : "Boolean",
- "desc" : "(optional) Pass true to allow null, undefined or empty string values",
- "isOptional" : false
- },
- {
- "name" : "bypassFilter",
- "type" : "Boolean",
- "desc" : "(optional) Pass true to collect from all records, even ones which are filtered",
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the element(s) you wish to\nre-enable",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Array",
- "desc" : "An array of the unique values"
- }
- ]
+ "returns" : []
},
{
- "name" : "commitChanges",
+ "name" : "removeInvalidHandleId",
"type" : "function",
- "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Unsets an invalid handle id",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "string",
+ "desc" : "the id of the element to re-enable",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "each",
+ "name" : "removeInvalidHandleType",
"type" : "function",
- "desc" : "Calls the specified function for each of the Records in the cache.",
- "sig" : "(fn, scope)",
+ "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
+ "sig" : "(tagName)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call. The Record is passed as the first parameter.\nReturning <em>false</em> aborts and exits the iteration.",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to call the function (defaults to the Record).",
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to unexclude",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "filter",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Filter the records by a specified property.",
- "sig" : "(field, value, anyMatch)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "field",
+ "name" : "eventName",
"type" : "String",
- "desc" : "A field on your records",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "value",
- "type" : "String/RegExp",
- "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "anyMatch",
- "type" : "Boolean",
- "desc" : "True to match any part not just the beginning",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "filterBy",
+ "name" : "resetConstraints",
"type" : "function",
- "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.",
- "sig" : "(fn, scope)",
+ "desc" : "resetConstraints must be called if you manually reposition a dd element.",
+ "sig" : "(maintainOffset)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to be called, it will receive 2 args (record, id)",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to this)",
+ "name" : "maintainOffset",
+ "type" : "boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "setDragElId",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "id",
+ "type" : "",
+ "desc" : "{string} the id of the element that will be used to initiate the drag",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
},
{
- "name" : "getAt",
+ "name" : "setHandleElId",
"type" : "function",
- "desc" : "Get the Record at the specified index.",
- "sig" : "(index)",
+ "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the Record to find.",
+ "name" : "id",
+ "type" : "",
+ "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "setInitPosition",
+ "type" : "function",
+ "desc" : "Stores the initial placement of the linked element.",
+ "sig" : "(diffX, diffY)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.data.Record",
- "desc" : "The Record at the passed index. Returns undefined if not found."
+ "name" : "diffX",
+ "type" : "int",
+ "desc" : "the X offset, default 0",
+ "isOptional" : false
+ },
+ {
+ "name" : "diffY",
+ "type" : "int",
+ "desc" : "the Y offset, default 0",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getById",
+ "name" : "setOuterHandleElId",
"type" : "function",
- "desc" : "Get the Record with the specified id.",
+ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
"sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [
{
"name" : "id",
- "type" : "String",
- "desc" : "The id of the Record to find.",
+ "type" : "",
+ "desc" : "the id of the element that will be used to initiate the drag",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.data.Record",
- "desc" : "The Record with the passed id. Returns undefined if not found."
- }
- ]
+ "returns" : []
},
{
- "name" : "getCount",
+ "name" : "setPadding",
"type" : "function",
- "desc" : "Gets the number of cached records.\n<p>\n<em>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size</em>",
- "sig" : "()\n{\n\n}",
+ "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
+ "sig" : "(iTop, iRight, iBot, iLeft)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "iTop",
+ "type" : "int",
+ "desc" : "Top pad",
+ "isOptional" : false
+ },
+ {
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "Right pad",
+ "isOptional" : false
+ },
+ {
+ "name" : "iBot",
+ "type" : "int",
+ "desc" : "Bot pad",
+ "isOptional" : false
+ },
+ {
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "Left pad",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "getModifiedRecords",
+ "name" : "setXConstraint",
"type" : "function",
- "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).",
- "sig" : "()\n{\n\n}",
+ "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
+ "sig" : "(iLeft, iRight, iTickSize)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.data.Record[]",
- "desc" : "An array of Records containing outstanding modifications."
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the left",
+ "isOptional" : false
+ },
+ {
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the\nright",
+ "isOptional" : false
+ },
+ {
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getRange",
+ "name" : "setYConstraint",
"type" : "function",
- "desc" : "Returns a range of Records between specified indices.",
- "sig" : "(startIndex, endIndex)",
+ "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
+ "sig" : "(iUp, iDown, iTickSize)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "startIndex",
- "type" : "Number",
- "desc" : "(optional) The starting index (defaults to 0)",
+ "name" : "iUp",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move up",
"isOptional" : false
},
{
- "name" : "endIndex",
- "type" : "Number",
- "desc" : "(optional) The ending index (defaults to the last Record in the Store)",
+ "name" : "iDown",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move down",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.data.Record[]",
- "desc" : "An array of Records"
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getSortState",
+ "name" : "startDrag",
"type" : "function",
- "desc" : "Returns the sort state of the Store as an object with two properties:\n<pre><code>\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n</code></pre>",
- "sig" : "()\n{\n\n}",
+ "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
+ "sig" : "(X, Y)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "X",
+ "type" : "int",
+ "desc" : "click location",
+ "isOptional" : false
+ },
+ {
+ "name" : "Y",
+ "type" : "int",
+ "desc" : "click location",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "getTotalCount",
+ "name" : "toString",
"type" : "function",
- "desc" : "Gets the total number of records in the dataset as returned by the server.\n<p>\n<em>If using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size</em>",
+ "desc" : "toString method",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "string",
+ "desc" : "string representation of the dd obj"
+ }
+ ]
},
{
- "name" : "hasListener",
+ "name" : "un",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The name of the event to check for",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "indexOf",
+ "name" : "unlock",
"type" : "function",
- "desc" : "Get the index within the cache of the passed Record.",
- "sig" : "(record)",
+ "desc" : "Unlock this instace",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The Roo.data.Record object to to find.",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "The index of the passed Record. Returns -1 if not found."
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "indexOfId",
+ "name" : "unreg",
"type" : "function",
- "desc" : "Get the index within the cache of the Record with the passed id.",
- "sig" : "(id)",
+ "desc" : "Remove all drag and drop hooks for this element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the Record to find.",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "The index of the Record. Returns -1 if not found."
- }
- ]
+ "params" : [],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.dd.DD",
+ "Roo.dd.DDProxy",
+ "Roo.dd.DDTarget",
+ "Roo.dd.DragSource",
+ "Roo.dd.DragZone",
+ "Roo.dd.DropTarget",
+ "Roo.dd.DropZone",
+ "Roo.grid.SplitDragZone"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.dd.DragSource" : {
+ "props" : [
+ {
+ "name" : "dropAllowed",
+ "type" : "String",
+ "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "insert",
+ "name" : "dropNotAllowed",
+ "type" : "String",
+ "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Inserts Records to the Store at the given index and fires the add event.",
- "sig" : "(index, records)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The start index at which to insert the passed Records.",
- "isOptional" : false
- },
- {
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "An Array of Roo.data.Record objects to add to the cache.",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "load",
+ "name" : "addInvalidHandleClass",
"type" : "function",
- "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n<p>\nIf using remote paging, then the first load call must specify the <em>start</em>\nand <em>limit</em> properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n<p>\n<strong>It is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.</strong>\n<p>",
- "sig" : "(options)",
+ "desc" : "Lets you specify a css class of elements that will not initiate a drag",
+ "sig" : "(cssClass)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "An object containing properties which control loading options:<ul>\n<li>params {Object} An object containing properties to pass as HTTP parameters to a remote data source.</li>\n<li>params.data {Object} if you are using a MemoryProxy / JsonReader, use this as the data to load stuff..\n<pre>\n {\n data : data, // array of key=>value data like JsonReader\n total : data.length,\n success : true\n \n }\n </pre>\n }.</li>\n<li>callback {Function} A function to be called after the Records have been loaded. The callback is\npassed the following arguments:<ul>\n<li>r : Roo.data.Record[]</li>\n<li>options: Options object from the load call</li>\n<li>success: Boolean success indicator</li></ul></li>\n<li>scope {Object} Scope with which to call the callback (defaults to the Store object)</li>\n<li>add {Boolean} indicator to append loaded records rather than replace the current cache.</li>\n</ul>",
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the elements you wish to ignore",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "loadData",
+ "name" : "addInvalidHandleId",
"type" : "function",
- "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.",
- "sig" : "(data, append)",
+ "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "data",
- "type" : "Object",
- "desc" : "The data block from which to read the Records. The format of the data expected\nis dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.",
- "isOptional" : false
- },
- {
- "name" : "append",
- "type" : "Boolean",
- "desc" : "True to append the new Records rather than replace the existing cache.",
+ "name" : "id",
+ "type" : "string",
+ "desc" : "the element id of the element you wish to ignore",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "loadDataFromChildren",
+ "name" : "addInvalidHandleType",
"type" : "function",
- "desc" : "using 'cn' the nested child reader read the child array into it's child stores.",
- "sig" : "(rec)",
+ "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
+ "sig" : "(tagName)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "rec",
- "type" : "Object",
- "desc" : "The record with a 'children array",
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to exclude",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "on",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "desc" : "Appends an event handler to this component",
"sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
{
"name" : "options",
"type" : "Object",
- "desc" : "(optional)",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "addToGroup",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
+ "sig" : "(sGroup)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "sGroup",
+ "type" : "",
+ "desc" : "{string} the name of the group",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "query",
+ "name" : "afterDragDrop",
"type" : "function",
- "desc" : "Query the records by a specified property.",
- "sig" : "(field, value, anyMatch)",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter a valid drag drop has occurred by providing an implementation.",
+ "sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "field",
- "type" : "String",
- "desc" : "A field on your records",
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
"isOptional" : false
},
{
- "name" : "value",
- "type" : "String/RegExp",
- "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
"isOptional" : false
},
{
- "name" : "anyMatch",
- "type" : "Boolean",
- "desc" : "True to match any part not just the beginning",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dropped element",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "MixedCollection",
- "desc" : "Returns an Roo.util.MixedCollection of the matched records"
- }
- ]
+ "returns" : []
},
{
- "name" : "queryBy",
+ "name" : "afterDragEnter",
"type" : "function",
- "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.",
- "sig" : "(fn, scope)",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhen the dragged item enters the drop target by providing an implementation.",
+ "sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to be called, it will receive 2 args (record, id)",
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to this)",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "MixedCollection",
- "desc" : "Returns an Roo.util.MixedCollection of the matched records"
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "rejectChanges",
+ "name" : "afterDragOut",
"type" : "function",
- "desc" : "Cancel outstanding changes on all changed records.",
- "sig" : "()\n{\n\n}",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter the dragged item is dragged out of the target without dropping.",
+ "sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "reload",
+ "name" : "afterDragOver",
"type" : "function",
- "desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.",
- "sig" : "(options)",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhile the dragged item is over the drop target by providing an implementation.",
+ "sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing properties which may override the options\nused in the last load operation. See {@link #load} for details (defaults to null, in which case\nthe most recently used options are reused).",
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "afterInvalidDrop",
"type" : "function",
- "desc" : "Remove a Record from the Store and fires the remove event.",
- "sig" : "(record)",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter an invalid drop has occurred by providing an implementation.",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "record",
- "type" : "Ext.data.Record",
- "desc" : "The Roo.data.Record object to remove from the cache.",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dropped element",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeAll",
+ "name" : "afterValidDrop",
"type" : "function",
- "desc" : "Remove all Records from the Store and fires the clear event.",
- "sig" : "()\n{\n\n}",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter a valid drop has occurred by providing an implementation.",
+ "sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "Object",
+ "desc" : "The target DD",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dropped element",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "alignElWithMouse",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
+ "sig" : "(el, iPageX, iPageY)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "el",
+ "type" : "HTMLElement",
+ "desc" : "the element to move",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the mousedown or drag event",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the mousedown or drag event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDefaultSort",
+ "name" : "applyConfig",
"type" : "function",
- "desc" : "Sets the default sort column and order to be used by the next load operation.",
- "sig" : "(fieldName, dir)",
+ "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "fieldName",
- "type" : "String",
- "desc" : "The name of the field to sort by.",
- "isOptional" : false
- },
- {
- "name" : "dir",
- "type" : "String",
- "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "sort",
+ "name" : "autoOffset",
"type" : "function",
- "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.",
- "sig" : "(fieldName, dir)",
+ "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked",
+ "sig" : "(iPageX, iPageY)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fieldName",
- "type" : "String",
- "desc" : "The name of the field to sort by.",
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the click",
"isOptional" : false
},
{
- "name" : "dir",
- "type" : "String",
- "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the click",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "sum",
+ "name" : "beforeDragDrop",
"type" : "function",
- "desc" : "Sums the value of <i>property</i> for each record between start and end and returns the result.",
- "sig" : "(property, start, end)",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dropped onto the target and optionally cancel the onDragDrop.",
+ "sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "property",
- "type" : "String",
- "desc" : "A field on your records",
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
"isOptional" : false
},
{
- "name" : "start",
- "type" : "Number",
- "desc" : "The record index to start at (defaults to 0)",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
"isOptional" : false
},
{
- "name" : "end",
- "type" : "Number",
- "desc" : "The last record index to include (defaults to length - 1)",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "The sum"
+ "type" : "Boolean",
+ "desc" : "isValid True if the drag drop event is valid, else false to cancel"
}
]
},
{
- "name" : "un",
+ "name" : "beforeDragEnter",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nbefore the dragged item enters the drop target and optionally cancel the onDragEnter.",
+ "sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.MemoryProxy" : {
- "props" : [
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "The data object which the Reader uses to construct a block of Roo.data.Records.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "beforeload",
- "type" : "function",
- "desc" : "Fires before a network request is made to retrieve a data object.",
- "sig" : "function (This, params)\n{\n\n}",
- "memberOf" : "Roo.data.DataProxy",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "This",
- "type" : "Object",
- "desc" : "DataProxy object.",
- "isOptional" : false
- },
+ "returns" : [
{
- "name" : "params",
- "type" : "Object",
- "desc" : "The params parameter to the load function.",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "isValid True if the drag event is valid, else false to cancel"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "load",
+ "name" : "beforeDragOut",
"type" : "function",
- "desc" : "Fires before the load method's callback is called.",
- "sig" : "function (This, o, arg)\n{\n\n}",
- "memberOf" : "Roo.data.DataProxy",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dragged out of the target without dropping, and optionally cancel the onDragOut.",
+ "sig" : "(target, e, id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "This",
- "type" : "Object",
- "desc" : "DataProxy object.",
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
"isOptional" : false
},
{
- "name" : "o",
- "type" : "Object",
- "desc" : "The data object.",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
"isOptional" : false
},
{
- "name" : "arg",
- "type" : "Object",
- "desc" : "The callback argument object passed to the load function.",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "isValid True if the drag event is valid, else false to cancel"
+ }
+ ]
},
{
- "name" : "loadexception",
+ "name" : "beforeDragOver",
"type" : "function",
- "desc" : "Fires if an Exception occurs during data retrieval.",
- "sig" : "function (This, o, arg, e)\n{\n\n}",
- "memberOf" : "Roo.data.DataProxy",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhile the dragged item is over the drop target and optionally cancel the onDragOver.",
+ "sig" : "(target, e, id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "This",
- "type" : "Object",
- "desc" : "DataProxy object.",
- "isOptional" : false
- },
- {
- "name" : "o",
- "type" : "Object",
- "desc" : "The data object.",
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
"isOptional" : false
},
{
- "name" : "arg",
- "type" : "Object",
- "desc" : "The callback argument object passed to the load function.",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Object",
- "desc" : "The Exception.",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "methods" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "isValid True if the drag event is valid, else false to cancel"
+ }
+ ]
+ },
{
- "name" : "addEvents",
+ "name" : "beforeInvalidDrop",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action after an invalid\ndrop has occurred.",
+ "sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "isValid True if the invalid drop should proceed, else false to cancel"
+ }
+ ]
},
{
- "name" : "addListener",
+ "name" : "cachePosition",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.",
+ "sig" : "(iPageX, iPageY)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "iPageX",
+ "type" : "",
+ "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "iPageY",
+ "type" : "",
+ "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "clearConstraints",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "clearTicks",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Clears any tick interval defined for this instance",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "load",
+ "name" : "createFrame",
"type" : "function",
- "desc" : "Load data from the requested source (in this case an in-memory\ndata object passed to the constructor), read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback.",
- "sig" : "(params, reader, callback, scope, arg)",
+ "desc" : "Creates the proxy element if it does not yet exist",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DDProxy",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "endDrag",
+ "type" : "function",
+ "desc" : "Fired when we are done dragging the object",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "params",
- "type" : "Object",
- "desc" : "This parameter is not used by the MemoryProxy class.",
- "isOptional" : false
- },
- {
- "name" : "reader",
- "type" : "Roo.data.DataReader",
- "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "The function into which to pass the block of Roo.data.records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "The scope in which to call the callback",
- "isOptional" : false
- },
- {
- "name" : "arg",
- "type" : "Object",
- "desc" : "An optional argument which is passed to the callback as its second parameter.",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "on",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The type of event to listen for",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
+ },
+ {
+ "name" : "getDragData",
+ "type" : "function",
+ "desc" : "Returns the data object associated with this drag source",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "options",
+ "name" : "",
"type" : "Object",
- "desc" : "(optional)",
- "isOptional" : false
+ "desc" : "data An object containing arbitrary data"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "purgeListeners",
+ "name" : "getDragEl",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "the html element"
+ }
+ ]
},
{
- "name" : "releaseCapture",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Returns a reference to the linked element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "the html element"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "removeListener",
+ "name" : "getProxy",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Returns the drag source's underlying {@link Roo.dd.StatusProxy}",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.dd.StatusProxy",
+ "desc" : "proxy The StatusProxy"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "un",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.Node" : {
- "props" : [
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The id for this node. If one is not specified, one is generated.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "leaf",
- "type" : "Boolean",
- "desc" : "true if this node is a leaf and does not have children",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "append",
- "type" : "function",
- "desc" : "Fires when a new child node is appended",
- "sig" : "function (tree, _self, node, index)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "this",
- "type" : "Node",
- "desc" : "This node",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "The newly appended node",
- "isOptional" : false
- },
+ "returns" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the newly appended node",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "beforeappend",
+ "name" : "hideProxy",
"type" : "function",
- "desc" : "Fires before a new child is appended, return false to cancel the append.",
- "sig" : "function (tree, _self, node)\n{\n\n}",
+ "desc" : "Hides the drag source's {@link Roo.dd.StatusProxy}",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "this",
- "type" : "Node",
- "desc" : "This node",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node to be appended",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "beforeinsert",
+ "name" : "init",
"type" : "function",
- "desc" : "Fires before a new child is inserted, return false to cancel the insert.",
- "sig" : "function (tree, _self, node, refNode)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
+ "sig" : "(id, sGroup, config)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "this",
- "type" : "Node",
- "desc" : "This node",
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the linked element",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node to be inserted",
+ "name" : "sGroup",
+ "type" : "String",
+ "desc" : "the group of related items",
"isOptional" : false
},
{
- "name" : "refNode",
- "type" : "Node",
- "desc" : "The child node the node is being inserted before",
+ "name" : "config",
+ "type" : "object",
+ "desc" : "configuration attributes",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforemove",
+ "name" : "initFrame",
"type" : "function",
- "desc" : "Fires before this node is moved to a new location in the tree. Return false to cancel the move.",
- "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DDProxy",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "this",
- "type" : "Node",
- "desc" : "This node",
- "isOptional" : false
- },
- {
- "name" : "oldParent",
- "type" : "Node",
- "desc" : "The parent of this node",
- "isOptional" : false
- },
- {
- "name" : "newParent",
- "type" : "Node",
- "desc" : "The new parent this node is moving to",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index it is being moved to",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "beforeremove",
+ "name" : "initTarget",
"type" : "function",
- "desc" : "Fires before a child is removed, return false to cancel the remove.",
- "sig" : "function (tree, _self, node)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
+ "sig" : "(id, sGroup, config)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the linked element",
"isOptional" : false
},
{
- "name" : "this",
- "type" : "Node",
- "desc" : "This node",
+ "name" : "sGroup",
+ "type" : "String",
+ "desc" : "the group of related items",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node to be removed",
+ "name" : "config",
+ "type" : "object",
+ "desc" : "configuration attributes",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "insert",
+ "name" : "isLocked",
"type" : "function",
- "desc" : "Fires when a new child node is inserted.",
- "sig" : "function (tree, _self, node, refNode)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "this",
- "type" : "Node",
- "desc" : "This node",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node inserted",
- "isOptional" : false
- },
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "refNode",
- "type" : "Node",
- "desc" : "The child node the node was inserted before",
- "isOptional" : false
+ "name" : "",
+ "type" : "boolean",
+ "desc" : "true if this obj or all drag/drop is locked, else\nfalse"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "move",
+ "name" : "isTarget",
"type" : "function",
- "desc" : "Fires when this node is moved to a new location in the tree",
- "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "this",
- "type" : "Node",
- "desc" : "This node",
- "isOptional" : false
- },
- {
- "name" : "oldParent",
- "type" : "Node",
- "desc" : "The old parent of this node",
- "isOptional" : false
- },
- {
- "name" : "newParent",
- "type" : "Node",
- "desc" : "The new parent of this node",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index it was moved to",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "isValidHandleChild",
"type" : "function",
- "desc" : "Fires when a child node is removed",
- "sig" : "function (tree, _self, node)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Checks the tag exclusion list to see if this click should be ignored",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
- {
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "this",
- "type" : "Node",
- "desc" : "This node",
- "isOptional" : false
- },
{
"name" : "node",
- "type" : "Node",
- "desc" : "The removed node",
+ "type" : "HTMLElement",
+ "desc" : "the HTMLElement to evaluate",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "methods" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "boolean",
+ "desc" : "true if this is a valid tag type, false if not"
+ }
+ ]
+ },
{
- "name" : "addEvents",
+ "name" : "lock",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Lock this instance",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "on",
"type" : "function",
- "desc" : "Appends an event handler to this component",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
"sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
{
"name" : "options",
"type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "appendChild",
+ "name" : "onAvailable",
"type" : "function",
- "desc" : "Insert node(s) as the last child node of this node.",
- "sig" : "(node)",
+ "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "onBeforeDrag",
+ "type" : "function",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action before the initial\ndrag event begins and optionally cancel it.",
+ "sig" : "(data, e)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "Node/Array",
- "desc" : "The node or Array of nodes to append",
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data to be shared with drop targets",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Node",
- "desc" : "The appended node if single append, or null if an array was passed"
+ "type" : "Boolean",
+ "desc" : "isValid True if the drag event is valid, else false to cancel"
}
]
},
{
- "name" : "bubble",
+ "name" : "onDrag",
"type" : "function",
- "desc" : "Bubbles up the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe bubble is stopped.",
- "sig" : "(fn, scope, args)",
+ "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to current node)",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Array",
- "desc" : "(optional) The args to call the function with (default to passing the current node)",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "onDragDrop",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "cascade",
+ "name" : "onDragEnter",
"type" : "function",
- "desc" : "Cascades down the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe cascade is stopped on that branch.",
- "sig" : "(fn, scope, args)",
+ "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to current node)",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Array",
- "desc" : "(optional) The args to call the function with (default to passing the current node)",
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "contains",
+ "name" : "onDragOut",
"type" : "function",
- "desc" : "Returns true if this node is an ancestor (at any point) of the passed node.",
- "sig" : "(node)",
+ "desc" : "Abstract method called when we are no longer hovering over an element",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "Node",
- "desc" : "",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "eachChild",
+ "name" : "onDragOver",
"type" : "function",
- "desc" : "Interates the child nodes of this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe iteration stops.",
- "sig" : "(fn, scope, args)",
+ "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to current node)",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Array",
- "desc" : "(optional) The args to call the function with (default to passing the current node)",
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "findChild",
+ "name" : "onInvalidDrop",
"type" : "function",
- "desc" : "Finds the first child that has the attribute with the specified value.",
- "sig" : "(attribute, value)",
+ "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "attribute",
- "type" : "String",
- "desc" : "The attribute name",
- "isOptional" : false
- },
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to search for",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Node",
- "desc" : "The found child or null if none was found"
- }
- ]
+ "returns" : []
},
{
- "name" : "findChildBy",
+ "name" : "onMouseDown",
"type" : "function",
- "desc" : "Finds the first child by a custom function. The child matches if the function passed\nreturns true.",
- "sig" : "(fn, scope)",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousedown event",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "onMouseUp",
+ "type" : "function",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Node",
- "desc" : "The found child or null if none was found"
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "onStartDrag",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action once the initial\ndrag event has begun. The drag cannot be canceled from this function.",
+ "sig" : "(x, y)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The x position of the click on the dragged object",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The y position of the click on the dragged object",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
},
{
- "name" : "getDepth",
+ "name" : "padding",
"type" : "function",
- "desc" : "Returns depth of this node (the root node has a depth of 0)",
+ "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getOwnerTree",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Returns the tree this node is in.",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Tree",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getPath",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Returns the path for this node. The path can be used to expand or select this node programmatically.",
- "sig" : "(attr)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "attr",
- "type" : "String",
- "desc" : "(optional) The attr to use for the path (defaults to the node's id)",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "The path"
- }
- ]
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "removeFromGroup",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Remove's this instance from the supplied interaction group",
+ "sig" : "(sGroup)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "sGroup",
+ "type" : "string",
+ "desc" : "The group to drop",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "indexOf",
+ "name" : "removeInvalidHandleClass",
"type" : "function",
- "desc" : "Returns the index of a child node",
- "sig" : "(node)",
+ "desc" : "Unsets an invalid css class",
+ "sig" : "(cssClass)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "Node",
- "desc" : "",
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the element(s) you wish to\nre-enable",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "The index of the node or -1 if it was not found"
- }
- ]
+ "returns" : []
},
{
- "name" : "insertBefore",
+ "name" : "removeInvalidHandleId",
"type" : "function",
- "desc" : "Inserts the first node before the second node in this nodes childNodes collection.",
- "sig" : "(node, refNode)",
+ "desc" : "Unsets an invalid handle id",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The node to insert",
- "isOptional" : false
- },
- {
- "name" : "refNode",
- "type" : "Node",
- "desc" : "The node to insert before (if null the node is appended)",
+ "name" : "id",
+ "type" : "string",
+ "desc" : "the id of the element to re-enable",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Node",
- "desc" : "The inserted node"
- }
- ]
+ "returns" : []
},
{
- "name" : "isAncestor",
+ "name" : "removeInvalidHandleType",
"type" : "function",
- "desc" : "Returns true if the passed node is an ancestor (at any point) of this node.",
- "sig" : "(node)",
+ "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
+ "sig" : "(tagName)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "Node",
- "desc" : "",
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to unexclude",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "isFirst",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Returns true if this node is the first child of its parent",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "isLast",
+ "name" : "resetConstraints",
"type" : "function",
- "desc" : "Returns true if this node is the last child of its parent",
- "sig" : "()\n{\n\n}",
+ "desc" : "resetConstraints must be called if you manually reposition a dd element.",
+ "sig" : "(maintainOffset)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "name" : "maintainOffset",
+ "type" : "boolean",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "isLeaf",
+ "name" : "setDelta",
"type" : "function",
- "desc" : "Returns true if this node is a leaf",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)",
+ "sig" : "(iDeltaX, iDeltaY)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "name" : "iDeltaX",
+ "type" : "int",
+ "desc" : "the distance from the left",
+ "isOptional" : false
+ },
+ {
+ "name" : "iDeltaY",
+ "type" : "int",
+ "desc" : "the distance from the top",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "item",
+ "name" : "setDragElId",
"type" : "function",
- "desc" : "Returns the child node at the specified index.",
- "sig" : "(index)",
+ "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "",
+ "name" : "id",
+ "type" : "",
+ "desc" : "{string} the id of the element that will be used to initiate the drag",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Node",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "on",
+ "name" : "setDragElPos",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
+ "sig" : "(iPageX, iPageY)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the mousedown or drag event",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the mousedown or drag event",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setHandleElId",
+ "type" : "function",
+ "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "id",
+ "type" : "",
+ "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "setInitPosition",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Stores the initial placement of the linked element.",
+ "sig" : "(diffX, diffY)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "diffX",
+ "type" : "int",
+ "desc" : "the X offset, default 0",
+ "isOptional" : false
+ },
+ {
+ "name" : "diffY",
+ "type" : "int",
+ "desc" : "the Y offset, default 0",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "setOuterHandleElId",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the element that will be used to initiate the drag",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeChild",
+ "name" : "setPadding",
"type" : "function",
- "desc" : "Removes a child node from this node.",
- "sig" : "(node)",
+ "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
+ "sig" : "(iTop, iRight, iBot, iLeft)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The node to remove",
+ "name" : "iTop",
+ "type" : "int",
+ "desc" : "Top pad",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Node",
- "desc" : "The removed node"
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "Right pad",
+ "isOptional" : false
+ },
+ {
+ "name" : "iBot",
+ "type" : "int",
+ "desc" : "Bot pad",
+ "isOptional" : false
+ },
+ {
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "Left pad",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "removeListener",
+ "name" : "setXConstraint",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
+ "sig" : "(iLeft, iRight, iTickSize)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the left",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the\nright",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "replaceChild",
+ "name" : "setYConstraint",
"type" : "function",
- "desc" : "Replaces one child node in this node with another.",
- "sig" : "(newChild, oldChild)",
+ "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
+ "sig" : "(iUp, iDown, iTickSize)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "newChild",
- "type" : "Node",
- "desc" : "The replacement node",
+ "name" : "iUp",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move up",
"isOptional" : false
},
{
- "name" : "oldChild",
- "type" : "Node",
- "desc" : "The node to replace",
+ "name" : "iDown",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move down",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Node",
- "desc" : "The replaced node"
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "sort",
+ "name" : "startDrag",
"type" : "function",
- "desc" : "Sorts this nodes children using the supplied sort function",
- "sig" : "(fn, scope)",
+ "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
+ "sig" : "(X, Y)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "",
+ "name" : "X",
+ "type" : "int",
+ "desc" : "click location",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "Y",
+ "type" : "int",
+ "desc" : "click location",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "toString",
+ "type" : "function",
+ "desc" : "toString method",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "string",
+ "desc" : "string representation of the dd obj"
+ }
+ ]
+ },
{
"name" : "un",
"type" : "function",
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.tree.AsyncTreeNode",
- "Roo.tree.TreeNode"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.Record" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "commit",
+ "name" : "unlock",
"type" : "function",
- "desc" : "Usually called by the {@link Roo.data.Store} which owns the Record.\nCommits all changes made to the Record since either creation, or the last commit operation.\n<p>\nDevelopers should subscribe to the {@link Roo.data.Store#update} event to have their code notified\nof commit operations.",
+ "desc" : "Unlock this instace",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "copy",
+ "name" : "unreg",
"type" : "function",
- "desc" : "Creates a copy of this record.",
- "sig" : "(id)",
+ "desc" : "Remove all drag and drop hooks for this element",
+ "sig" : "()\n{\n\n}",
"static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.dd.DragZone"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.dd.DragZone" : {
+ "props" : [
+ {
+ "name" : "containerScroll",
+ "type" : "Boolean",
+ "desc" : "True to register this container with the Scrollmanager\nfor auto scrolling during drag operations.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dropAllowed",
+ "type" : "String",
+ "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
+ "memberOf" : "Roo.dd.DragSource",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dropNotAllowed",
+ "type" : "String",
+ "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
+ "memberOf" : "Roo.dd.DragSource",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hlColor",
+ "type" : "String",
+ "desc" : "The color to use when visually highlighting the drag source in the afterRepair\nmethod after a failed drop (defaults to \"c3daf9\" - light blue)",
"memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String",
- "desc" : "(optional) A new record id if you don't want to use this record's id",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Record",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "create",
+ "name" : "addInvalidHandleClass",
"type" : "function",
- "desc" : "Generate a constructor for a specific record layout.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Lets you specify a css class of elements that will not initiate a drag",
+ "sig" : "(cssClass)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Array",
- "desc" : "An Array of field definition objects which specify field names, and optionally,\ndata types, and a mapping for an {@link Roo.data.Reader} to extract the field's value from a data object.\nEach field definition object may contain the following properties: <ul>\n<li><b>name</b> : String<p style=\"margin-left:1em\">The name by which the field is referenced within the Record. This is referenced by,\nfor example the <em>dataIndex</em> property in column definition objects passed to {@link Roo.grid.ColumnModel}</p></li>\n<li><b>mapping</b> : String<p style=\"margin-left:1em\"> A path specification for use by the {@link Roo.data.Reader} implementation\nthat is creating the Record to access the data value from the data object. If an {@link Roo.data.JsonReader}\nis being used, then this is a string containing the javascript expression to reference the data relative to \nthe record item's root. If an {@link Roo.data.XmlReader} is being used, this is an {@link Roo.DomQuery} path\nto the data item relative to the record element. If the mapping expression is the same as the field name,\nthis may be omitted.</p></li>\n<li><b>type</b> : String<p style=\"margin-left:1em\"> The data type for conversion to displayable value. Possible values are\n<ul><li>auto (Default, implies no conversion)</li>\n<li>string</li>\n<li>int</li>\n<li>float</li>\n<li>boolean</li>\n<li>date</li></ul></p></li>\n<li><b>sortType</b> : Mixed<p style=\"margin-left:1em\"> A member of {@link Roo.data.SortTypes}.</p></li>\n<li><b>sortDir</b> : String<p style=\"margin-left:1em\"> Initial direction to sort. \"ASC\" or \"DESC\"</p></li>\n<li><b>convert</b> : Function<p style=\"margin-left:1em\"> A function which converts the value provided\nby the Reader into an object that will be stored in the Record. It is passed the\nfollowing parameters:<ul>\n<li><b>v</b> : Mixed<p style=\"margin-left:1em\">The data value as read by the Reader.</p></li>\n</ul></p></li>\n<li><b>dateFormat</b> : String<p style=\"margin-left:1em\"> A format String for the Date.parseDate function.</p></li>\n</ul>\n<br>usage:<br><pre><code>\nvar TopicRecord = Roo.data.Record.create(\n {name: 'title', mapping: 'topic_title'},\n {name: 'author', mapping: 'username'},\n {name: 'totalPosts', mapping: 'topic_replies', type: 'int'},\n {name: 'lastPost', mapping: 'post_time', type: 'date'},\n {name: 'lastPoster', mapping: 'user2'},\n {name: 'excerpt', mapping: 'post_text'}\n);\n\nvar myNewRecord = new TopicRecord({\n title: 'Do my job please',\n author: 'noobie',\n totalPosts: 1,\n lastPost: new Date(),\n lastPoster: 'Animal',\n excerpt: 'No way dude!'\n});\nmyStore.add(myNewRecord);\n</code></pre>",
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the elements you wish to ignore",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "get",
+ "name" : "addInvalidHandleId",
"type" : "function",
- "desc" : "Get the value of the named field.",
- "sig" : "(name)",
+ "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "name",
- "type" : "String",
- "desc" : "The name of the field to get the value of.",
+ "name" : "id",
+ "type" : "string",
+ "desc" : "the element id of the element you wish to ignore",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "The value of the field."
- }
- ]
+ "returns" : []
},
{
- "name" : "reject",
+ "name" : "addInvalidHandleType",
"type" : "function",
- "desc" : "Usually called by the {@link Roo.data.Store} which owns the Record.\nRejects all changes made to the Record since either creation, or the last commit operation.\nModified fields are reverted to their original values.\n<p>\nDevelopers should subscribe to the {@link Roo.data.Store#update} event to have their code notified\nof reject operations.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
+ "sig" : "(tagName)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to exclude",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "set",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Set the named field to the specified value.",
- "sig" : "(name, value)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "name",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The name of the field to set.",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "value",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
"type" : "Object",
- "desc" : "The value to set the field to.",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.ScriptTagProxy" : {
- "props" : [
- {
- "name" : "callbackParam",
- "type" : "String",
- "desc" : "The name of the parameter to pass to the server which tells\nthe server the name of the callback function set up by the load call to process the returned data object.\nDefaults to \"callback\".<p>The server-side processing must read this parameter value, and generate\njavascript output which calls this named function passing the data object as its only parameter.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "nocache",
- "type" : "Boolean",
- "desc" : "Defaults to true. Disable cacheing by adding a unique parameter\nname to the request.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "timeout",
- "type" : "Number",
- "desc" : "The number of milliseconds to wait for a response. Defaults to 30 seconds.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
},
{
- "name" : "url",
- "type" : "String",
- "desc" : "The URL from which to request the data object.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
- {
- "name" : "abort",
+ "name" : "addToGroup",
"type" : "function",
- "desc" : "Abort the current server request.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
+ "sig" : "(sGroup)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "sGroup",
+ "type" : "",
+ "desc" : "{string} the name of the group",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "load",
+ "name" : "afterDragDrop",
"type" : "function",
- "desc" : "Load data from the configured URL, read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback.",
- "sig" : "(params, reader, callback, scope, arg)",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter a valid drag drop has occurred by providing an implementation.",
+ "sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "params",
- "type" : "Object",
- "desc" : "An object containing properties which are to be used as HTTP parameters\nfor the request to the remote server.",
- "isOptional" : false
- },
- {
- "name" : "reader",
- "type" : "Roo.data.DataReader",
- "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "The function into which to pass the block of Roo.data.Records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "The scope in which to call the callback",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
"isOptional" : false
},
{
- "name" : "arg",
- "type" : "Object",
- "desc" : "An optional argument which is passed to the callback as its second parameter.",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dropped element",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.SimpleStore" : {
- "props" : [
- {
- "name" : "an",
- "type" : "Object",
- "desc" : "existing reader (eg. copied from another store)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "baseParams",
- "type" : "Object",
- "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request",
- "memberOf" : "Roo.data.Store",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "data",
- "type" : "Array",
- "desc" : "The multi-dimensional array of data",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fields",
- "type" : "Array",
- "desc" : "An array of field definition objects, or field name strings.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "id",
- "type" : "Number",
- "desc" : "The array index of the record id. Leave blank to auto generate ids.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "isLocal",
- "type" : "boolean",
- "desc" : "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
- "memberOf" : "Roo.data.Store",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "multiSort",
- "type" : "Boolean",
- "desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)",
- "memberOf" : "Roo.data.Store",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "proxy",
- "type" : "Roo.data.DataProxy",
- "desc" : "[not-required]",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "pruneModifiedRecords",
- "type" : "boolean",
- "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
- "memberOf" : "Roo.data.Store",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "reader",
- "type" : "Roo.data.Reader",
- "desc" : "[not-required]",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "remoteSort",
- "type" : "boolean",
- "desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
- "memberOf" : "Roo.data.Store",
- "isOptional" : false,
- "optvals" : []
},
{
- "name" : "sortInfo",
- "type" : "Object",
- "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
- "memberOf" : "Roo.data.Store",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "add",
+ "name" : "afterDragEnter",
"type" : "function",
- "desc" : "Fires when Records have been added to the Store",
- "sig" : "function (_self, records, index)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhen the dragged item enters the drop target by providing an implementation.",
+ "sig" : "(target, e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragSource",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
"isOptional" : false
},
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "The array of Records added",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
"isOptional" : false
},
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The index at which the record(s) were added",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeload",
+ "name" : "afterDragOut",
"type" : "function",
- "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.",
- "sig" : "function (_self, options)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter the dragged item is dragged out of the target without dropping.",
+ "sig" : "(target, e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragSource",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeloadadd",
+ "name" : "afterDragOver",
"type" : "function",
- "desc" : "Fires after a new set of Records has been loaded.",
- "sig" : "function (_self, records, options)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhile the dragged item is over the drop target by providing an implementation.",
+ "sig" : "(target, e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragSource",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
"isOptional" : false
},
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "The Records that were loaded",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "clear",
+ "name" : "afterInvalidDrop",
"type" : "function",
- "desc" : "Fires when the data cache has been cleared.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter an invalid drop has occurred by providing an implementation.",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragSource",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dropped element",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "datachanged",
+ "name" : "afterRepair",
"type" : "function",
- "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Called after a repair of an invalid drop. By default, highlights this.dragData.ddel",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Store",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "load",
+ "name" : "afterValidDrop",
"type" : "function",
- "desc" : "Fires after a new set of Records has been loaded, before they are added to the store.",
- "sig" : "function (_self, records, options)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter a valid drop has occurred by providing an implementation.",
+ "sig" : "(target, e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragSource",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "target",
+ "type" : "Object",
+ "desc" : "The target DD",
"isOptional" : false
},
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "The Records that were loaded",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dropped element",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "loadexception",
+ "name" : "alignElWithMouse",
"type" : "function",
- "desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args",
- "sig" : "function (, ret, opts, jsonData)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
+ "sig" : "(el, iPageX, iPageY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DD",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "",
- "type" : "Proxy",
- "desc" : "",
+ "name" : "el",
+ "type" : "HTMLElement",
+ "desc" : "the element to move",
"isOptional" : false
},
{
- "name" : "ret",
- "type" : "Object",
- "desc" : "return data from JsonData.reader() - success, totalRecords, records",
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the mousedown or drag event",
"isOptional" : false
},
{
- "name" : "opts",
- "type" : "Object",
- "desc" : "- load Options",
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the mousedown or drag event",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "applyConfig",
+ "type" : "function",
+ "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "autoOffset",
+ "type" : "function",
+ "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked",
+ "sig" : "(iPageX, iPageY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DD",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the click",
"isOptional" : false
},
{
- "name" : "jsonData",
- "type" : "Object",
- "desc" : "from your request (normally this contains the Exception)",
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the click",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "metachange",
+ "name" : "beforeDragDrop",
"type" : "function",
- "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.",
- "sig" : "function (_self, meta)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dropped onto the target and optionally cancel the onDragDrop.",
+ "sig" : "(target, e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragSource",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
"isOptional" : false
},
{
- "name" : "meta",
- "type" : "Object",
- "desc" : "The JSON metadata",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "isValid True if the drag drop event is valid, else false to cancel"
+ }
+ ]
},
{
- "name" : "remove",
+ "name" : "beforeDragEnter",
"type" : "function",
- "desc" : "Fires when a Record has been removed from the Store",
- "sig" : "function (_self, record, index)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nbefore the dragged item enters the drop target and optionally cancel the onDragEnter.",
+ "sig" : "(target, e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragSource",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
"isOptional" : false
},
{
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The Record that was removed",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
"isOptional" : false
},
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The index at which the record was removed",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "isValid True if the drag event is valid, else false to cancel"
+ }
+ ]
},
{
- "name" : "update",
+ "name" : "beforeDragOut",
"type" : "function",
- "desc" : "Fires when a Record has been updated",
- "sig" : "function (_self, record, operation)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dragged out of the target without dropping, and optionally cancel the onDragOut.",
+ "sig" : "(target, e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragSource",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
"isOptional" : false
},
{
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The Record that was updated",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
"isOptional" : false
},
{
- "name" : "operation",
+ "name" : "id",
"type" : "String",
- "desc" : "The update operation being performed. Value may be one of:\n<pre><code>\n Roo.data.Record.EDIT\n Roo.data.Record.REJECT\n Roo.data.Record.COMMIT\n</code></pre>",
+ "desc" : "The id of the dragged element",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "methods" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "isValid True if the drag event is valid, else false to cancel"
+ }
+ ]
+ },
{
- "name" : "add",
+ "name" : "beforeDragOver",
"type" : "function",
- "desc" : "Add Records to the Store and fires the add event.",
- "sig" : "(records)",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhile the dragged item is over the drop target and optionally cancel the onDragOver.",
+ "sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "An Array of Roo.data.Record objects to add to the cache.",
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "isValid True if the drag event is valid, else false to cancel"
+ }
+ ]
},
{
- "name" : "addEvents",
+ "name" : "beforeInvalidDrop",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action after an invalid\ndrop has occurred.",
+ "sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "isValid True if the invalid drop should proceed, else false to cancel"
+ }
+ ]
},
{
- "name" : "addListener",
+ "name" : "cachePosition",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.",
+ "sig" : "(iPageX, iPageY)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "iPageX",
+ "type" : "",
+ "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "iPageY",
+ "type" : "",
+ "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "clearFilter",
+ "name" : "clearConstraints",
"type" : "function",
- "desc" : "Revert to a view of the Record cache with no filtering applied.",
- "sig" : "(suppressEvent)",
+ "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "suppressEvent",
- "type" : "Boolean",
- "desc" : "If true the filter is cleared silently without notifying listeners",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "collect",
+ "name" : "clearTicks",
"type" : "function",
- "desc" : "Collects unique values for a particular dataIndex from this store.",
- "sig" : "(dataIndex, allowNull, bypassFilter)",
+ "desc" : "Clears any tick interval defined for this instance",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "dataIndex",
- "type" : "String",
- "desc" : "The property to collect",
- "isOptional" : false
- },
- {
- "name" : "allowNull",
- "type" : "Boolean",
- "desc" : "(optional) Pass true to allow null, undefined or empty string values",
- "isOptional" : false
- },
- {
- "name" : "bypassFilter",
- "type" : "Boolean",
- "desc" : "(optional) Pass true to collect from all records, even ones which are filtered",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Array",
- "desc" : "An array of the unique values"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "commitChanges",
+ "name" : "createFrame",
"type" : "function",
- "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.",
+ "desc" : "Creates the proxy element if it does not yet exist",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DDProxy",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "each",
+ "name" : "endDrag",
"type" : "function",
- "desc" : "Calls the specified function for each of the Records in the cache.",
- "sig" : "(fn, scope)",
+ "desc" : "Fired when we are done dragging the object",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call. The Record is passed as the first parameter.\nReturning <em>false</em> aborts and exits the iteration.",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to call the function (defaults to the Record).",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "filter",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Filter the records by a specified property.",
- "sig" : "(field, value, anyMatch)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "field",
+ "name" : "eventName",
"type" : "String",
- "desc" : "A field on your records",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "value",
- "type" : "String/RegExp",
- "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
- "name" : "anyMatch",
+ "name" : "",
"type" : "Boolean",
- "desc" : "True to match any part not just the beginning",
- "isOptional" : false
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "filterBy",
+ "name" : "getDragData",
"type" : "function",
- "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.",
- "sig" : "(fn, scope)",
+ "desc" : "Called when a mousedown occurs in this container. Looks in {@link Roo.dd.Registry}\nfor a valid target to drag based on the mouse down. Override this method\nto provide your own lookup logic (e.g. finding a child by class name). Make sure your returned\nobject has a \"ddel\" attribute (with an HTML Element) for other functions to work.",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to be called, it will receive 2 args (record, id)",
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "The mouse down event",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
- "name" : "scope",
+ "name" : "",
"type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to this)",
- "isOptional" : false
+ "desc" : "The dragData"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "fireEvent",
+ "name" : "getDragEl",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "the html element"
+ }
+ ]
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns a reference to the linked element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "the html element"
}
- ],
+ ]
+ },
+ {
+ "name" : "getProxy",
+ "type" : "function",
+ "desc" : "Returns the drag source's underlying {@link Roo.dd.StatusProxy}",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragSource",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "Roo.dd.StatusProxy",
+ "desc" : "proxy The StatusProxy"
}
]
},
{
- "name" : "getAt",
+ "name" : "getRepairXY",
"type" : "function",
- "desc" : "Get the Record at the specified index.",
- "sig" : "(index)",
+ "desc" : "Called before a repair of an invalid drop to get the XY to animate to. By default returns\nthe XY of this.dragData.ddel",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the Record to find.",
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "The mouse up event",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.data.Record",
- "desc" : "The Record at the passed index. Returns undefined if not found."
+ "type" : "Array",
+ "desc" : "The xy location (e.g. [100, 200])"
}
]
},
{
- "name" : "getById",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Get the Record with the specified id.",
- "sig" : "(id)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The id of the Record to find.",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.data.Record",
- "desc" : "The Record with the passed id. Returns undefined if not found."
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "getCount",
+ "name" : "hideProxy",
"type" : "function",
- "desc" : "Gets the number of cached records.\n<p>\n<em>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size</em>",
+ "desc" : "Hides the drag source's {@link Roo.dd.StatusProxy}",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "getModifiedRecords",
+ "name" : "init",
"type" : "function",
- "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
+ "sig" : "(id, sGroup, config)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.data.Record[]",
- "desc" : "An array of Records containing outstanding modifications."
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the linked element",
+ "isOptional" : false
+ },
+ {
+ "name" : "sGroup",
+ "type" : "String",
+ "desc" : "the group of related items",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "object",
+ "desc" : "configuration attributes",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getRange",
+ "name" : "initFrame",
"type" : "function",
- "desc" : "Returns a range of Records between specified indices.",
- "sig" : "(startIndex, endIndex)",
+ "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DDProxy",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "initTarget",
+ "type" : "function",
+ "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
+ "sig" : "(id, sGroup, config)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "startIndex",
- "type" : "Number",
- "desc" : "(optional) The starting index (defaults to 0)",
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the linked element",
"isOptional" : false
},
{
- "name" : "endIndex",
- "type" : "Number",
- "desc" : "(optional) The ending index (defaults to the last Record in the Store)",
+ "name" : "sGroup",
+ "type" : "String",
+ "desc" : "the group of related items",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "object",
+ "desc" : "configuration attributes",
"isOptional" : false
}
],
+ "returns" : []
+ },
+ {
+ "name" : "isLocked",
+ "type" : "function",
+ "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.data.Record[]",
- "desc" : "An array of Records"
+ "type" : "boolean",
+ "desc" : "true if this obj or all drag/drop is locked, else\nfalse"
}
]
},
{
- "name" : "getSortState",
+ "name" : "isTarget",
"type" : "function",
- "desc" : "Returns the sort state of the Store as an object with two properties:\n<pre><code>\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n</code></pre>",
+ "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "getTotalCount",
+ "name" : "isValidHandleChild",
"type" : "function",
- "desc" : "Gets the total number of records in the dataset as returned by the server.\n<p>\n<em>If using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size</em>",
+ "desc" : "Checks the tag exclusion list to see if this click should be ignored",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "node",
+ "type" : "HTMLElement",
+ "desc" : "the HTMLElement to evaluate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "boolean",
+ "desc" : "true if this is a valid tag type, false if not"
+ }
+ ]
+ },
+ {
+ "name" : "lock",
+ "type" : "function",
+ "desc" : "Lock this instance",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "hasListener",
+ "name" : "on",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The name of the event to check for",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "indexOf",
+ "name" : "onAvailable",
"type" : "function",
- "desc" : "Get the index within the cache of the passed Record.",
- "sig" : "(record)",
+ "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "onBeforeDrag",
+ "type" : "function",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action before the initial\ndrag event begins and optionally cancel it.",
+ "sig" : "(data, e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The Roo.data.Record object to to find.",
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data to be shared with drop targets",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "The index of the passed Record. Returns -1 if not found."
+ "type" : "Boolean",
+ "desc" : "isValid True if the drag event is valid, else false to cancel"
}
]
},
{
- "name" : "indexOfId",
+ "name" : "onDrag",
"type" : "function",
- "desc" : "Get the index within the cache of the Record with the passed id.",
- "sig" : "(id)",
+ "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the Record to find.",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "The index of the Record. Returns -1 if not found."
- }
- ]
+ "returns" : []
},
{
- "name" : "insert",
+ "name" : "onDragDrop",
"type" : "function",
- "desc" : "Inserts Records to the Store at the given index and fires the add event.",
- "sig" : "(index, records)",
+ "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The start index at which to insert the passed Records.",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
},
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "An Array of Roo.data.Record objects to add to the cache.",
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "load",
+ "name" : "onDragEnter",
"type" : "function",
- "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n<p>\nIf using remote paging, then the first load call must specify the <em>start</em>\nand <em>limit</em> properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n<p>\n<strong>It is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.</strong>\n<p>",
- "sig" : "(options)",
+ "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "An object containing properties which control loading options:<ul>\n<li>params {Object} An object containing properties to pass as HTTP parameters to a remote data source.</li>\n<li>params.data {Object} if you are using a MemoryProxy / JsonReader, use this as the data to load stuff..\n<pre>\n {\n data : data, // array of key=>value data like JsonReader\n total : data.length,\n success : true\n \n }\n </pre>\n }.</li>\n<li>callback {Function} A function to be called after the Records have been loaded. The callback is\npassed the following arguments:<ul>\n<li>r : Roo.data.Record[]</li>\n<li>options: Options object from the load call</li>\n<li>success: Boolean success indicator</li></ul></li>\n<li>scope {Object} Scope with which to call the callback (defaults to the Store object)</li>\n<li>add {Boolean} indicator to append loaded records rather than replace the current cache.</li>\n</ul>",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "loadData",
+ "name" : "onDragOut",
"type" : "function",
- "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.",
- "sig" : "(data, append)",
+ "desc" : "Abstract method called when we are no longer hovering over an element",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "data",
- "type" : "Object",
- "desc" : "The data block from which to read the Records. The format of the data expected\nis dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
},
{
- "name" : "append",
- "type" : "Boolean",
- "desc" : "True to append the new Records rather than replace the existing cache.",
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "loadDataFromChildren",
+ "name" : "onDragOver",
"type" : "function",
- "desc" : "using 'cn' the nested child reader read the child array into it's child stores.",
- "sig" : "(rec)",
+ "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "rec",
- "type" : "Object",
- "desc" : "The record with a 'children array",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "on",
+ "name" : "onInitDrag",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Called once drag threshold has been reached to initialize the proxy element. By default, it clones the\nthis.dragData.ddel",
+ "sig" : "(x, y)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The x position of the click on the dragged object",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The y position of the click on the dragged object",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "true to continue the drag, false to cancel"
+ }
+ ]
+ },
+ {
+ "name" : "onInvalidDrop",
+ "type" : "function",
+ "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "onMouseDown",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousedown event",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "query",
+ "name" : "onMouseUp",
"type" : "function",
- "desc" : "Query the records by a specified property.",
- "sig" : "(field, value, anyMatch)",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "field",
- "type" : "String",
- "desc" : "A field on your records",
- "isOptional" : false
- },
- {
- "name" : "value",
- "type" : "String/RegExp",
- "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
- "isOptional" : false
- },
- {
- "name" : "anyMatch",
- "type" : "Boolean",
- "desc" : "True to match any part not just the beginning",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "MixedCollection",
- "desc" : "Returns an Roo.util.MixedCollection of the matched records"
- }
- ]
+ "returns" : []
},
{
- "name" : "queryBy",
+ "name" : "onStartDrag",
"type" : "function",
- "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.",
- "sig" : "(fn, scope)",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action once the initial\ndrag event has begun. The drag cannot be canceled from this function.",
+ "sig" : "(x, y)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to be called, it will receive 2 args (record, id)",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The x position of the click on the dragged object",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to this)",
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The y position of the click on the dragged object",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "MixedCollection",
- "desc" : "Returns an Roo.util.MixedCollection of the matched records"
- }
- ]
+ "returns" : []
},
{
- "name" : "rejectChanges",
+ "name" : "padding",
"type" : "function",
- "desc" : "Cancel outstanding changes on all changed records.",
+ "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "reload",
+ "name" : "removeFromGroup",
"type" : "function",
- "desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.",
- "sig" : "(options)",
+ "desc" : "Remove's this instance from the supplied interaction group",
+ "sig" : "(sGroup)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing properties which may override the options\nused in the last load operation. See {@link #load} for details (defaults to null, in which case\nthe most recently used options are reused).",
+ "name" : "sGroup",
+ "type" : "string",
+ "desc" : "The group to drop",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "removeInvalidHandleClass",
"type" : "function",
- "desc" : "Remove a Record from the Store and fires the remove event.",
- "sig" : "(record)",
+ "desc" : "Unsets an invalid css class",
+ "sig" : "(cssClass)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "record",
- "type" : "Ext.data.Record",
- "desc" : "The Roo.data.Record object to remove from the cache.",
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the element(s) you wish to\nre-enable",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeAll",
+ "name" : "removeInvalidHandleId",
"type" : "function",
- "desc" : "Remove all Records from the Store and fires the clear event.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Unsets an invalid handle id",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "string",
+ "desc" : "the id of the element to re-enable",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeInvalidHandleType",
+ "type" : "function",
+ "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
+ "sig" : "(tagName)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to unexclude",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
"returns" : []
},
{
- "name" : "setDefaultSort",
+ "name" : "resetConstraints",
"type" : "function",
- "desc" : "Sets the default sort column and order to be used by the next load operation.",
- "sig" : "(fieldName, dir)",
+ "desc" : "resetConstraints must be called if you manually reposition a dd element.",
+ "sig" : "(maintainOffset)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fieldName",
- "type" : "String",
- "desc" : "The name of the field to sort by.",
+ "name" : "maintainOffset",
+ "type" : "boolean",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setDelta",
+ "type" : "function",
+ "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)",
+ "sig" : "(iDeltaX, iDeltaY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DD",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "iDeltaX",
+ "type" : "int",
+ "desc" : "the distance from the left",
"isOptional" : false
},
{
- "name" : "dir",
- "type" : "String",
- "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
+ "name" : "iDeltaY",
+ "type" : "int",
+ "desc" : "the distance from the top",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setDragElId",
+ "type" : "function",
+ "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "",
+ "desc" : "{string} the id of the element that will be used to initiate the drag",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setDragElPos",
+ "type" : "function",
+ "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
+ "sig" : "(iPageX, iPageY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DD",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the mousedown or drag event",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the mousedown or drag event",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setHandleElId",
+ "type" : "function",
+ "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "",
+ "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setInitPosition",
+ "type" : "function",
+ "desc" : "Stores the initial placement of the linked element.",
+ "sig" : "(diffX, diffY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "diffX",
+ "type" : "int",
+ "desc" : "the X offset, default 0",
+ "isOptional" : false
+ },
+ {
+ "name" : "diffY",
+ "type" : "int",
+ "desc" : "the Y offset, default 0",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "sort",
+ "name" : "setOuterHandleElId",
"type" : "function",
- "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.",
- "sig" : "(fieldName, dir)",
+ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fieldName",
- "type" : "String",
- "desc" : "The name of the field to sort by.",
- "isOptional" : false
- },
- {
- "name" : "dir",
- "type" : "String",
- "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the element that will be used to initiate the drag",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "sum",
+ "name" : "setPadding",
"type" : "function",
- "desc" : "Sums the value of <i>property</i> for each record between start and end and returns the result.",
- "sig" : "(property, start, end)",
+ "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
+ "sig" : "(iTop, iRight, iBot, iLeft)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "property",
- "type" : "String",
- "desc" : "A field on your records",
+ "name" : "iTop",
+ "type" : "int",
+ "desc" : "Top pad",
"isOptional" : false
},
{
- "name" : "start",
- "type" : "Number",
- "desc" : "The record index to start at (defaults to 0)",
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "Right pad",
"isOptional" : false
},
{
- "name" : "end",
- "type" : "Number",
- "desc" : "The last record index to include (defaults to length - 1)",
+ "name" : "iBot",
+ "type" : "int",
+ "desc" : "Bot pad",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Number",
- "desc" : "The sum"
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "Left pad",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "un",
+ "name" : "setXConstraint",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
+ "sig" : "(iLeft, iRight, iTickSize)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the left",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the\nright",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.SortTypes" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "asDate",
+ "name" : "setYConstraint",
"type" : "function",
- "desc" : "Date sorting",
- "sig" : "(s)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
+ "sig" : "(iUp, iDown, iTickSize)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "s",
- "type" : "Mixed",
- "desc" : "The value being converted",
+ "name" : "iUp",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move up",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Number",
- "desc" : "The comparison value"
- }
- ]
- },
- {
- "name" : "asFloat",
- "type" : "function",
- "desc" : "Float sorting",
- "sig" : "(s)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ "name" : "iDown",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move down",
+ "isOptional" : false
+ },
{
- "name" : "s",
- "type" : "Mixed",
- "desc" : "The value being converted",
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Float",
- "desc" : "The comparison value"
- }
- ]
+ "returns" : []
},
{
- "name" : "asInt",
+ "name" : "startDrag",
"type" : "function",
- "desc" : "Integer sorting",
- "sig" : "(s)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
+ "sig" : "(X, Y)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "s",
- "type" : "Mixed",
- "desc" : "The value being converted",
+ "name" : "X",
+ "type" : "int",
+ "desc" : "click location",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Number",
- "desc" : "The comparison value"
+ "name" : "Y",
+ "type" : "int",
+ "desc" : "click location",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "asText",
+ "name" : "toString",
"type" : "function",
- "desc" : "Strips all HTML tags to sort on text only",
- "sig" : "(s)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "toString method",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "s",
- "type" : "Mixed",
- "desc" : "The value being converted",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "The comparison value"
+ "type" : "string",
+ "desc" : "string representation of the dd obj"
}
]
},
{
- "name" : "asUCString",
+ "name" : "un",
"type" : "function",
- "desc" : "Case insensitive string",
- "sig" : "(s)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "s",
- "type" : "Mixed",
- "desc" : "The value being converted",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "String",
- "desc" : "The comparison value"
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "asUCText",
+ "name" : "unlock",
"type" : "function",
- "desc" : "Strips all HTML tags to sort on text only - Case insensitive",
- "sig" : "(s)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Unlock this instace",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "s",
- "type" : "Mixed",
- "desc" : "The value being converted",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "The comparison value"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "none",
+ "name" : "unreg",
"type" : "function",
- "desc" : "Default sort that does nothing",
- "sig" : "(s)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Remove all drag and drop hooks for this element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "s",
- "type" : "Mixed",
- "desc" : "The value being converted",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "The comparison value"
- }
- ]
+ "params" : [],
+ "returns" : []
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.data.Store" : {
+ "Roo.dd.DropTarget" : {
"props" : [
{
- "name" : "baseParams",
- "type" : "Object",
- "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request",
+ "name" : "ddGroup",
+ "type" : "String",
+ "desc" : "The drag drop group to handle drop events for",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "data",
- "type" : "Array",
- "desc" : "Inline data to be loaded when the store is initialized.",
+ "name" : "dropAllowed",
+ "type" : "String",
+ "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "isLocal",
- "type" : "boolean",
- "desc" : "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
+ "name" : "dropNotAllowed",
+ "type" : "String",
+ "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"optvals" : []
},
{
- "name" : "multiSort",
- "type" : "Boolean",
- "desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "proxy",
- "type" : "Roo.data.DataProxy",
- "desc" : "The Proxy object which provides access to a data object.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "pruneModifiedRecords",
- "type" : "boolean",
- "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "reader",
- "type" : "Roo.data.DataReader",
- "desc" : "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.",
+ "name" : "overClass",
+ "type" : "String",
+ "desc" : "The CSS class applied to the drop target element while the drag source is over it (defaults to \"\").",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "remoteSort",
+ "name" : "success",
"type" : "boolean",
- "desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
+ "desc" : "set this after drop listener..",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "sortInfo",
- "type" : "Object",
- "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
+ "name" : "valid",
+ "type" : "boolean|String",
+ "desc" : "true/false or string (ok-add/ok-sub/ok/nodrop)\nif the drop point is valid for over/enter..",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
],
"events" : [
{
- "name" : "add",
+ "name" : "drop",
"type" : "function",
- "desc" : "Fires when Records have been added to the Store",
- "sig" : "function (_self, records, index)\n{\n\n}",
+ "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the dragged item has\nbeen dropped on it. This method has no default implementation and returns false, so you must provide an\nimplementation that does something to process the drop event and returns true so that the drag source's\nrepair action does not run.\n\nIMPORTANT : it should set this.success",
+ "sig" : "function (source, e, data)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "The array of Records added",
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop target",
"isOptional" : false
},
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The index at which the record(s) were added",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeload",
- "type" : "function",
- "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.",
- "sig" : "function (_self, options)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
"isOptional" : false
},
{
- "name" : "options",
+ "name" : "data",
"type" : "Object",
- "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeloadadd",
+ "name" : "enter",
"type" : "function",
- "desc" : "Fires after a new set of Records has been loaded.",
- "sig" : "function (_self, records, options)\n{\n\n}",
+ "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the\ntarget. This default implementation adds the CSS class specified by overClass (if any) to the drop element\nand returns the dropAllowed config value. This method should be overridden if drop validation is required.\n\nIMPORTANT : it should set this.valid to true|false",
+ "sig" : "function (source, e, data)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop target",
"isOptional" : false
},
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "The Records that were loaded",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
"isOptional" : false
},
{
- "name" : "options",
+ "name" : "data",
"type" : "Object",
- "desc" : "The loading options that were specified (see {@link #load} for details)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "clear",
- "type" : "function",
- "desc" : "Fires when the data cache has been cleared.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Store",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "datachanged",
- "type" : "function",
- "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "load",
+ "name" : "out",
"type" : "function",
- "desc" : "Fires after a new set of Records has been loaded, before they are added to the store.",
- "sig" : "function (_self, records, options)\n{\n\n}",
+ "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged\nout of the target without dropping. This default implementation simply removes the CSS class specified by\noverClass (if any) from the drop element.",
+ "sig" : "function (source, e, data)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop target",
"isOptional" : false
},
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "The Records that were loaded",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
"isOptional" : false
},
{
- "name" : "options",
+ "name" : "data",
"type" : "Object",
- "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "loadexception",
+ "name" : "over",
"type" : "function",
- "desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args",
- "sig" : "function (, ret, opts, jsonData)\n{\n\n}",
+ "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.\nThis method will be called on every mouse movement while the drag source is over the drop target.\nThis default implementation simply returns the dropAllowed config value.\n\nIMPORTANT : it should set this.valid to true|false",
+ "sig" : "function (source, e, data)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "",
- "type" : "Proxy",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "ret",
- "type" : "Object",
- "desc" : "return data from JsonData.reader() - success, totalRecords, records",
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop target",
"isOptional" : false
},
{
- "name" : "opts",
- "type" : "Object",
- "desc" : "- load Options",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
"isOptional" : false
},
{
- "name" : "jsonData",
+ "name" : "data",
"type" : "Object",
- "desc" : "from your request (normally this contains the Exception)",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "metachange",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.",
- "sig" : "function (_self, meta)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "meta",
+ "name" : "object",
"type" : "Object",
- "desc" : "The JSON metadata",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "addInvalidHandleClass",
"type" : "function",
- "desc" : "Fires when a Record has been removed from the Store",
- "sig" : "function (_self, record, index)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Lets you specify a css class of elements that will not initiate a drag",
+ "sig" : "(cssClass)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The Record that was removed",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index at which the record was removed",
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the elements you wish to ignore",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "update",
- "type" : "function",
- "desc" : "Fires when a Record has been updated",
- "sig" : "function (_self, record, operation)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Store",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The Record that was updated",
- "isOptional" : false
- },
- {
- "name" : "operation",
- "type" : "String",
- "desc" : "The update operation being performed. Value may be one of:\n<pre><code>\n Roo.data.Record.EDIT\n Roo.data.Record.REJECT\n Roo.data.Record.COMMIT\n</code></pre>",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "methods" : [
- {
- "name" : "add",
+ "name" : "addInvalidHandleId",
"type" : "function",
- "desc" : "Add Records to the Store and fires the add event.",
- "sig" : "(records)",
+ "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "An Array of Roo.data.Record objects to add to the cache.",
+ "name" : "id",
+ "type" : "string",
+ "desc" : "the element id of the element you wish to ignore",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addEvents",
+ "name" : "addInvalidHandleType",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
+ "sig" : "(tagName)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to exclude",
"isOptional" : false
}
],
],
"returns" : []
},
+ {
+ "name" : "addToGroup",
+ "type" : "function",
+ "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
+ "sig" : "(sGroup)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "sGroup",
+ "type" : "",
+ "desc" : "{string} the name of the group",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "applyConfig",
+ "type" : "function",
+ "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
"returns" : []
},
{
- "name" : "clearFilter",
+ "name" : "clearConstraints",
"type" : "function",
- "desc" : "Revert to a view of the Record cache with no filtering applied.",
- "sig" : "(suppressEvent)",
+ "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "clearTicks",
+ "type" : "function",
+ "desc" : "Clears any tick interval defined for this instance",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "endDrag",
+ "type" : "function",
+ "desc" : "Fired when we are done dragging the object",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "suppressEvent",
- "type" : "Boolean",
- "desc" : "If true the filter is cleared silently without notifying listeners",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "collect",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Collects unique values for a particular dataIndex from this store.",
- "sig" : "(dataIndex, allowNull, bypassFilter)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "dataIndex",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The property to collect",
- "isOptional" : false
- },
- {
- "name" : "allowNull",
- "type" : "Boolean",
- "desc" : "(optional) Pass true to allow null, undefined or empty string values",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "bypassFilter",
- "type" : "Boolean",
- "desc" : "(optional) Pass true to collect from all records, even ones which are filtered",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Array",
- "desc" : "An array of the unique values"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "commitChanges",
+ "name" : "getDragEl",
"type" : "function",
- "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.",
+ "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "the html element"
+ }
+ ]
},
{
- "name" : "each",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Calls the specified function for each of the Records in the cache.",
- "sig" : "(fn, scope)",
+ "desc" : "Returns a reference to the linked element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call. The Record is passed as the first parameter.\nReturning <em>false</em> aborts and exits the iteration.",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to call the function (defaults to the Record).",
- "isOptional" : false
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "the html element"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "filter",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Filter the records by a specified property.",
- "sig" : "(field, value, anyMatch)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "field",
+ "name" : "eventName",
"type" : "String",
- "desc" : "A field on your records",
- "isOptional" : false
- },
- {
- "name" : "value",
- "type" : "String/RegExp",
- "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
+ "desc" : "The name of the event to check for",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
- "name" : "anyMatch",
+ "name" : "",
"type" : "Boolean",
- "desc" : "True to match any part not just the beginning",
- "isOptional" : false
+ "desc" : "True if the event is being listened for, else false"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "filterBy",
+ "name" : "init",
"type" : "function",
- "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.",
- "sig" : "(fn, scope)",
+ "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
+ "sig" : "(id, sGroup, config)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to be called, it will receive 2 args (record, id)",
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the linked element",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to this)",
+ "name" : "sGroup",
+ "type" : "String",
+ "desc" : "the group of related items",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "object",
+ "desc" : "configuration attributes",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "initTarget",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
+ "sig" : "(id, sGroup, config)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the linked element",
+ "isOptional" : false
+ },
+ {
+ "name" : "sGroup",
"type" : "String",
- "desc" : "",
+ "desc" : "the group of related items",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "config",
+ "type" : "object",
+ "desc" : "configuration attributes",
"isOptional" : false
}
],
+ "returns" : []
+ },
+ {
+ "name" : "isLocked",
+ "type" : "function",
+ "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "boolean",
+ "desc" : "true if this obj or all drag/drop is locked, else\nfalse"
}
]
},
{
- "name" : "getAt",
+ "name" : "isTarget",
"type" : "function",
- "desc" : "Get the Record at the specified index.",
- "sig" : "(index)",
+ "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isValidHandleChild",
+ "type" : "function",
+ "desc" : "Checks the tag exclusion list to see if this click should be ignored",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the Record to find.",
+ "name" : "node",
+ "type" : "HTMLElement",
+ "desc" : "the HTMLElement to evaluate",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.data.Record",
- "desc" : "The Record at the passed index. Returns undefined if not found."
+ "type" : "boolean",
+ "desc" : "true if this is a valid tag type, false if not"
}
]
},
{
- "name" : "getById",
+ "name" : "lock",
"type" : "function",
- "desc" : "Get the Record with the specified id.",
- "sig" : "(id)",
+ "desc" : "Lock this instance",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "notifyDrop",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the Record to find.",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.data.Record",
- "desc" : "The Record with the passed id. Returns undefined if not found."
- }
- ]
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "notifyEnter",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
- "name" : "getCount",
+ "name" : "notifyOut",
"type" : "function",
- "desc" : "Gets the number of cached records.\n<p>\n<em>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size</em>",
+ "desc" : "",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : []
},
{
- "name" : "getModifiedRecords",
+ "name" : "notifyOver",
"type" : "function",
- "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).",
+ "desc" : "",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.data.Record[]",
- "desc" : "An array of Records containing outstanding modifications."
- }
- ]
+ "returns" : []
},
{
- "name" : "getRange",
+ "name" : "on",
"type" : "function",
- "desc" : "Returns a range of Records between specified indices.",
- "sig" : "(startIndex, endIndex)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "startIndex",
- "type" : "Number",
- "desc" : "(optional) The starting index (defaults to 0)",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "endIndex",
- "type" : "Number",
- "desc" : "(optional) The ending index (defaults to the last Record in the Store)",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.data.Record[]",
- "desc" : "An array of Records"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getSortState",
+ "name" : "onAvailable",
"type" : "function",
- "desc" : "Returns the sort state of the Store as an object with two properties:\n<pre><code>\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n</code></pre>",
+ "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "getTotalCount",
+ "name" : "onDrag",
"type" : "function",
- "desc" : "Gets the total number of records in the dataset as returned by the server.\n<p>\n<em>If using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size</em>",
- "sig" : "()\n{\n\n}",
+ "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "hasListener",
+ "name" : "onDragDrop",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "indexOf",
+ "name" : "onDragEnter",
"type" : "function",
- "desc" : "Get the index within the cache of the passed Record.",
- "sig" : "(record)",
+ "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The Roo.data.Record object to to find.",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Number",
- "desc" : "The index of the passed Record. Returns -1 if not found."
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "indexOfId",
+ "name" : "onDragOut",
"type" : "function",
- "desc" : "Get the index within the cache of the Record with the passed id.",
- "sig" : "(id)",
+ "desc" : "Abstract method called when we are no longer hovering over an element",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
+ "isOptional" : false
+ },
{
"name" : "id",
- "type" : "String",
- "desc" : "The id of the Record to find.",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "The index of the Record. Returns -1 if not found."
- }
- ]
+ "returns" : []
},
{
- "name" : "insert",
+ "name" : "onDragOver",
"type" : "function",
- "desc" : "Inserts Records to the Store at the given index and fires the add event.",
- "sig" : "(index, records)",
+ "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The start index at which to insert the passed Records.",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
},
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "An Array of Roo.data.Record objects to add to the cache.",
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "load",
+ "name" : "onInvalidDrop",
"type" : "function",
- "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n<p>\nIf using remote paging, then the first load call must specify the <em>start</em>\nand <em>limit</em> properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n<p>\n<strong>It is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.</strong>\n<p>",
- "sig" : "(options)",
+ "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "An object containing properties which control loading options:<ul>\n<li>params {Object} An object containing properties to pass as HTTP parameters to a remote data source.</li>\n<li>params.data {Object} if you are using a MemoryProxy / JsonReader, use this as the data to load stuff..\n<pre>\n {\n data : data, // array of key=>value data like JsonReader\n total : data.length,\n success : true\n \n }\n </pre>\n }.</li>\n<li>callback {Function} A function to be called after the Records have been loaded. The callback is\npassed the following arguments:<ul>\n<li>r : Roo.data.Record[]</li>\n<li>options: Options object from the load call</li>\n<li>success: Boolean success indicator</li></ul></li>\n<li>scope {Object} Scope with which to call the callback (defaults to the Store object)</li>\n<li>add {Boolean} indicator to append loaded records rather than replace the current cache.</li>\n</ul>",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "loadData",
+ "name" : "onMouseDown",
"type" : "function",
- "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.",
- "sig" : "(data, append)",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "data",
- "type" : "Object",
- "desc" : "The data block from which to read the Records. The format of the data expected\nis dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.",
- "isOptional" : false
- },
- {
- "name" : "append",
- "type" : "Boolean",
- "desc" : "True to append the new Records rather than replace the existing cache.",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousedown event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "loadDataFromChildren",
+ "name" : "onMouseUp",
"type" : "function",
- "desc" : "using 'cn' the nested child reader read the child array into it's child stores.",
- "sig" : "(rec)",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "rec",
- "type" : "Object",
- "desc" : "The record with a 'children array",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "on",
+ "name" : "padding",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
"returns" : []
},
{
- "name" : "query",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Query the records by a specified property.",
- "sig" : "(field, value, anyMatch)",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeFromGroup",
+ "type" : "function",
+ "desc" : "Remove's this instance from the supplied interaction group",
+ "sig" : "(sGroup)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "field",
- "type" : "String",
- "desc" : "A field on your records",
+ "name" : "sGroup",
+ "type" : "string",
+ "desc" : "The group to drop",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeInvalidHandleClass",
+ "type" : "function",
+ "desc" : "Unsets an invalid css class",
+ "sig" : "(cssClass)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "value",
- "type" : "String/RegExp",
- "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the element(s) you wish to\nre-enable",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeInvalidHandleId",
+ "type" : "function",
+ "desc" : "Unsets an invalid handle id",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "anyMatch",
- "type" : "Boolean",
- "desc" : "True to match any part not just the beginning",
+ "name" : "id",
+ "type" : "string",
+ "desc" : "the id of the element to re-enable",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "removeInvalidHandleType",
+ "type" : "function",
+ "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
+ "sig" : "(tagName)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "MixedCollection",
- "desc" : "Returns an Roo.util.MixedCollection of the matched records"
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to unexclude",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "queryBy",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.",
- "sig" : "(fn, scope)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
"type" : "Function",
- "desc" : "The function to be called, it will receive 2 args (record, id)",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to this)",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "MixedCollection",
- "desc" : "Returns an Roo.util.MixedCollection of the matched records"
- }
- ]
+ "returns" : []
},
{
- "name" : "rejectChanges",
+ "name" : "resetConstraints",
"type" : "function",
- "desc" : "Cancel outstanding changes on all changed records.",
- "sig" : "()\n{\n\n}",
+ "desc" : "resetConstraints must be called if you manually reposition a dd element.",
+ "sig" : "(maintainOffset)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "maintainOffset",
+ "type" : "boolean",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "setDragElId",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "id",
+ "type" : "",
+ "desc" : "{string} the id of the element that will be used to initiate the drag",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "reload",
+ "name" : "setHandleElId",
"type" : "function",
- "desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.",
- "sig" : "(options)",
+ "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing properties which may override the options\nused in the last load operation. See {@link #load} for details (defaults to null, in which case\nthe most recently used options are reused).",
+ "name" : "id",
+ "type" : "",
+ "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "setInitPosition",
"type" : "function",
- "desc" : "Remove a Record from the Store and fires the remove event.",
- "sig" : "(record)",
+ "desc" : "Stores the initial placement of the linked element.",
+ "sig" : "(diffX, diffY)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "record",
- "type" : "Ext.data.Record",
- "desc" : "The Roo.data.Record object to remove from the cache.",
+ "name" : "diffX",
+ "type" : "int",
+ "desc" : "the X offset, default 0",
+ "isOptional" : false
+ },
+ {
+ "name" : "diffY",
+ "type" : "int",
+ "desc" : "the Y offset, default 0",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeAll",
+ "name" : "setOuterHandleElId",
"type" : "function",
- "desc" : "Remove all Records from the Store and fires the clear event.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the element that will be used to initiate the drag",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "setPadding",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
+ "sig" : "(iTop, iRight, iBot, iLeft)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "iTop",
+ "type" : "int",
+ "desc" : "Top pad",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "Right pad",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "iBot",
+ "type" : "int",
+ "desc" : "Bot pad",
+ "isOptional" : false
+ },
+ {
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "Left pad",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDefaultSort",
+ "name" : "setXConstraint",
"type" : "function",
- "desc" : "Sets the default sort column and order to be used by the next load operation.",
- "sig" : "(fieldName, dir)",
+ "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
+ "sig" : "(iLeft, iRight, iTickSize)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fieldName",
- "type" : "String",
- "desc" : "The name of the field to sort by.",
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the left",
"isOptional" : false
},
{
- "name" : "dir",
- "type" : "String",
- "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the\nright",
+ "isOptional" : false
+ },
+ {
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "sort",
+ "name" : "setYConstraint",
"type" : "function",
- "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.",
- "sig" : "(fieldName, dir)",
+ "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
+ "sig" : "(iUp, iDown, iTickSize)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fieldName",
- "type" : "String",
- "desc" : "The name of the field to sort by.",
+ "name" : "iUp",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move up",
"isOptional" : false
},
{
- "name" : "dir",
- "type" : "String",
- "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
+ "name" : "iDown",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move down",
+ "isOptional" : false
+ },
+ {
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "sum",
+ "name" : "startDrag",
"type" : "function",
- "desc" : "Sums the value of <i>property</i> for each record between start and end and returns the result.",
- "sig" : "(property, start, end)",
+ "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
+ "sig" : "(X, Y)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "property",
- "type" : "String",
- "desc" : "A field on your records",
- "isOptional" : false
- },
- {
- "name" : "start",
- "type" : "Number",
- "desc" : "The record index to start at (defaults to 0)",
+ "name" : "X",
+ "type" : "int",
+ "desc" : "click location",
"isOptional" : false
},
{
- "name" : "end",
- "type" : "Number",
- "desc" : "The last record index to include (defaults to length - 1)",
+ "name" : "Y",
+ "type" : "int",
+ "desc" : "click location",
"isOptional" : false
}
],
+ "returns" : []
+ },
+ {
+ "name" : "toString",
+ "type" : "function",
+ "desc" : "toString method",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "The sum"
+ "type" : "string",
+ "desc" : "string representation of the dd obj"
}
]
},
}
],
"returns" : []
+ },
+ {
+ "name" : "unlock",
+ "type" : "function",
+ "desc" : "Unlock this instace",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "unreg",
+ "type" : "function",
+ "desc" : "Remove all drag and drop hooks for this element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [
- "Roo.data.JsonStore",
- "Roo.data.SimpleStore"
+ "Roo.dd.DropZone"
],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.data.Tree" : {
+ "Roo.dd.DropZone" : {
"props" : [
+ {
+ "name" : "ddGroup",
+ "type" : "String",
+ "desc" : "The drag drop group to handle drop events for",
+ "memberOf" : "Roo.dd.DropTarget",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dropAllowed",
+ "type" : "String",
+ "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
+ "memberOf" : "Roo.dd.DropTarget",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dropNotAllowed",
+ "type" : "String",
+ "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
+ "memberOf" : "Roo.dd.DropTarget",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
+ },
+ {
+ "name" : "overClass",
+ "type" : "String",
+ "desc" : "The CSS class applied to the drop target element while the drag source is over it (defaults to \"\").",
+ "memberOf" : "Roo.dd.DropTarget",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "success",
+ "type" : "boolean",
+ "desc" : "set this after drop listener..",
+ "memberOf" : "Roo.dd.DropTarget",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "boolean|String",
+ "desc" : "true/false or string (ok-add/ok-sub/ok/nodrop)\nif the drop point is valid for over/enter..",
+ "memberOf" : "Roo.dd.DropTarget",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
- "name" : "append",
+ "name" : "drop",
"type" : "function",
- "desc" : "Fires when a new child node is appended to a node in this tree.",
- "sig" : "function (tree, parent, node, index)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the dragged item has\nbeen dropped on it. This method has no default implementation and returns false, so you must provide an\nimplementation that does something to process the drop event and returns true so that the drag source's\nrepair action does not run.\n\nIMPORTANT : it should set this.success",
+ "sig" : "function (source, e, data)\n{\n\n}",
+ "memberOf" : "Roo.dd.DropTarget",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "parent",
- "type" : "Node",
- "desc" : "The parent node",
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop target",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The newly appended node",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
"isOptional" : false
},
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the newly appended node",
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeappend",
+ "name" : "enter",
"type" : "function",
- "desc" : "Fires before a new child is appended to a node in this tree, return false to cancel the append.",
- "sig" : "function (tree, parent, node)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the\ntarget. This default implementation adds the CSS class specified by overClass (if any) to the drop element\nand returns the dropAllowed config value. This method should be overridden if drop validation is required.\n\nIMPORTANT : it should set this.valid to true|false",
+ "sig" : "function (source, e, data)\n{\n\n}",
+ "memberOf" : "Roo.dd.DropTarget",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop target",
"isOptional" : false
},
{
- "name" : "parent",
- "type" : "Node",
- "desc" : "The parent node",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node to be appended",
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeinsert",
+ "name" : "out",
"type" : "function",
- "desc" : "Fires before a new child is inserted in a node in this tree, return false to cancel the insert.",
- "sig" : "function (tree, parent, node, refNode)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged\nout of the target without dropping. This default implementation simply removes the CSS class specified by\noverClass (if any) from the drop element.",
+ "sig" : "function (source, e, data)\n{\n\n}",
+ "memberOf" : "Roo.dd.DropTarget",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "parent",
- "type" : "Node",
- "desc" : "The parent node",
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop target",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node to be inserted",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
"isOptional" : false
},
{
- "name" : "refNode",
- "type" : "Node",
- "desc" : "The child node the node is being inserted before",
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforemove",
+ "name" : "over",
"type" : "function",
- "desc" : "Fires before a node is moved to a new location in the tree. Return false to cancel the move.",
- "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.\nThis method will be called on every mouse movement while the drag source is over the drop target.\nThis default implementation simply returns the dropAllowed config value.\n\nIMPORTANT : it should set this.valid to true|false",
+ "sig" : "function (source, e, data)\n{\n\n}",
+ "memberOf" : "Roo.dd.DropTarget",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "The node being moved",
- "isOptional" : false
- },
- {
- "name" : "oldParent",
- "type" : "Node",
- "desc" : "The parent of the node",
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop target",
"isOptional" : false
},
{
- "name" : "newParent",
- "type" : "Node",
- "desc" : "The new parent the node is moving to",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
"isOptional" : false
},
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The index it is being moved to",
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "beforeremove",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Fires before a child is removed from a node in this tree, return false to cancel the remove.",
- "sig" : "function (tree, parent, node)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "parent",
- "type" : "Node",
- "desc" : "The parent node",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node to be removed",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "insert",
+ "name" : "addInvalidHandleClass",
"type" : "function",
- "desc" : "Fires when a new child node is inserted in a node in this tree.",
- "sig" : "function (tree, parent, node, refNode)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Lets you specify a css class of elements that will not initiate a drag",
+ "sig" : "(cssClass)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "parent",
- "type" : "Node",
- "desc" : "The parent node",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node inserted",
- "isOptional" : false
- },
- {
- "name" : "refNode",
- "type" : "Node",
- "desc" : "The child node the node was inserted before",
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the elements you wish to ignore",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "move",
+ "name" : "addInvalidHandleId",
"type" : "function",
- "desc" : "Fires when a node is moved to a new location in the tree",
- "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "The node moved",
- "isOptional" : false
- },
- {
- "name" : "oldParent",
- "type" : "Node",
- "desc" : "The old parent of this node",
- "isOptional" : false
- },
- {
- "name" : "newParent",
- "type" : "Node",
- "desc" : "The new parent of this node",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index it was moved to",
+ "name" : "id",
+ "type" : "string",
+ "desc" : "the element id of the element you wish to ignore",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "remove",
- "type" : "function",
- "desc" : "Fires when a child node is removed from a node in this tree.",
- "sig" : "function (tree, parent, node)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "parent",
- "type" : "Node",
- "desc" : "The parent node",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node removed",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "methods" : [
- {
- "name" : "addEvents",
+ "name" : "addInvalidHandleType",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
+ "sig" : "(tagName)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to exclude",
"isOptional" : false
}
],
],
"returns" : []
},
+ {
+ "name" : "addToGroup",
+ "type" : "function",
+ "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
+ "sig" : "(sGroup)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "sGroup",
+ "type" : "",
+ "desc" : "{string} the name of the group",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "applyConfig",
+ "type" : "function",
+ "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "clearConstraints",
+ "type" : "function",
+ "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "clearTicks",
+ "type" : "function",
+ "desc" : "Clears any tick interval defined for this instance",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "endDrag",
+ "type" : "function",
+ "desc" : "Fired when we are done dragging the object",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
]
},
{
- "name" : "getNodeById",
+ "name" : "getDragEl",
"type" : "function",
- "desc" : "Gets a node in this tree by its id.",
- "sig" : "(id)",
+ "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "id",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "the html element"
}
- ],
+ ]
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns a reference to the linked element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Node",
- "desc" : ""
+ "type" : "HTMLElement",
+ "desc" : "the html element"
}
]
},
{
- "name" : "getRootNode",
+ "name" : "getTargetFromEvent",
"type" : "function",
- "desc" : "Returns the root node for this tree.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns a custom data object associated with the DOM node that is the target of the event. By default\nthis looks up the event target in the {@link Roo.dd.Registry}, although you can override this method to\nprovide your own custom lookup.",
+ "sig" : "(e)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Node",
- "desc" : ""
+ "type" : "Object",
+ "desc" : "data The custom data"
}
]
},
]
},
{
- "name" : "on",
+ "name" : "init",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
+ "sig" : "(id, sGroup, config)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the linked element",
+ "isOptional" : false
+ },
+ {
+ "name" : "sGroup",
"type" : "String",
- "desc" : "The type of event to listen for",
+ "desc" : "the group of related items",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "config",
+ "type" : "object",
+ "desc" : "configuration attributes",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "initTarget",
+ "type" : "function",
+ "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
+ "sig" : "(id, sGroup, config)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the linked element",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "sGroup",
+ "type" : "String",
+ "desc" : "the group of related items",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "config",
+ "type" : "object",
+ "desc" : "configuration attributes",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "isLocked",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "boolean",
+ "desc" : "true if this obj or all drag/drop is locked, else\nfalse"
+ }
+ ]
+ },
+ {
+ "name" : "isTarget",
+ "type" : "function",
+ "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "isValidHandleChild",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Checks the tag exclusion list to see if this click should be ignored",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "node",
+ "type" : "HTMLElement",
+ "desc" : "the HTMLElement to evaluate",
"isOptional" : false
}
],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "boolean",
+ "desc" : "true if this is a valid tag type, false if not"
+ }
+ ]
+ },
+ {
+ "name" : "lock",
+ "type" : "function",
+ "desc" : "Lock this instance",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "notifyDrop",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the dragged item has\nbeen dropped on it. The drag zone will look up the target node based on the event passed in, and if there\nis a node registered for that event, it will delegate to {@link #onNodeDrop} for node-specific handling,\notherwise it will call {@link #onContainerDrop}.",
+ "sig" : "(source, e, data)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop zone",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
"isOptional" : false
},
{
- "name" : "scope",
+ "name" : "data",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the drop was valid, else false"
+ }
+ ]
},
{
- "name" : "setRootNode",
+ "name" : "notifyEnter",
"type" : "function",
- "desc" : "Sets the root node for this tree.",
- "sig" : "(node)",
+ "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the source is now over\nthe zone. The default implementation returns this.dropNotAllowed and expects that only registered drop\nnodes can process drag drop operations, so if you need the drop zone itself to be able to process drops\nyou should override this method and provide a custom implementation.",
+ "sig" : "(source, e, data)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "Node",
- "desc" : "",
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop zone",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Node",
- "desc" : ""
+ "type" : "String",
+ "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated"
}
]
},
{
- "name" : "un",
+ "name" : "notifyOut",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the source has been dragged\nout of the zone without dropping. If the drag source is currently over a registered node, the notification\nwill be delegated to {@link #onNodeOut} for node-specific handling, otherwise it will be ignored.",
+ "sig" : "(source, e, data)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop target",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
"isOptional" : false
},
{
- "name" : "scope",
+ "name" : "data",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "An object containing arbitrary data supplied by the drag zone",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.tree.ColumnTree",
- "Roo.tree.TreePanel"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.XmlReader" : {
- "props" : [
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The DomQuery path relative from the record element to the element that contains\na record identifier value.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "record",
- "type" : "String",
- "desc" : "The DomQuery path to the repeated element which contains record information.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "success",
- "type" : "String",
- "desc" : "The DomQuery path to the success attribute used by forms.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
},
{
- "name" : "totalRecords",
- "type" : "String",
- "desc" : "The DomQuery path from which to retrieve the total number of records\nin the dataset. This is only needed if the whole dataset is not passed in one go, but is being\npaged from the remote server.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
- {
- "name" : "newRow",
+ "name" : "notifyOver",
"type" : "function",
- "desc" : "Create an empty record",
- "sig" : "(data)",
+ "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the drop zone.\nThis method will be called on every mouse movement while the drag source is over the drop zone.\nIt will call {@link #onNodeOver} while the drag source is over a registered node, and will also automatically\ndelegate to the appropriate node-specific methods as necessary when the drag source enters and exits\nregistered nodes ({@link #onNodeEnter}, {@link #onNodeOut}). If the drag source is not currently over a\nregistered node, it will call {@link #onContainerOver}.",
+ "sig" : "(source, e, data)",
"static" : false,
- "memberOf" : "Roo.data.DataReader",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [
+ {
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop zone",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ },
{
"name" : "data",
"type" : "Object",
- "desc" : "(optional) - overlay some values",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.data.Record",
- "desc" : "record created."
+ "type" : "String",
+ "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated"
}
]
},
{
- "name" : "read",
+ "name" : "on",
"type" : "function",
- "desc" : "This method is only used by a DataProxy which has retrieved data from a remote server.",
- "sig" : "(response)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "onAvailable",
+ "type" : "function",
+ "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "onContainerDrop",
+ "type" : "function",
+ "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dropped on it,\nbut not on any of its registered drop nodes. The default implementation returns false, so it should be\noverridden to provide the appropriate processing of the drop event if you need the drop zone itself to\nbe able to accept drops. It should return true when valid so that the drag source's repair action does not run.",
+ "sig" : "(source, e, data)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "response",
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop zone",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
"type" : "Object",
- "desc" : "The XHR object which contains the parsed XML document. The response is expected\nto contain a method called 'responseXML' that returns an XML document object.",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "records A data block which is used by an {@link Roo.data.Store} as\na cache of Roo.data.Records."
+ "type" : "Boolean",
+ "desc" : "True if the drop was valid, else false"
}
]
},
{
- "name" : "readRecords",
+ "name" : "onContainerOver",
"type" : "function",
- "desc" : "Create a data block containing Roo.data.Records from an XML document.",
- "sig" : "(doc)",
+ "desc" : "Called internally while the DropZone determines that a {@link Roo.dd.DragSource} is being dragged over it,\nbut not over any of its registered drop nodes. The default implementation returns this.dropNotAllowed, so\nit should be overridden to provide the proper feedback if necessary.",
+ "sig" : "(source, e, data)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "doc",
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop zone",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
"type" : "Object",
- "desc" : "A parsed XML document.",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "records A data block which is used by an {@link Roo.data.Store} as\na cache of Roo.data.Records."
+ "type" : "String",
+ "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated"
}
]
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.dd" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.dd.DD" : {
- "props" : [
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "addEvents",
+ "name" : "onDrag",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addInvalidHandleClass",
+ "name" : "onDragDrop",
"type" : "function",
- "desc" : "Lets you specify a css class of elements that will not initiate a drag",
- "sig" : "(cssClass)",
+ "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
+ "sig" : "(e, id)",
"static" : false,
"memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the elements you wish to ignore",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addInvalidHandleId",
+ "name" : "onDragEnter",
"type" : "function",
- "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
- "sig" : "(id)",
+ "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
+ "sig" : "(e, id)",
"static" : false,
"memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"exceptions" : "",
"requires" : "",
"params" : [
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
+ "isOptional" : false
+ },
{
"name" : "id",
- "type" : "string",
- "desc" : "the element id of the element you wish to ignore",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addInvalidHandleType",
+ "name" : "onDragOut",
"type" : "function",
- "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
- "sig" : "(tagName)",
+ "desc" : "Abstract method called when we are no longer hovering over an element",
+ "sig" : "(e, id)",
"static" : false,
"memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to exclude",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "onDragOver",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "onInvalidDrop",
+ "type" : "function",
+ "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "onMouseDown",
+ "type" : "function",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousedown event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addToGroup",
+ "name" : "onMouseUp",
"type" : "function",
- "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
- "sig" : "(sGroup)",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
+ "sig" : "(e)",
"static" : false,
"memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "sGroup",
- "type" : "",
- "desc" : "{string} the name of the group",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "alignElWithMouse",
+ "name" : "onNodeDrop",
"type" : "function",
- "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
- "sig" : "(el, iPageX, iPageY)",
+ "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dropped onto\nthe drop node. The default implementation returns false, so it should be overridden to provide the\nappropriate processing of the drop event and return true so that the drag source's repair action does not run.",
+ "sig" : "(nodeData, source, e, data)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "HTMLElement",
- "desc" : "the element to move",
+ "name" : "nodeData",
+ "type" : "Object",
+ "desc" : "The custom data associated with the drop node (this is the same value returned from\n{@link #getTargetFromEvent} for this node)",
"isOptional" : false
},
{
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the mousedown or drag event",
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop zone",
"isOptional" : false
},
{
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the mousedown or drag event",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the drop was valid, else false"
+ }
+ ]
},
{
- "name" : "applyConfig",
+ "name" : "onNodeEnter",
"type" : "function",
- "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has entered a drop node\nthat it has registered. This method has no default implementation and should be overridden to provide\nnode-specific processing if necessary.",
+ "sig" : "(nodeData, source, e, data)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "nodeData",
+ "type" : "Object",
+ "desc" : "The custom data associated with the drop node (this is the same value returned from \n{@link #getTargetFromEvent} for this node)",
+ "isOptional" : false
+ },
+ {
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop zone",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "autoOffset",
+ "name" : "onNodeOut",
"type" : "function",
- "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked",
- "sig" : "(iPageX, iPageY)",
+ "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dragged out of\nthe drop node without dropping. This method has no default implementation and should be overridden to provide\nnode-specific processing if necessary.",
+ "sig" : "(nodeData, source, e, data)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the click",
+ "name" : "nodeData",
+ "type" : "Object",
+ "desc" : "The custom data associated with the drop node (this is the same value returned from\n{@link #getTargetFromEvent} for this node)",
"isOptional" : false
},
{
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the click",
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop zone",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "cachePosition",
+ "name" : "onNodeOver",
"type" : "function",
- "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.",
- "sig" : "(iPageX, iPageY)",
+ "desc" : "Called internally while the DropZone determines that a {@link Roo.dd.DragSource} is over a drop node\nthat it has registered. The default implementation returns this.dropNotAllowed, so it should be\noverridden to provide the proper feedback.",
+ "sig" : "(nodeData, source, e, data)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "iPageX",
- "type" : "",
- "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)",
+ "name" : "nodeData",
+ "type" : "Object",
+ "desc" : "The custom data associated with the drop node (this is the same value returned from\n{@link #getTargetFromEvent} for this node)",
"isOptional" : false
},
{
- "name" : "iPageY",
- "type" : "",
- "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)",
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop zone",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
"isOptional" : false
}
],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated"
+ }
+ ]
+ },
+ {
+ "name" : "padding",
+ "type" : "function",
+ "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
"static" : true,
"memberOf" : "Roo.util.Observable",
"isStatic" : true,
{
"name" : "o",
"type" : "Observable",
- "desc" : "The Observable to capture",
+ "desc" : "The Observable to release",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeFromGroup",
+ "type" : "function",
+ "desc" : "Remove's this instance from the supplied interaction group",
+ "sig" : "(sGroup)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "sGroup",
+ "type" : "string",
+ "desc" : "The group to drop",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeInvalidHandleClass",
+ "type" : "function",
+ "desc" : "Unsets an invalid css class",
+ "sig" : "(cssClass)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the element(s) you wish to\nre-enable",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "clearConstraints",
+ "name" : "removeInvalidHandleId",
"type" : "function",
- "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Unsets an invalid handle id",
+ "sig" : "(id)",
"static" : false,
"memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "string",
+ "desc" : "the id of the element to re-enable",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "clearTicks",
+ "name" : "removeInvalidHandleType",
"type" : "function",
- "desc" : "Clears any tick interval defined for this instance",
- "sig" : "()\n{\n\n}",
+ "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
+ "sig" : "(tagName)",
"static" : false,
"memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to unexclude",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "endDrag",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Fired when we are done dragging the object",
- "sig" : "(e)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "resetConstraints",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "resetConstraints must be called if you manually reposition a dd element.",
+ "sig" : "(maintainOffset)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
+ "name" : "maintainOffset",
+ "type" : "boolean",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
},
{
- "name" : "getDragEl",
+ "name" : "setDragElId",
"type" : "function",
- "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
- "sig" : "()\n{\n\n}",
+ "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
+ "sig" : "(id)",
"static" : false,
"memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "HTMLElement",
- "desc" : "the html element"
+ "name" : "id",
+ "type" : "",
+ "desc" : "{string} the id of the element that will be used to initiate the drag",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getEl",
+ "name" : "setHandleElId",
"type" : "function",
- "desc" : "Returns a reference to the linked element",
- "sig" : "()\n{\n\n}",
+ "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
+ "sig" : "(id)",
"static" : false,
"memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "HTMLElement",
- "desc" : "the html element"
+ "name" : "id",
+ "type" : "",
+ "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "setInitPosition",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Stores the initial placement of the linked element.",
+ "sig" : "(diffX, diffY)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "diffX",
+ "type" : "int",
+ "desc" : "the X offset, default 0",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "name" : "diffY",
+ "type" : "int",
+ "desc" : "the Y offset, default 0",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "init",
+ "name" : "setOuterHandleElId",
"type" : "function",
- "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
- "sig" : "(id, sGroup, config)",
+ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
+ "sig" : "(id)",
"static" : false,
"memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
{
"name" : "id",
"type" : "",
- "desc" : "the id of the linked element",
- "isOptional" : false
- },
- {
- "name" : "sGroup",
- "type" : "String",
- "desc" : "the group of related items",
- "isOptional" : false
- },
- {
- "name" : "config",
- "type" : "object",
- "desc" : "configuration attributes",
+ "desc" : "the id of the element that will be used to initiate the drag",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "initTarget",
+ "name" : "setPadding",
"type" : "function",
- "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
- "sig" : "(id, sGroup, config)",
+ "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
+ "sig" : "(iTop, iRight, iBot, iLeft)",
"static" : false,
"memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "the id of the linked element",
+ "name" : "iTop",
+ "type" : "int",
+ "desc" : "Top pad",
"isOptional" : false
},
{
- "name" : "sGroup",
- "type" : "String",
- "desc" : "the group of related items",
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "Right pad",
"isOptional" : false
},
{
- "name" : "config",
- "type" : "object",
- "desc" : "configuration attributes",
+ "name" : "iBot",
+ "type" : "int",
+ "desc" : "Bot pad",
+ "isOptional" : false
+ },
+ {
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "Left pad",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "isLocked",
+ "name" : "setXConstraint",
"type" : "function",
- "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
- "sig" : "()\n{\n\n}",
+ "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
+ "sig" : "(iLeft, iRight, iTickSize)",
"static" : false,
"memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "boolean",
- "desc" : "true if this obj or all drag/drop is locked, else\nfalse"
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the left",
+ "isOptional" : false
+ },
+ {
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the\nright",
+ "isOptional" : false
+ },
+ {
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "isTarget",
+ "name" : "setYConstraint",
"type" : "function",
- "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
- "sig" : "()\n{\n\n}",
+ "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
+ "sig" : "(iUp, iDown, iTickSize)",
"static" : false,
"memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "iUp",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move up",
+ "isOptional" : false
+ },
+ {
+ "name" : "iDown",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move down",
+ "isOptional" : false
+ },
+ {
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "isValidHandleChild",
+ "name" : "startDrag",
"type" : "function",
- "desc" : "Checks the tag exclusion list to see if this click should be ignored",
- "sig" : "(node)",
+ "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
+ "sig" : "(X, Y)",
"static" : false,
"memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "HTMLElement",
- "desc" : "the HTMLElement to evaluate",
+ "name" : "X",
+ "type" : "int",
+ "desc" : "click location",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "boolean",
- "desc" : "true if this is a valid tag type, false if not"
+ "name" : "Y",
+ "type" : "int",
+ "desc" : "click location",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "lock",
+ "name" : "toString",
"type" : "function",
- "desc" : "Lock this instance",
+ "desc" : "toString method",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.dd.DragDrop",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "string",
+ "desc" : "string representation of the dd obj"
+ }
+ ]
},
{
- "name" : "on",
+ "name" : "un",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onAvailable",
+ "name" : "unlock",
"type" : "function",
- "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
+ "desc" : "Unlock this instace",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.dd.DragDrop",
"returns" : []
},
{
- "name" : "onDrag",
+ "name" : "unreg",
"type" : "function",
- "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
- "sig" : "(e)",
+ "desc" : "Remove all drag and drop hooks for this element",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.dd.Registry" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "onDragDrop",
+ "name" : "getHandle",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
- "sig" : "(e, id)",
+ "desc" : "Returns the handle registered for a DOM Node by id",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
- "isOptional" : false
- },
{
"name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.",
+ "type" : "String|HTMLElement",
+ "desc" : "The DOM node or id to look up",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "onDragEnter",
- "type" : "function",
- "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
- "sig" : "(e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- },
+ "returns" : [
{
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "handle The custom handle data"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "onDragOut",
+ "name" : "getHandleFromEvent",
"type" : "function",
- "desc" : "Abstract method called when we are no longer hovering over an element",
- "sig" : "(e, id)",
+ "desc" : "Returns the handle that is registered for the DOM node that is the target of the event",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "e",
"type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.",
+ "desc" : "The event",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "handle The custom handle data"
+ }
+ ]
},
{
- "name" : "onDragOver",
+ "name" : "getTarget",
"type" : "function",
- "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
- "sig" : "(e, id)",
+ "desc" : "Returns a custom data object that is registered for a DOM node by id",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- },
{
"name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.",
+ "type" : "String|HTMLElement",
+ "desc" : "The DOM node or id to look up",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "data The custom data"
+ }
+ ]
},
{
- "name" : "onInvalidDrop",
+ "name" : "getTargetFromEvent",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
+ "desc" : "Returns a custom data object that is registered for the DOM node that is the target of the event",
"sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "e",
"type" : "Event",
- "desc" : "the mouseup event",
+ "desc" : "The event",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "data The custom data"
+ }
+ ]
},
{
- "name" : "onMouseDown",
+ "name" : "register",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
- "sig" : "(e)",
+ "desc" : "Register a drag drop element",
+ "sig" : "(element, data)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousedown event",
+ "name" : "element",
+ "type" : "String|HTMLElement",
+ "desc" : "The id or DOM node to register",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "(optional) A custom data object that will be passed between the elements that are involved\nin drag drop operations. You can populate this object with any arbitrary properties that your own code\nknows how to interpret, plus there are some specific properties known to the Registry that should be\npopulated in the data object (if applicable):\n<pre>\nValue Description<br />\n--------- ------------------------------------------<br />\nhandles Array of DOM nodes that trigger dragging<br />\n for the element being registered<br />\nisHandle True if the element passed in triggers<br />\n dragging itself, else false\n</pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onMouseUp",
+ "name" : "unregister",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
- "sig" : "(e)",
+ "desc" : "Unregister a drag drop element",
+ "sig" : "(element)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "element",
+ "type" : "String|HTMLElement",
+ "desc" : "The id or DOM node to unregister",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.dd.ScrollManager" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "padding",
+ "name" : "refreshCache",
"type" : "function",
- "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
+ "desc" : "Manually trigger a cache refresh.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "register",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Registers new overflow element(s) to auto scroll",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element/Array",
+ "desc" : "The id of or the element to be scrolled or an array of either",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeFromGroup",
+ "name" : "unregister",
"type" : "function",
- "desc" : "Remove's this instance from the supplied interaction group",
- "sig" : "(sGroup)",
+ "desc" : "Unregisters overflow element(s) so they are no longer scrolled",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "sGroup",
- "type" : "string",
- "desc" : "The group to drop",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element/Array",
+ "desc" : "The id of or the element to be removed or an array of either",
"isOptional" : false
}
],
"returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.dd.StatusProxy" : {
+ "props" : [
+ {
+ "name" : "dropAllowed",
+ "type" : "String",
+ "desc" : "The CSS class to apply to the status element when drop is allowed (defaults to \"x-dd-drop-ok\").",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "removeInvalidHandleClass",
+ "name" : "dropNotAllowed",
+ "type" : "String",
+ "desc" : "The CSS class to apply to the status element when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "getEl",
"type" : "function",
- "desc" : "Unsets an invalid css class",
- "sig" : "(cssClass)",
+ "desc" : "Returns the underlying proxy {@link Roo.Layer}",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the element(s) you wish to\nre-enable",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Layer",
+ "desc" : "el"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "removeInvalidHandleId",
+ "name" : "getGhost",
"type" : "function",
- "desc" : "Unsets an invalid handle id",
- "sig" : "(id)",
+ "desc" : "Returns the ghost element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "id",
- "type" : "string",
- "desc" : "the id of the element to re-enable",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "el"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "removeInvalidHandleType",
+ "name" : "hide",
"type" : "function",
- "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
- "sig" : "(tagName)",
+ "desc" : "Hides the proxy",
+ "sig" : "(clear)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to unexclude",
+ "name" : "clear",
+ "type" : "Boolean",
+ "desc" : "True to reset the status and clear the ghost contents, false to preserve them",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "repair",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Causes the proxy to return to its position of origin via an animation. Should be called after an\ninvalid drop operation by the item being dragged.",
+ "sig" : "(xy, callback, scope)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "xy",
+ "type" : "Array",
+ "desc" : "The XY position of the element ([x, y])",
"isOptional" : false
},
{
- "name" : "handler",
+ "name" : "callback",
"type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "The function to call after the repair is complete",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "The scope in which to execute the callback",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resetConstraints",
+ "name" : "reset",
"type" : "function",
- "desc" : "resetConstraints must be called if you manually reposition a dd element.",
- "sig" : "(maintainOffset)",
+ "desc" : "Resets the status indicator to the default dropNotAllowed value",
+ "sig" : "(clearGhost)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "maintainOffset",
- "type" : "boolean",
- "desc" : "",
+ "name" : "clearGhost",
+ "type" : "Boolean",
+ "desc" : "True to also remove all content from the ghost, false to preserve it",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDelta",
+ "name" : "setStatus",
"type" : "function",
- "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)",
- "sig" : "(iDeltaX, iDeltaY)",
+ "desc" : "Updates the proxy's visual element to indicate the status of whether or not drop is allowed\nover the current target element.",
+ "sig" : "(cssClass)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "iDeltaX",
- "type" : "int",
- "desc" : "the distance from the left",
- "isOptional" : false
- },
- {
- "name" : "iDeltaY",
- "type" : "int",
- "desc" : "the distance from the top",
+ "name" : "cssClass",
+ "type" : "String",
+ "desc" : "The css class for the new drop status indicator image",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDragElId",
+ "name" : "show",
"type" : "function",
- "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
- "sig" : "(id)",
+ "desc" : "Displays this proxy",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "",
- "desc" : "{string} the id of the element that will be used to initiate the drag",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setDragElPos",
+ "name" : "stop",
"type" : "function",
- "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
- "sig" : "(iPageX, iPageY)",
+ "desc" : "Stops the repair animation if it's currently running",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the mousedown or drag event",
- "isOptional" : false
- },
- {
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the mousedown or drag event",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setHandleElId",
+ "name" : "sync",
"type" : "function",
- "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
- "sig" : "(id)",
+ "desc" : "Force the Layer to sync its shadow and shim positions to the element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "",
- "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setInitPosition",
+ "name" : "update",
"type" : "function",
- "desc" : "Stores the initial placement of the linked element.",
- "sig" : "(diffX, diffY)",
+ "desc" : "Updates the contents of the ghost element",
+ "sig" : "(html)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "diffX",
- "type" : "int",
- "desc" : "the X offset, default 0",
- "isOptional" : false
- },
- {
- "name" : "diffY",
- "type" : "int",
- "desc" : "the Y offset, default 0",
+ "name" : "html",
+ "type" : "String",
+ "desc" : "The html that will replace the current innerHTML of the ghost element",
"isOptional" : false
}
],
"returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.form" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.form.Action" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.form.BasicForm" : {
+ "props" : [
+ {
+ "name" : "baseParams",
+ "type" : "Object",
+ "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "setOuterHandleElId",
+ "name" : "errorMask",
+ "type" : "Boolean",
+ "desc" : "Should the form be masked (and the active element highlighted on error - default false",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "errorReader",
+ "type" : "DataReader",
+ "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when reading validation errors on \"submit\" actions.\nThis is completely optional as there is built-in support for processing JSON.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fileUpload",
+ "type" : "Boolean",
+ "desc" : "Set to true if this form is a file upload.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maskOffset",
+ "type" : "Number",
+ "desc" : "space around form element to mask if there is an error Default 100",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "method",
+ "type" : "String",
+ "desc" : "The request method to use (GET or POST) for form actions if one isn't supplied in the action options.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "reader",
+ "type" : "DataReader",
+ "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when executing \"load\" actions.\nThis is optional as there is built-in support for processing JSON.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "timeout",
+ "type" : "Number",
+ "desc" : "Timeout for form actions in seconds (default is 30 seconds).",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "trackResetOnLoad",
+ "type" : "Boolean",
+ "desc" : "If set to true, form.reset() resets to the last loaded\nor setValues() data instead of when the form was first created.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "url",
+ "type" : "String",
+ "desc" : "The URL to use for form actions if one isn't supplied in the action options.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "actioncomplete",
"type" : "function",
- "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when an action is completed.",
+ "sig" : "function (_self, action)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "the id of the element that will be used to initiate the drag",
+ "name" : "this",
+ "type" : "Form",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "action",
+ "type" : "Action",
+ "desc" : "The action that completed",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setPadding",
+ "name" : "actionfailed",
"type" : "function",
- "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
- "sig" : "(iTop, iRight, iBot, iLeft)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when an action fails.",
+ "sig" : "function (_self, action)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "iTop",
- "type" : "int",
- "desc" : "Top pad",
- "isOptional" : false
- },
- {
- "name" : "iRight",
- "type" : "int",
- "desc" : "Right pad",
- "isOptional" : false
- },
- {
- "name" : "iBot",
- "type" : "int",
- "desc" : "Bot pad",
+ "name" : "this",
+ "type" : "Form",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "iLeft",
- "type" : "int",
- "desc" : "Left pad",
+ "name" : "action",
+ "type" : "Action",
+ "desc" : "The action that failed",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setXConstraint",
+ "name" : "beforeaction",
"type" : "function",
- "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
- "sig" : "(iLeft, iRight, iTickSize)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before any action is performed. Return false to cancel the action.",
+ "sig" : "function (_self, action)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "iLeft",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the left",
- "isOptional" : false
- },
- {
- "name" : "iRight",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the\nright",
+ "name" : "this",
+ "type" : "Form",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
+ "name" : "action",
+ "type" : "Action",
+ "desc" : "The action to be performed",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "setYConstraint",
+ "name" : "add",
"type" : "function",
- "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
- "sig" : "(iUp, iDown, iTickSize)",
+ "desc" : "Add Roo.form components to this form.",
+ "sig" : "(field1, field2, etc)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iUp",
- "type" : "int",
- "desc" : "the number of pixels the element can move up",
+ "name" : "field1",
+ "type" : "Field",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "iDown",
- "type" : "int",
- "desc" : "the number of pixels the element can move down",
+ "name" : "field2",
+ "type" : "Field",
+ "desc" : "(optional)",
"isOptional" : false
},
{
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
+ "name" : "etc",
+ "type" : "Field",
+ "desc" : "(optional)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "startDrag",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
- "sig" : "(X, Y)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "X",
- "type" : "int",
- "desc" : "click location",
- "isOptional" : false
- },
- {
- "name" : "Y",
- "type" : "int",
- "desc" : "click location",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "toString",
+ "name" : "addForm",
"type" : "function",
- "desc" : "toString method",
- "sig" : "()\n{\n\n}",
+ "desc" : "Add a secondary form to this one, \nUsed to provide tabbed forms. One form is primary, with hidden values \nwhich mirror the elements from the other forms.",
+ "sig" : "(form)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "string",
- "desc" : "string representation of the dd obj"
+ "name" : "form",
+ "type" : "Roo.form.Form",
+ "desc" : "to add.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "un",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "unlock",
+ "name" : "applyIfToFields",
"type" : "function",
- "desc" : "Unlock this instace",
- "sig" : "()\n{\n\n}",
+ "desc" : "Calls {@link Ext#applyIf} for all field in this form with the passed object.",
+ "sig" : "(values)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "unreg",
+ "name" : "applyToFields",
"type" : "function",
- "desc" : "Remove all drag and drop hooks for this element",
- "sig" : "()\n{\n\n}",
+ "desc" : "Calls {@link Ext#apply} for all fields in this form with the passed object.",
+ "sig" : "(values)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.dd.DDProxy",
- "Roo.dd.DragSource",
- "Roo.dd.DragZone",
- "Roo.grid.SplitDragZone"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.dd.DDProxy" : {
- "props" : [
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
+ "params" : [
+ {
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
+ },
{
- "name" : "addEvents",
+ "name" : "capture",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
"memberOf" : "Roo.util.Observable",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "object",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
"type" : "Object",
- "desc" : "The object with the events defined",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addInvalidHandleClass",
+ "name" : "clearInvalid",
"type" : "function",
- "desc" : "Lets you specify a css class of elements that will not initiate a drag",
- "sig" : "(cssClass)",
+ "desc" : "Clears all invalid messages in this form.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the elements you wish to ignore",
- "isOptional" : false
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "addInvalidHandleId",
+ "name" : "doAction",
"type" : "function",
- "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
- "sig" : "(id)",
+ "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.",
+ "sig" : "(actionName, options)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "string",
- "desc" : "the element id of the element you wish to ignore",
+ "name" : "actionName",
+ "type" : "String",
+ "desc" : "The name of the action type",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) The options to pass to the action. All of the config options listed\nbelow are supported by both the submit and load actions unless otherwise noted (custom actions could also\naccept other config options):\n<pre>\nProperty Type Description\n---------------- --------------- ----------------------------------------------------------------------------------\nurl String The url for the action (defaults to the form's url)\nmethod String The form method to use (defaults to the form's method, or POST if not defined)\nparams String/Object The params to pass (defaults to the form's baseParams, or none if not defined)\nclientValidation Boolean Applies to submit only. Pass true to call form.isValid() prior to posting to\n validate the form on the client (defaults to false)\n</pre>",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "addInvalidHandleType",
+ "name" : "findField",
"type" : "function",
- "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
- "sig" : "(tagName)",
+ "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to exclude",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The value to search for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "",
+ "desc" : "Field"
+ }
+ ]
},
{
- "name" : "addListener",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "addToGroup",
+ "name" : "getFieldValues",
"type" : "function",
- "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
- "sig" : "(sGroup)",
+ "desc" : "Returns the fields in this form as an object with key/value pairs. \nThis differs from getValues as it calls getValue on each child item, rather than using dom data.\nNormally this will not return readOnly data",
+ "sig" : "(with_readonly)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "sGroup",
- "type" : "",
- "desc" : "{string} the name of the group",
+ "name" : "with_readonly",
+ "type" : "Boolean",
+ "desc" : "return readonly field data.",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "alignElWithMouse",
+ "name" : "getValues",
"type" : "function",
- "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
- "sig" : "(el, iPageX, iPageY)",
+ "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.",
+ "sig" : "(asString)",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "HTMLElement",
- "desc" : "the element to move",
- "isOptional" : false
- },
- {
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the mousedown or drag event",
- "isOptional" : false
- },
- {
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the mousedown or drag event",
+ "name" : "asString",
+ "type" : "Boolean",
+ "desc" : "(def)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "applyConfig",
+ "name" : "hasChanged",
"type" : "function",
- "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
+ "desc" : "Returns true if any fields in this form have changed since their original load. (New version)",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "",
+ "desc" : "Boolean"
+ }
+ ]
},
{
- "name" : "autoOffset",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked",
- "sig" : "(iPageX, iPageY)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the click",
- "isOptional" : false
- },
- {
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the click",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "cachePosition",
+ "name" : "invalidFields",
"type" : "function",
- "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.",
- "sig" : "(iPageX, iPageY)",
+ "desc" : "Returns array of invalid form fields.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "iPageX",
- "type" : "",
- "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "iPageY",
+ "name" : "",
"type" : "",
- "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)",
- "isOptional" : false
+ "desc" : "Array"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "capture",
+ "name" : "isDirty",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "DEPRICATED Returns true if any fields in this form have changed since their original load.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
+ "name" : "",
+ "type" : "",
+ "desc" : "Boolean"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "clearConstraints",
+ "name" : "isValid",
"type" : "function",
- "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.",
+ "desc" : "Returns true if client-side validation on the form is successful.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "",
+ "desc" : "Boolean"
+ }
+ ]
},
{
- "name" : "clearTicks",
+ "name" : "load",
"type" : "function",
- "desc" : "Clears any tick interval defined for this instance",
- "sig" : "()\n{\n\n}",
+ "desc" : "Shortcut to do a load action.",
+ "sig" : "(options)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The options to pass to the action (see {@link #doAction} for details)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "createFrame",
+ "name" : "loadRecord",
"type" : "function",
- "desc" : "Creates the proxy element if it does not yet exist",
- "sig" : "()\n{\n\n}",
+ "desc" : "Loads an Roo.data.Record into this form.",
+ "sig" : "(record)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "record",
+ "type" : "Record",
+ "desc" : "The record to load",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "endDrag",
+ "name" : "markInvalid",
"type" : "function",
- "desc" : "Fired when we are done dragging the object",
- "sig" : "(e)",
+ "desc" : "Mark fields in this form invalid in bulk.",
+ "sig" : "(errors)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "errors",
+ "type" : "Array/Object",
+ "desc" : "Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "fireEvent",
+ "name" : "on",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getDragEl",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "HTMLElement",
- "desc" : "the html element"
- }
- ]
+ "returns" : []
},
{
- "name" : "getEl",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Returns a reference to the linked element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "HTMLElement",
- "desc" : "the html element"
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "remove",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Removes a field from the items collection (does NOT remove its markup).",
+ "sig" : "(field)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "field",
+ "type" : "Field",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "BasicForm",
+ "desc" : "this"
}
]
},
{
- "name" : "init",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
- "sig" : "(id, sGroup, config)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "the id of the linked element",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "sGroup",
- "type" : "String",
- "desc" : "the group of related items",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "config",
- "type" : "object",
- "desc" : "configuration attributes",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "initFrame",
+ "name" : "render",
"type" : "function",
- "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses",
+ "desc" : "Looks at the fields in this form, checks them for an id attribute,\nand calls applyTo on the existing dom element with that id.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
- },
- {
- "name" : "initTarget",
- "type" : "function",
- "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
- "sig" : "(id, sGroup, config)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "",
- "desc" : "the id of the linked element",
- "isOptional" : false
- },
- {
- "name" : "sGroup",
- "type" : "String",
- "desc" : "the group of related items",
- "isOptional" : false
- },
+ "returns" : [
{
- "name" : "config",
- "type" : "object",
- "desc" : "configuration attributes",
- "isOptional" : false
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "isLocked",
+ "name" : "reset",
"type" : "function",
- "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
+ "desc" : "Resets this form.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "boolean",
- "desc" : "true if this obj or all drag/drop is locked, else\nfalse"
+ "type" : "BasicForm",
+ "desc" : "this"
}
]
},
{
- "name" : "isTarget",
+ "name" : "resetHasChanged",
"type" : "function",
- "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
+ "desc" : "Resets all hasChanged to 'false' -\nThe old 'isDirty' used 'original value..' however this breaks reset() and a few other things.\nSo hasChanged storage is only to be used for this purpose",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "",
+ "desc" : "Boolean"
+ }
+ ]
},
{
- "name" : "isValidHandleChild",
+ "name" : "setValues",
"type" : "function",
- "desc" : "Checks the tag exclusion list to see if this click should be ignored",
- "sig" : "(node)",
+ "desc" : "Set values for fields in this form in bulk.",
+ "sig" : "(values)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "HTMLElement",
- "desc" : "the HTMLElement to evaluate",
+ "name" : "values",
+ "type" : "Array/Object",
+ "desc" : "Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "boolean",
- "desc" : "true if this is a valid tag type, false if not"
+ "type" : "BasicForm",
+ "desc" : "this"
}
]
},
{
- "name" : "lock",
+ "name" : "submit",
"type" : "function",
- "desc" : "Lock this instance",
- "sig" : "()\n{\n\n}",
+ "desc" : "Shortcut to do a submit action.",
+ "sig" : "(options)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The options to pass to the action (see {@link #doAction} for details)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "on",
+ "name" : "un",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "updateRecord",
+ "type" : "function",
+ "desc" : "Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.",
+ "sig" : "(record)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "record",
+ "type" : "Record",
+ "desc" : "The record to edit",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.form.Form"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.form.Checkbox" : {
+ "props" : [
+ {
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoCreate",
+ "type" : "String/Object",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "boxLabel",
+ "type" : "String",
+ "desc" : "The text that appears beside the checkbox",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "checked",
+ "type" : "Boolean",
+ "desc" : "True if the the checkbox should render already checked (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "A CSS class to apply to the field's underlying element.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "True to disable the field (defaults to false).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldClass",
+ "type" : "String",
+ "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "String",
+ "desc" : "Label to use when rendering a form.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "height (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "inputValue",
+ "type" : "String",
+ "desc" : "The value that should go into the generated input element's value attribute",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "msgFx",
+ "type" : "String",
+ "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "msgTarget",
+ "type" : "String",
+ "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The field's HTML name attribute.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "qtip",
+ "type" : "String",
+ "desc" : "Mouse over tip",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tabIndex",
+ "type" : "Number",
+ "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "A value to initialize this field with.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "valueOff",
+ "type" : "String",
+ "desc" : "The value that should go into the generated input element's value when unchecked.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "onAvailable",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "width (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "onDrag",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onDragDrop",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
- "sig" : "(e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onDragEnter",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
- "sig" : "(e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onDragOut",
+ "name" : "blur",
"type" : "function",
- "desc" : "Abstract method called when we are no longer hovering over an element",
- "sig" : "(e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onDragOver",
+ "name" : "change",
"type" : "function",
- "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
- "sig" : "(e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.",
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onInvalidDrop",
+ "name" : "check",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the checkbox is checked or unchecked.",
+ "sig" : "function (_self, checked)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "this",
+ "type" : "Roo.form.Checkbox",
+ "desc" : "This checkbox",
+ "isOptional" : false
+ },
+ {
+ "name" : "checked",
+ "type" : "Boolean",
+ "desc" : "The new checked value",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onMouseDown",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousedown event",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onMouseUp",
+ "name" : "disable",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "padding",
- "type" : "function",
- "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
+ "name" : "enable",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeFromGroup",
+ "name" : "focus",
"type" : "function",
- "desc" : "Remove's this instance from the supplied interaction group",
- "sig" : "(sGroup)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "sGroup",
- "type" : "string",
- "desc" : "The group to drop",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeInvalidHandleClass",
+ "name" : "hide",
"type" : "function",
- "desc" : "Unsets an invalid css class",
- "sig" : "(cssClass)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the element(s) you wish to\nre-enable",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeInvalidHandleId",
+ "name" : "invalid",
"type" : "function",
- "desc" : "Unsets an invalid handle id",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "string",
- "desc" : "the id of the element to re-enable",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeInvalidHandleType",
+ "name" : "keyup",
"type" : "function",
- "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
- "sig" : "(tagName)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to unexclude",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "move",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is moved.",
+ "sig" : "function (_self, x, y)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resetConstraints",
+ "name" : "render",
"type" : "function",
- "desc" : "resetConstraints must be called if you manually reposition a dd element.",
- "sig" : "(maintainOffset)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "maintainOffset",
- "type" : "boolean",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "setDelta",
+ "name" : "resize",
"type" : "function",
- "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)",
- "sig" : "(iDeltaX, iDeltaY)",
- "static" : false,
- "memberOf" : "Roo.dd.DD",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is resized.",
+ "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "iDeltaX",
- "type" : "int",
- "desc" : "the distance from the left",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "iDeltaY",
- "type" : "int",
- "desc" : "the distance from the top",
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setDragElId",
- "type" : "function",
- "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "id",
- "type" : "",
- "desc" : "{string} the id of the element that will be used to initiate the drag",
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setDragElPos",
- "type" : "function",
- "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
- "sig" : "(iPageX, iPageY)",
- "static" : false,
- "memberOf" : "Roo.dd.DD",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the mousedown or drag event",
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
"isOptional" : false
},
{
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the mousedown or drag event",
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setHandleElId",
+ "name" : "show",
"type" : "function",
- "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setInitPosition",
+ "name" : "specialkey",
"type" : "function",
- "desc" : "Stores the initial placement of the linked element.",
- "sig" : "(diffX, diffY)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "diffX",
- "type" : "int",
- "desc" : "the X offset, default 0",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "diffY",
- "type" : "int",
- "desc" : "the Y offset, default 0",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setOuterHandleElId",
+ "name" : "valid",
"type" : "function",
- "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "the id of the element that will be used to initiate the drag",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "setPadding",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
- "sig" : "(iTop, iRight, iBot, iLeft)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iTop",
- "type" : "int",
- "desc" : "Top pad",
- "isOptional" : false
- },
- {
- "name" : "iRight",
- "type" : "int",
- "desc" : "Right pad",
- "isOptional" : false
- },
- {
- "name" : "iBot",
- "type" : "int",
- "desc" : "Bot pad",
- "isOptional" : false
- },
- {
- "name" : "iLeft",
- "type" : "int",
- "desc" : "Left pad",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setXConstraint",
+ "name" : "addListener",
"type" : "function",
- "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
- "sig" : "(iLeft, iRight, iTickSize)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iLeft",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the left",
- "isOptional" : false
- },
- {
- "name" : "iRight",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the\nright",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setYConstraint",
- "type" : "function",
- "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
- "sig" : "(iUp, iDown, iTickSize)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "iUp",
- "type" : "int",
- "desc" : "the number of pixels the element can move up",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "iDown",
- "type" : "int",
- "desc" : "the number of pixels the element can move down",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
},
{
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "startDrag",
+ "name" : "applyTo",
"type" : "function",
- "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
- "sig" : "(X, Y)",
+ "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "X",
- "type" : "int",
- "desc" : "click location",
- "isOptional" : false
- },
- {
- "name" : "Y",
- "type" : "int",
- "desc" : "click location",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id of the node, a DOM node or an existing Element",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "toString",
- "type" : "function",
- "desc" : "toString method",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
"returns" : [
{
"name" : "",
- "type" : "string",
- "desc" : "string representation of the dd obj"
+ "type" : "Roo.form.Field",
+ "desc" : "this"
}
]
},
{
- "name" : "un",
+ "name" : "capture",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
"memberOf" : "Roo.util.Observable",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "handler",
+ "name" : "fn",
"type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "The function to call",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "unlock",
+ "name" : "clearInvalid",
"type" : "function",
- "desc" : "Unlock this instace",
+ "desc" : "Clear any invalid styles/messages for this field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "unreg",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Remove all drag and drop hooks for this element",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.dd.DragSource",
- "Roo.dd.DragZone",
- "Roo.grid.SplitDragZone"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.dd.DDTarget" : {
- "props" : [
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
- {
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "addInvalidHandleClass",
- "type" : "function",
- "desc" : "Lets you specify a css class of elements that will not initiate a drag",
- "sig" : "(cssClass)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the elements you wish to ignore",
- "isOptional" : false
- }
- ],
- "returns" : []
},
{
- "name" : "addInvalidHandleId",
+ "name" : "disable",
"type" : "function",
- "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
- "sig" : "(id)",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "id",
- "type" : "string",
- "desc" : "the element id of the element you wish to ignore",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "addInvalidHandleType",
+ "name" : "enable",
"type" : "function",
- "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
- "sig" : "(tagName)",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to exclude",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "addListener",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "addToGroup",
- "type" : "function",
- "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
- "sig" : "(sGroup)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "sGroup",
- "type" : "",
- "desc" : "{string} the name of the group",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "applyConfig",
- "type" : "function",
- "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "capture",
- "type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
+ "returns" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
- ],
- "returns" : []
- },
- {
- "name" : "clearConstraints",
- "type" : "function",
- "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
+ ]
},
{
- "name" : "clearTicks",
+ "name" : "focus",
"type" : "function",
- "desc" : "Clears any tick interval defined for this instance",
- "sig" : "()\n{\n\n}",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "endDrag",
+ "name" : "getBox",
"type" : "function",
- "desc" : "Fired when we are done dragging the object",
- "sig" : "(e)",
+ "desc" : "Gets the current box measurements of the component's underlying element.",
+ "sig" : "(local)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "getDragEl",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "HTMLElement",
- "desc" : "the html element"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getEl",
+ "name" : "getName",
"type" : "function",
- "desc" : "Returns a reference to the linked element",
+ "desc" : "Returns the name attribute of the field if available",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "HTMLElement",
- "desc" : "the html element"
+ "type" : "String",
+ "desc" : "name The field name"
}
]
},
{
- "name" : "hasListener",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Gets the current XY position of the component's underlying element.",
+ "sig" : "(local)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "Array",
+ "desc" : "The XY position of the element (e.g., [100, 200])"
}
]
},
{
- "name" : "init",
+ "name" : "getRawValue",
"type" : "function",
- "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
- "sig" : "(id, sGroup, config)",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "",
- "desc" : "the id of the linked element",
- "isOptional" : false
- },
- {
- "name" : "sGroup",
- "type" : "String",
- "desc" : "the group of related items",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "config",
- "type" : "object",
- "desc" : "configuration attributes",
- "isOptional" : false
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "initTarget",
+ "name" : "getSize",
"type" : "function",
- "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
- "sig" : "(id, sGroup, config)",
+ "desc" : "Gets the current size of the component's underlying element.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "",
- "desc" : "the id of the linked element",
- "isOptional" : false
- },
- {
- "name" : "sGroup",
- "type" : "String",
- "desc" : "the group of related items",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "config",
- "type" : "object",
- "desc" : "configuration attributes",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "isLocked",
+ "name" : "getValue",
"type" : "function",
- "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
+ "desc" : "Returns the checked state of the checkbox.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "boolean",
- "desc" : "true if this obj or all drag/drop is locked, else\nfalse"
+ "type" : "Boolean",
+ "desc" : "True if checked, else false"
}
]
},
{
- "name" : "isTarget",
+ "name" : "hasChanged",
"type" : "function",
- "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
+ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "isValidHandleChild",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Checks the tag exclusion list to see if this click should be ignored",
- "sig" : "(node)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "HTMLElement",
- "desc" : "the HTMLElement to evaluate",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "boolean",
- "desc" : "true if this is a valid tag type, false if not"
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "lock",
+ "name" : "hide",
"type" : "function",
- "desc" : "Lock this instance",
+ "desc" : "Hide this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "isDirty",
+ "type" : "function",
+ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "on",
+ "name" : "isValid",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Returns whether or not the field value is currently valid",
+ "sig" : "(preventMark)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "True to disable marking the field invalid",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
},
{
- "name" : "onAvailable",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "onDrag",
+ "name" : "markInvalid",
"type" : "function",
- "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
- "sig" : "(e)",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onDragDrop",
+ "name" : "on",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
- "sig" : "(e, id)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onDragEnter",
+ "name" : "onPosition",
"type" : "function",
- "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
- "sig" : "(e, id)",
+ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
+ "sig" : "(x, y)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.",
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onDragOut",
+ "name" : "onResize",
"type" : "function",
- "desc" : "Abstract method called when we are no longer hovering over an element",
- "sig" : "(e, id)",
+ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
+ "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.",
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onDragOver",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
- "sig" : "(e, id)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "onInvalidDrop",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onMouseDown",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
- "sig" : "(e)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousedown event",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onMouseUp",
+ "name" : "render",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
- "sig" : "(e)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "padding",
+ "name" : "reset",
"type" : "function",
- "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "resetHasChanged",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "stores the current value in loadedValue",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeFromGroup",
+ "name" : "setPagePosition",
"type" : "function",
- "desc" : "Remove's this instance from the supplied interaction group",
- "sig" : "(sGroup)",
+ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
+ "sig" : "(x, y)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "sGroup",
- "type" : "string",
- "desc" : "The group to drop",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeInvalidHandleClass",
+ "name" : "setPosition",
"type" : "function",
- "desc" : "Unsets an invalid css class",
- "sig" : "(cssClass)",
+ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
+ "sig" : "(left, top)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the element(s) you wish to\nre-enable",
+ "name" : "left",
+ "type" : "Number",
+ "desc" : "The new left",
+ "isOptional" : false
+ },
+ {
+ "name" : "top",
+ "type" : "Number",
+ "desc" : "The new top",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeInvalidHandleId",
+ "name" : "setRawValue",
"type" : "function",
- "desc" : "Unsets an invalid handle id",
- "sig" : "(id)",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "string",
- "desc" : "the id of the element to re-enable",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeInvalidHandleType",
+ "name" : "setSize",
"type" : "function",
- "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
- "sig" : "(tagName)",
+ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
+ "sig" : "(width, height)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to unexclude",
+ "name" : "width",
+ "type" : "Number/Object",
+ "desc" : "The new width to set, or a size object in the format {width, height}",
+ "isOptional" : false
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height to set (not required if a size object is passed as the first arg)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.BoxComponent",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "removeListener",
+ "name" : "setValue",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.",
+ "sig" : "(value, suppressEvent)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "value",
+ "type" : "Boolean/String",
+ "desc" : "- the value to set",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "suppressEvent",
+ "type" : "Boolean/String",
+ "desc" : "- whether to suppress the checkchange event.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resetConstraints",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "resetConstraints must be called if you manually reposition a dd element.",
- "sig" : "(maintainOffset)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "maintainOffset",
- "type" : "boolean",
- "desc" : "",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "setDragElId",
+ "name" : "show",
"type" : "function",
- "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
- "sig" : "(id)",
+ "desc" : "Show this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "{string} the id of the element that will be used to initiate the drag",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setHandleElId",
+ "name" : "syncSize",
"type" : "function",
- "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
- "sig" : "(id)",
+ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "",
- "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setInitPosition",
+ "name" : "un",
"type" : "function",
- "desc" : "Stores the initial placement of the linked element.",
- "sig" : "(diffX, diffY)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "diffX",
- "type" : "int",
- "desc" : "the X offset, default 0",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "diffY",
- "type" : "int",
- "desc" : "the Y offset, default 0",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setOuterHandleElId",
+ "name" : "updateBox",
"type" : "function",
- "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
- "sig" : "(id)",
+ "desc" : "Sets the current box measurements of the component's underlying element.",
+ "sig" : "(box)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "the id of the element that will be used to initiate the drag",
+ "name" : "box",
+ "type" : "Object",
+ "desc" : "An object in the format {x, y, width, height}",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setPadding",
+ "name" : "validate",
"type" : "function",
- "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
- "sig" : "(iTop, iRight, iBot, iLeft)",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "iTop",
- "type" : "int",
- "desc" : "Top pad",
- "isOptional" : false
- },
- {
- "name" : "iRight",
- "type" : "int",
- "desc" : "Right pad",
- "isOptional" : false
- },
- {
- "name" : "iBot",
- "type" : "int",
- "desc" : "Bot pad",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "iLeft",
- "type" : "int",
- "desc" : "Left pad",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
}
- ],
- "returns" : []
+ ]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.form.Radio"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.form.Column" : {
+ "props" : [
+ {
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "setXConstraint",
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoCreate",
+ "type" : "String/Object",
+ "desc" : "A DomHelper element spec used to autocreate the column (defaults to {tag: 'div', cls: 'x-form-ct x-form-column'})",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "clear",
+ "type" : "Boolean",
+ "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideLabels",
+ "type" : "Boolean",
+ "desc" : "True to suppress the display of field labels in this layout (defaults to false)",
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)\nValid values are \"left,\" \"top\" and \"right\" (defaults to \"left",
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "top",
+ "right"
+ ]
+ },
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "The separator to use after field labels (defaults to ':')",
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String/Object/Function",
+ "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "width",
+ "type" : "Number/String",
+ "desc" : "The fixed width of the column in pixels or CSS value (defaults to \"auto\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
- "sig" : "(iLeft, iRight, iTickSize)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "iLeft",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the left",
- "isOptional" : false
- },
- {
- "name" : "iRight",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the\nright",
- "isOptional" : false
- },
- {
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setYConstraint",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
- "sig" : "(iUp, iDown, iTickSize)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "iUp",
- "type" : "int",
- "desc" : "the number of pixels the element can move up",
- "isOptional" : false
- },
- {
- "name" : "iDown",
- "type" : "int",
- "desc" : "the number of pixels the element can move down",
- "isOptional" : false
- },
- {
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "startDrag",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
- "sig" : "(X, Y)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "X",
- "type" : "int",
- "desc" : "click location",
- "isOptional" : false
- },
- {
- "name" : "Y",
- "type" : "int",
- "desc" : "click location",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "toString",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "toString method",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "string",
- "desc" : "string representation of the dd obj"
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "un",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "unlock",
+ "name" : "disable",
"type" : "function",
- "desc" : "Unlock this instace",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "unreg",
+ "name" : "enable",
"type" : "function",
- "desc" : "Remove all drag and drop hooks for this element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.dd.DropTarget",
- "Roo.dd.DropZone"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.dd.DragDrop" : {
- "props" : [
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "addEvents",
+ "name" : "hide",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addInvalidHandleClass",
+ "name" : "render",
"type" : "function",
- "desc" : "Lets you specify a css class of elements that will not initiate a drag",
- "sig" : "(cssClass)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the elements you wish to ignore",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addInvalidHandleId",
+ "name" : "show",
"type" : "function",
- "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "string",
- "desc" : "the element id of the element you wish to ignore",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "addInvalidHandleType",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
- "sig" : "(tagName)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to exclude",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addToGroup",
+ "name" : "addxtype",
"type" : "function",
- "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
- "sig" : "(sGroup)",
+ "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column",
+ "sig" : "(config)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Layout",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "sGroup",
- "type" : "",
- "desc" : "{string} the name of the group",
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "applyConfig",
- "type" : "function",
- "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
"returns" : []
},
{
- "name" : "clearConstraints",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "clearTicks",
+ "name" : "disable",
"type" : "function",
- "desc" : "Clears any tick interval defined for this instance",
+ "desc" : "Disable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "endDrag",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fired when we are done dragging the object",
- "sig" : "(e)",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
"name" : "fireEvent",
]
},
{
- "name" : "getDragEl",
+ "name" : "focus",
"type" : "function",
- "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "HTMLElement",
- "desc" : "the html element"
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "getEl",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns a reference to the linked element",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "HTMLElement",
- "desc" : "the html element"
+ "type" : "String",
+ "desc" : ""
}
]
},
]
},
{
- "name" : "init",
+ "name" : "hide",
"type" : "function",
- "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
- "sig" : "(id, sGroup, config)",
+ "desc" : "Hide this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "on",
+ "type" : "function",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "the id of the linked element",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "sGroup",
- "type" : "String",
- "desc" : "the group of related items",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "config",
- "type" : "object",
- "desc" : "configuration attributes",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "initTarget",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
- "sig" : "(id, sGroup, config)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "the id of the linked element",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "sGroup",
+ "name" : "eventName",
"type" : "String",
- "desc" : "the group of related items",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "config",
- "type" : "object",
- "desc" : "configuration attributes",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "isLocked",
+ "name" : "render",
"type" : "function",
- "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
- "sig" : "()\n{\n\n}",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "boolean",
- "desc" : "true if this obj or all drag/drop is locked, else\nfalse"
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "isTarget",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "isValidHandleChild",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Checks the tag exclusion list to see if this click should be ignored",
- "sig" : "(node)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "HTMLElement",
- "desc" : "the HTMLElement to evaluate",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "boolean",
- "desc" : "true if this is a valid tag type, false if not"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "lock",
+ "name" : "show",
"type" : "function",
- "desc" : "Lock this instance",
+ "desc" : "Show this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "on",
+ "name" : "un",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [
+ "Roo.form.Row",
+ "Roo.form.Field",
+ "Roo.form.Checkbox",
+ "Roo.form.ComboBox",
+ "Roo.form.ComboBoxArray",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.FCKeditor",
+ "Roo.form.GridField",
+ "Roo.form.Hidden",
+ "Roo.form.HtmlEditor",
+ "Roo.form.MonthField",
+ "Roo.form.NumberField",
+ "Roo.form.Radio",
+ "Roo.form.Select",
+ "Roo.form.Signature",
+ "Roo.form.TextArea",
+ "Roo.form.TextField",
+ "Roo.form.TriggerField",
+ "Roo.Button",
+ "Roo.SplitButton",
+ "Roo.Toolbar.Button",
+ "Roo.Toolbar.SplitButton",
+ "Roo.form.TextItem",
+ "Roo.form.FieldSet"
+ ],
+ "tree_parent" : []
+ },
+ "Roo.form.ComboBox" : {
+ "props" : [
+ {
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "onAvailable",
- "type" : "function",
- "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "name" : "allQuery",
+ "type" : "String",
+ "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "alwaysQuery",
+ "type" : "Boolean",
+ "desc" : "Disable caching of results, and always send query",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoCreate",
+ "type" : "Boolean/Object",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "blockFocus",
+ "type" : "Boolean",
+ "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "A CSS class to apply to the field's underlying element.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClear",
+ "type" : "Boolean",
+ "desc" : "Disable showing of clear button.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "True to disable the field (defaults to false).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "displayField",
+ "type" : "String",
+ "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "editable",
+ "type" : "Boolean",
+ "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "emptyText",
+ "type" : "String",
+ "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldClass",
+ "type" : "String",
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "String",
+ "desc" : "Label to use when rendering a form.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "forceSelection",
+ "type" : "Boolean",
+ "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "grow",
+ "type" : "Boolean",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMax",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "handleHeight",
+ "type" : "Number",
+ "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "height (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hiddenName",
+ "type" : "String",
+ "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "hideTrigger",
+ "type" : "Boolean",
+ "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf" : "Roo.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "lazyRender",
+ "type" : "Boolean",
+ "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listAlign",
+ "type" : "String",
+ "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listWidth",
+ "type" : "Number",
+ "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "loadingText",
+ "type" : "String",
+ "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxHeight",
+ "type" : "Number",
+ "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minChars",
+ "type" : "Number",
+ "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minListWidth",
+ "type" : "Number",
+ "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "mode",
+ "type" : "String",
+ "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "msgFx",
+ "type" : "String",
+ "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "msgTarget",
+ "type" : "String",
+ "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The field's HTML name attribute.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "pageSize",
+ "type" : "Number",
+ "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "qtip",
+ "type" : "String",
+ "desc" : "Mouse over tip",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "queryDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "queryParam",
+ "type" : "String",
+ "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "resizable",
+ "type" : "Boolean",
+ "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "selectedClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "onDrag",
- "type" : "function",
- "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
- "sig" : "(e)",
- "static" : false,
+ "name" : "shadow",
+ "type" : "Boolean/String",
+ "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "onDragDrop",
- "type" : "function",
- "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
- "sig" : "(e, id)",
- "static" : false,
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to which this combo is bound (defaults to undefined)",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "onDragEnter",
- "type" : "function",
- "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
- "sig" : "(e, id)",
- "static" : false,
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tabIndex",
+ "type" : "Number",
+ "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "onDragOut",
- "type" : "function",
- "desc" : "Abstract method called when we are no longer hovering over an element",
- "sig" : "(e, id)",
- "static" : false,
+ "name" : "tpl",
+ "type" : "String/Roo.Template",
+ "desc" : "The template to use to render the output",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "onDragOver",
- "type" : "function",
- "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
- "sig" : "(e, id)",
- "static" : false,
+ "name" : "transform",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "onInvalidDrop",
- "type" : "function",
- "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
- "sig" : "(e)",
- "static" : false,
+ "name" : "triggerAction",
+ "type" : "String",
+ "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "onMouseDown",
- "type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
- "sig" : "(e)",
- "static" : false,
+ "name" : "triggerClass",
+ "type" : "String",
+ "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousedown event",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "onMouseUp",
- "type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
- "sig" : "(e)",
- "static" : false,
+ "name" : "typeAhead",
+ "type" : "Boolean",
+ "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "padding",
- "type" : "function",
- "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "name" : "typeAheadDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "removeFromGroup",
- "type" : "function",
- "desc" : "Remove's this instance from the supplied interaction group",
- "sig" : "(sGroup)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "sGroup",
- "type" : "string",
- "desc" : "The group to drop",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "removeInvalidHandleClass",
- "type" : "function",
- "desc" : "Unsets an invalid css class",
- "sig" : "(cssClass)",
- "static" : false,
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "A value to initialize this field with.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "valueField",
+ "type" : "String",
+ "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the element(s) you wish to\nre-enable",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "removeInvalidHandleId",
- "type" : "function",
- "desc" : "Unsets an invalid handle id",
- "sig" : "(id)",
- "static" : false,
+ "name" : "valueNotFoundText",
+ "type" : "String",
+ "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "string",
- "desc" : "the id of the element to re-enable",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "removeInvalidHandleType",
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "width (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "add",
"type" : "function",
- "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
- "sig" : "(tagName)",
- "static" : false,
+ "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to unexclude",
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "autosize",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
+ "sig" : "function (_self, width)\n{\n\n}",
+ "memberOf" : "Roo.form.TextField",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "This text field",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The new field width",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resetConstraints",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "resetConstraints must be called if you manually reposition a dd element.",
- "sig" : "(maintainOffset)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "maintainOffset",
- "type" : "boolean",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "setDragElId",
- "type" : "function",
- "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "",
- "desc" : "{string} the id of the element that will be used to initiate the drag",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setHandleElId",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setInitPosition",
+ "name" : "beforequery",
"type" : "function",
- "desc" : "Stores the initial placement of the linked element.",
- "sig" : "(diffX, diffY)",
- "static" : false,
+ "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
+ "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "diffX",
- "type" : "int",
- "desc" : "the X offset, default 0",
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
},
{
- "name" : "diffY",
- "type" : "int",
- "desc" : "the Y offset, default 0",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setOuterHandleElId",
- "type" : "function",
- "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "",
- "desc" : "the id of the element that will be used to initiate the drag",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setPadding",
- "type" : "function",
- "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
- "sig" : "(iTop, iRight, iBot, iLeft)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "iTop",
- "type" : "int",
- "desc" : "Top pad",
+ "name" : "query",
+ "type" : "String",
+ "desc" : "The query",
"isOptional" : false
},
{
- "name" : "iRight",
- "type" : "int",
- "desc" : "Right pad",
+ "name" : "forceAll",
+ "type" : "Boolean",
+ "desc" : "true to force \"all\" query",
"isOptional" : false
},
{
- "name" : "iBot",
- "type" : "int",
- "desc" : "Bot pad",
+ "name" : "cancel",
+ "type" : "Boolean",
+ "desc" : "true to cancel the query",
"isOptional" : false
},
{
- "name" : "iLeft",
- "type" : "int",
- "desc" : "Left pad",
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "The query event object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setXConstraint",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
- "sig" : "(iLeft, iRight, iTickSize)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "iLeft",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the left",
- "isOptional" : false
- },
- {
- "name" : "iRight",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the\nright",
- "isOptional" : false
- },
- {
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setYConstraint",
+ "name" : "beforeselect",
"type" : "function",
- "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
- "sig" : "(iUp, iDown, iTickSize)",
- "static" : false,
+ "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
+ "sig" : "function (combo, record, index)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "iUp",
- "type" : "int",
- "desc" : "the number of pixels the element can move up",
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
},
{
- "name" : "iDown",
- "type" : "int",
- "desc" : "the number of pixels the element can move down",
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The data record returned from the underlying store",
"isOptional" : false
},
{
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the selected item in the dropdown list",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "startDrag",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
- "sig" : "(X, Y)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "X",
- "type" : "int",
- "desc" : "click location",
- "isOptional" : false
- },
- {
- "name" : "Y",
- "type" : "int",
- "desc" : "click location",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "toString",
+ "name" : "blur",
"type" : "function",
- "desc" : "toString method",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "string",
- "desc" : "string representation of the dd obj"
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "un",
+ "name" : "change",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "unlock",
- "type" : "function",
- "desc" : "Unlock this instace",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "unreg",
+ "name" : "collapse",
"type" : "function",
- "desc" : "Remove all drag and drop hooks for this element",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "desc" : "Fires when the dropdown list is collapsed",
+ "sig" : "function (combo)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.dd.DD",
- "Roo.dd.DDProxy",
- "Roo.dd.DDTarget",
- "Roo.dd.DragSource",
- "Roo.dd.DragZone",
- "Roo.dd.DropTarget",
- "Roo.dd.DropZone",
- "Roo.grid.SplitDragZone"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.dd.DragSource" : {
- "props" : [
- {
- "name" : "dropAllowed",
- "type" : "String",
- "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "dropNotAllowed",
- "type" : "String",
- "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
- {
- "name" : "addEvents",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addInvalidHandleClass",
+ "name" : "disable",
"type" : "function",
- "desc" : "Lets you specify a css class of elements that will not initiate a drag",
- "sig" : "(cssClass)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the elements you wish to ignore",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addInvalidHandleId",
+ "name" : "edit",
"type" : "function",
- "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo, record)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "string",
- "desc" : "the element id of the element you wish to ignore",
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record|false",
+ "desc" : "The data record returned from the underlying store (or false on nothing selected)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addInvalidHandleType",
+ "name" : "enable",
"type" : "function",
- "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
- "sig" : "(tagName)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to exclude",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "expand",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the dropdown list is expanded",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addToGroup",
+ "name" : "focus",
"type" : "function",
- "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
- "sig" : "(sGroup)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "sGroup",
- "type" : "",
- "desc" : "{string} the name of the group",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "afterDragDrop",
+ "name" : "hide",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter a valid drag drop has occurred by providing an implementation.",
- "sig" : "(target, e, id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dropped element",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "afterDragEnter",
+ "name" : "invalid",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhen the dragged item enters the drop target by providing an implementation.",
- "sig" : "(target, e, id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "id",
+ "name" : "msg",
"type" : "String",
- "desc" : "The id of the dragged element",
+ "desc" : "The validation message",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "afterDragOut",
+ "name" : "keyup",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter the dragged item is dragged out of the target without dropping.",
- "sig" : "(target, e, id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
},
{
"name" : "e",
- "type" : "Event",
- "desc" : "The event object",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dragged element",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "afterDragOver",
+ "name" : "move",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhile the dragged item is over the drop target by providing an implementation.",
- "sig" : "(target, e, id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is moved.",
+ "sig" : "function (_self, x, y)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dragged element",
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "afterInvalidDrop",
+ "name" : "render",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter an invalid drop has occurred by providing an implementation.",
- "sig" : "(e, id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dropped element",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "afterValidDrop",
+ "name" : "resize",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter a valid drop has occurred by providing an implementation.",
- "sig" : "(target, e, id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is resized.",
+ "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Object",
- "desc" : "The target DD",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dropped element",
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "alignElWithMouse",
+ "name" : "select",
"type" : "function",
- "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
- "sig" : "(el, iPageX, iPageY)",
- "static" : false,
- "memberOf" : "Roo.dd.DD",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a list item is selected",
+ "sig" : "function (combo, record, index)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "HTMLElement",
- "desc" : "the element to move",
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
},
{
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the mousedown or drag event",
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The data record returned from the underlying store (or false on clear)",
"isOptional" : false
},
{
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the mousedown or drag event",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the selected item in the dropdown list",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "applyConfig",
- "type" : "function",
- "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "autoOffset",
+ "name" : "show",
"type" : "function",
- "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked",
- "sig" : "(iPageX, iPageY)",
- "static" : false,
- "memberOf" : "Roo.dd.DD",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the click",
- "isOptional" : false
- },
- {
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the click",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeDragDrop",
+ "name" : "specialkey",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dropped onto the target and optionally cancel the onDragDrop.",
- "sig" : "(target, e, id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
},
{
"name" : "e",
- "type" : "Event",
+ "type" : "Roo.EventObject",
"desc" : "The event object",
"isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dragged element",
- "isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "isValid True if the drag drop event is valid, else false to cancel"
- }
- ]
+ "returns" : []
},
{
- "name" : "beforeDragEnter",
+ "name" : "valid",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action\nbefore the dragged item enters the drop target and optionally cancel the onDragEnter.",
- "sig" : "(target, e, id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dragged element",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "isValid True if the drag event is valid, else false to cancel"
- }
- ]
- },
+ "returns" : []
+ }
+ ],
+ "methods" : [
{
- "name" : "beforeDragOut",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dragged out of the target without dropping, and optionally cancel the onDragOut.",
- "sig" : "(target, e, id)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dragged element",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "isValid True if the drag event is valid, else false to cancel"
- }
- ]
+ "returns" : []
},
{
- "name" : "beforeDragOver",
+ "name" : "addListener",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhile the dragged item is over the drop target and optionally cancel the onDragOver.",
- "sig" : "(target, e, id)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dragged element",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "isValid True if the drag event is valid, else false to cancel"
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "beforeInvalidDrop",
+ "name" : "applyTo",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action after an invalid\ndrop has occurred.",
- "sig" : "(target, e, id)",
+ "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dragged element",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id of the node, a DOM node or an existing Element",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "isValid True if the invalid drop should proceed, else false to cancel"
+ "type" : "Roo.form.Field",
+ "desc" : "this"
}
]
},
{
- "name" : "cachePosition",
+ "name" : "autoSize",
"type" : "function",
- "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.",
- "sig" : "(iPageX, iPageY)",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "Roo.form.TriggerField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "iPageX",
- "type" : "",
- "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)",
- "isOptional" : false
- },
- {
- "name" : "iPageY",
- "type" : "",
- "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
"returns" : []
},
{
- "name" : "clearConstraints",
+ "name" : "clearInvalid",
"type" : "function",
- "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.",
+ "desc" : "Clear any invalid styles/messages for this field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "clearTicks",
+ "name" : "clearValue",
"type" : "function",
- "desc" : "Clears any tick interval defined for this instance",
+ "desc" : "Clears any text/value currently set in the field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "createFrame",
+ "name" : "collapse",
"type" : "function",
- "desc" : "Creates the proxy element if it does not yet exist",
+ "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DDProxy",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "endDrag",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fired when we are done dragging the object",
- "sig" : "(e)",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "fireEvent",
- "type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
- },
- {
- "name" : "getDragData",
+ "name" : "disable",
"type" : "function",
- "desc" : "Returns the data object associated with this drag source",
+ "desc" : "Disable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "data An object containing arbitrary data"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getDragEl",
+ "name" : "doQuery",
"type" : "function",
- "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
- "sig" : "()\n{\n\n}",
+ "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
+ "sig" : "(query, forceAll)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "HTMLElement",
- "desc" : "the html element"
+ "name" : "query",
+ "type" : "String",
+ "desc" : "The SQL query to execute",
+ "isOptional" : false
+ },
+ {
+ "name" : "forceAll",
+ "type" : "Boolean",
+ "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getEl",
+ "name" : "enable",
"type" : "function",
- "desc" : "Returns a reference to the linked element",
+ "desc" : "Enable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "HTMLElement",
- "desc" : "the html element"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getProxy",
+ "name" : "expand",
"type" : "function",
- "desc" : "Returns the drag source's underlying {@link Roo.dd.StatusProxy}",
+ "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.dd.StatusProxy",
- "desc" : "proxy The StatusProxy"
- }
- ]
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The name of the event to check for",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "hideProxy",
+ "name" : "focus",
"type" : "function",
- "desc" : "Hides the drag source's {@link Roo.dd.StatusProxy}",
- "sig" : "()\n{\n\n}",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "init",
+ "name" : "getBox",
"type" : "function",
- "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
- "sig" : "(id, sGroup, config)",
+ "desc" : "Gets the current box measurements of the component's underlying element.",
+ "sig" : "(local)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "the id of the linked element",
- "isOptional" : false
- },
- {
- "name" : "sGroup",
- "type" : "String",
- "desc" : "the group of related items",
- "isOptional" : false
- },
- {
- "name" : "config",
- "type" : "object",
- "desc" : "configuration attributes",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "initFrame",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DDProxy",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "The element"
+ }
+ ]
},
{
- "name" : "initTarget",
+ "name" : "getId",
"type" : "function",
- "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
- "sig" : "(id, sGroup, config)",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "",
- "desc" : "the id of the linked element",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "sGroup",
+ "name" : "",
"type" : "String",
- "desc" : "the group of related items",
- "isOptional" : false
- },
- {
- "name" : "config",
- "type" : "object",
- "desc" : "configuration attributes",
- "isOptional" : false
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "isLocked",
+ "name" : "getName",
"type" : "function",
- "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
+ "desc" : "Returns the name attribute of the field if available",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "boolean",
- "desc" : "true if this obj or all drag/drop is locked, else\nfalse"
+ "type" : "String",
+ "desc" : "name The field name"
}
]
},
{
- "name" : "isTarget",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Gets the current XY position of the component's underlying element.",
+ "sig" : "(local)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "The XY position of the element (e.g., [100, 200])"
+ }
+ ]
},
{
- "name" : "isValidHandleChild",
+ "name" : "getRawValue",
"type" : "function",
- "desc" : "Checks the tag exclusion list to see if this click should be ignored",
- "sig" : "(node)",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "node",
- "type" : "HTMLElement",
- "desc" : "the HTMLElement to evaluate",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "boolean",
- "desc" : "true if this is a valid tag type, false if not"
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
]
},
{
- "name" : "lock",
+ "name" : "getSize",
"type" : "function",
- "desc" : "Lock this instance",
+ "desc" : "Gets the current size of the component's underlying element.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
+ }
+ ]
},
{
- "name" : "on",
+ "name" : "getValue",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Returns the currently selected field value or empty string if no value is set.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "eventName",
+ "name" : "",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
- "isOptional" : false
+ "desc" : "value The selected value"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "onAvailable",
+ "name" : "hasChanged",
"type" : "function",
- "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
+ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "onBeforeDrag",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action before the initial\ndrag event begins and optionally cancel it.",
- "sig" : "(data, e)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data to be shared with drop targets",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Boolean",
- "desc" : "isValid True if the drag event is valid, else false to cancel"
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "onDrag",
+ "name" : "hide",
"type" : "function",
- "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
- "sig" : "(e)",
+ "desc" : "Hide this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "onDragDrop",
+ "name" : "isDirty",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
- "sig" : "(e, id)",
+ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "onDragEnter",
+ "name" : "isExpanded",
"type" : "function",
- "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
- "sig" : "(e, id)",
+ "desc" : "Returns true if the dropdown list is expanded, else false.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "onDragOut",
+ "name" : "isValid",
"type" : "function",
- "desc" : "Abstract method called when we are no longer hovering over an element",
- "sig" : "(e, id)",
+ "desc" : "Returns whether or not the field value is currently valid",
+ "sig" : "(preventMark)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.",
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "True to disable marking the field invalid",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
},
{
- "name" : "onDragOver",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
- "sig" : "(e, id)",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "onInvalidDrop",
+ "name" : "markInvalid",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
- "sig" : "(e)",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onMouseDown",
+ "name" : "on",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
- "sig" : "(e)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousedown event",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onMouseUp",
+ "name" : "onPosition",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
- "sig" : "(e)",
+ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
+ "sig" : "(x, y)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onStartDrag",
+ "name" : "onResize",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action once the initial\ndrag event has begun. The drag cannot be canceled from this function.",
- "sig" : "(x, y)",
+ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
+ "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "x",
+ "name" : "adjWidth",
"type" : "Number",
- "desc" : "The x position of the click on the dragged object",
+ "desc" : "The box-adjusted width that was set",
"isOptional" : false
},
{
- "name" : "y",
+ "name" : "adjHeight",
"type" : "Number",
- "desc" : "The y position of the click on the dragged object",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "padding",
+ "name" : "onTriggerClick",
"type" : "function",
- "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
- "sig" : "()\n{\n\n}",
+ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.TriggerField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
"returns" : []
},
{
- "name" : "removeFromGroup",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Remove's this instance from the supplied interaction group",
- "sig" : "(sGroup)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "sGroup",
- "type" : "string",
- "desc" : "The group to drop",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeInvalidHandleClass",
+ "name" : "render",
"type" : "function",
- "desc" : "Unsets an invalid css class",
- "sig" : "(cssClass)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the element(s) you wish to\nre-enable",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeInvalidHandleId",
+ "name" : "reset",
"type" : "function",
- "desc" : "Unsets an invalid handle id",
- "sig" : "(id)",
+ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.TextField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "string",
- "desc" : "the id of the element to re-enable",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "removeInvalidHandleType",
+ "name" : "resetHasChanged",
"type" : "function",
- "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
- "sig" : "(tagName)",
+ "desc" : "stores the current value in loadedValue",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to unexclude",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "select",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(index, scrollIntoView)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The zero-based index of the list item to select",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "scrollIntoView",
+ "type" : "Boolean",
+ "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resetConstraints",
+ "name" : "selectByValue",
"type" : "function",
- "desc" : "resetConstraints must be called if you manually reposition a dd element.",
- "sig" : "(maintainOffset)",
+ "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(value, scrollIntoView)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "maintainOffset",
- "type" : "boolean",
- "desc" : "",
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The data value of the item to select",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollIntoView",
+ "type" : "Boolean",
+ "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value matched an item in the list, else false"
+ }
+ ]
},
{
- "name" : "setDelta",
+ "name" : "selectText",
"type" : "function",
- "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)",
- "sig" : "(iDeltaX, iDeltaY)",
+ "desc" : "Selects text in this field",
+ "sig" : "(start, end)",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "Roo.form.TextField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iDeltaX",
- "type" : "int",
- "desc" : "the distance from the left",
+ "name" : "start",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should start (defaults to 0)",
"isOptional" : false
},
{
- "name" : "iDeltaY",
- "type" : "int",
- "desc" : "the distance from the top",
+ "name" : "end",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should end (defaults to the text length)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDragElId",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
- "sig" : "(id)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "{string} the id of the element that will be used to initiate the drag",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDragElPos",
+ "name" : "setEditable",
"type" : "function",
- "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
- "sig" : "(iPageX, iPageY)",
+ "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the mousedown or drag event",
- "isOptional" : false
- },
- {
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the mousedown or drag event",
+ "name" : "value",
+ "type" : "Boolean",
+ "desc" : "True to allow the user to directly edit the field text",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setHandleElId",
+ "name" : "setFromData",
"type" : "function",
- "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
- "sig" : "(id)",
+ "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
+ "name" : "value",
+ "type" : "Object",
+ "desc" : "the value to set as. or false on reset?",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setInitPosition",
+ "name" : "setPagePosition",
"type" : "function",
- "desc" : "Stores the initial placement of the linked element.",
- "sig" : "(diffX, diffY)",
+ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
+ "sig" : "(x, y)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "diffX",
- "type" : "int",
- "desc" : "the X offset, default 0",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
"isOptional" : false
},
{
- "name" : "diffY",
- "type" : "int",
- "desc" : "the Y offset, default 0",
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setOuterHandleElId",
+ "name" : "setPosition",
"type" : "function",
- "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
- "sig" : "(id)",
+ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
+ "sig" : "(left, top)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "the id of the element that will be used to initiate the drag",
+ "name" : "left",
+ "type" : "Number",
+ "desc" : "The new left",
+ "isOptional" : false
+ },
+ {
+ "name" : "top",
+ "type" : "Number",
+ "desc" : "The new top",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setPadding",
+ "name" : "setRawValue",
"type" : "function",
- "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
- "sig" : "(iTop, iRight, iBot, iLeft)",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iTop",
- "type" : "int",
- "desc" : "Top pad",
- "isOptional" : false
- },
- {
- "name" : "iRight",
- "type" : "int",
- "desc" : "Right pad",
- "isOptional" : false
- },
- {
- "name" : "iBot",
- "type" : "int",
- "desc" : "Bot pad",
- "isOptional" : false
- },
- {
- "name" : "iLeft",
- "type" : "int",
- "desc" : "Left pad",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setXConstraint",
+ "name" : "setSize",
"type" : "function",
- "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
- "sig" : "(iLeft, iRight, iTickSize)",
+ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
+ "sig" : "(width, height)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iLeft",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the left",
- "isOptional" : false
- },
- {
- "name" : "iRight",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the\nright",
+ "name" : "width",
+ "type" : "Number/Object",
+ "desc" : "The new width to set, or a size object in the format {width, height}",
"isOptional" : false
},
{
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height to set (not required if a size object is passed as the first arg)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.BoxComponent",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "setYConstraint",
+ "name" : "setValue",
"type" : "function",
- "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
- "sig" : "(iUp, iDown, iTickSize)",
+ "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iUp",
- "type" : "int",
- "desc" : "the number of pixels the element can move up",
- "isOptional" : false
- },
- {
- "name" : "iDown",
- "type" : "int",
- "desc" : "the number of pixels the element can move down",
- "isOptional" : false
- },
- {
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The value to match",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "startDrag",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
- "sig" : "(X, Y)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "X",
- "type" : "int",
- "desc" : "click location",
- "isOptional" : false
- },
- {
- "name" : "Y",
- "type" : "int",
- "desc" : "click location",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "toString",
+ "name" : "show",
"type" : "function",
- "desc" : "toString method",
+ "desc" : "Show this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "string",
- "desc" : "string representation of the dd obj"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
+ {
+ "name" : "syncSize",
+ "type" : "function",
+ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "un",
"type" : "function",
"returns" : []
},
{
- "name" : "unlock",
+ "name" : "updateBox",
"type" : "function",
- "desc" : "Unlock this instace",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the current box measurements of the component's underlying element.",
+ "sig" : "(box)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "box",
+ "type" : "Object",
+ "desc" : "An object in the format {x, y, width, height}",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "unreg",
+ "name" : "validate",
"type" : "function",
- "desc" : "Remove all drag and drop hooks for this element",
+ "desc" : "Validates the field value",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [
- "Roo.dd.DragZone"
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested"
],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.dd.DragZone" : {
+ "Roo.form.ComboBoxArray" : {
"props" : [
{
- "name" : "containerScroll",
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowBlank",
"type" : "Boolean",
- "desc" : "True to register this container with the Scrollmanager\nfor auto scrolling during drag operations.",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoCreate",
+ "type" : "String/Object",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "A CSS class to apply to the field's underlying element.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "The combo box that is wrapped",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "dropAllowed",
+ "name" : "disableClass",
"type" : "String",
- "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
- "memberOf" : "Roo.dd.DragSource",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "dropNotAllowed",
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "True to disable the field (defaults to false).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "emptyText",
"type" : "String",
- "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
- "memberOf" : "Roo.dd.DragSource",
+ "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf" : "Roo.form.TextField",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hlColor",
+ "name" : "fieldClass",
"type" : "String",
- "desc" : "The color to use when visually highlighting the drag source in the afterRepair\nmethod after a failed drop (defaults to \"c3daf9\" - light blue)",
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "String",
+ "desc" : "Label to use when rendering a form.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "grow",
+ "type" : "Boolean",
+ "desc" : "True if this field should automatically grow and shrink to its content",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMax",
+ "type" : "Number",
+ "desc" : "The maximum width to allow when grow = true (defaults to 800)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "The minimum width to allow when grow = true (defaults to 30)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "height (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hiddenName",
+ "type" : "String",
+ "desc" : "The hidden name of the field, often contains an comma seperated list of names",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "addInvalidHandleClass",
- "type" : "function",
- "desc" : "Lets you specify a css class of elements that will not initiate a drag",
- "sig" : "(cssClass)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the elements you wish to ignore",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "addInvalidHandleId",
- "type" : "function",
- "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "string",
- "desc" : "the element id of the element you wish to ignore",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "maxLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "addInvalidHandleType",
- "type" : "function",
- "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
- "sig" : "(tagName)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to exclude",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "addListener",
- "type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "name" : "minLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "msgFx",
+ "type" : "String",
+ "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "msgTarget",
+ "type" : "String",
+ "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The name of the visable items on this form (eg. titles not ids)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "qtip",
+ "type" : "String",
+ "desc" : "Mouse over tip",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "seperator",
+ "type" : "String",
+ "desc" : "The value seperator normally ','",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tabIndex",
+ "type" : "Number",
+ "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "A value to initialize this field with.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The width of the box that displays the selected element",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "autosize",
+ "type" : "function",
+ "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
+ "sig" : "function (_self, width)\n{\n\n}",
+ "memberOf" : "Roo.form.TextField",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "This text field",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The new field width",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addToGroup",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
- "sig" : "(sGroup)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "sGroup",
- "type" : "",
- "desc" : "{string} the name of the group",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "afterDragDrop",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter a valid drag drop has occurred by providing an implementation.",
- "sig" : "(target, e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dropped element",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "afterDragEnter",
+ "name" : "beforeremove",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhen the dragged item enters the drop target by providing an implementation.",
- "sig" : "(target, e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before remove the value from the list",
+ "sig" : "function (_self, item)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
+ "name" : "_self",
+ "type" : "Roo.form.ComboBoxArray",
+ "desc" : "This combo box array",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dragged element",
+ "name" : "item",
+ "type" : "Roo.form.ComboBoxArray.Item",
+ "desc" : "removed item",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "afterDragOut",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter the dragged item is dragged out of the target without dropping.",
- "sig" : "(target, e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dragged element",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "afterDragOver",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhile the dragged item is over the drop target by providing an implementation.",
- "sig" : "(target, e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dragged element",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "afterInvalidDrop",
+ "name" : "blur",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter an invalid drop has occurred by providing an implementation.",
- "sig" : "(e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dropped element",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "afterRepair",
- "type" : "function",
- "desc" : "Called after a repair of an invalid drop. By default, highlights this.dragData.ddel",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "afterValidDrop",
+ "name" : "change",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter a valid drop has occurred by providing an implementation.",
- "sig" : "(target, e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Object",
- "desc" : "The target DD",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dropped element",
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "alignElWithMouse",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
- "sig" : "(el, iPageX, iPageY)",
- "static" : false,
- "memberOf" : "Roo.dd.DD",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "HTMLElement",
- "desc" : "the element to move",
- "isOptional" : false
- },
- {
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the mousedown or drag event",
- "isOptional" : false
- },
- {
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the mousedown or drag event",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "applyConfig",
- "type" : "function",
- "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "autoOffset",
+ "name" : "disable",
"type" : "function",
- "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked",
- "sig" : "(iPageX, iPageY)",
- "static" : false,
- "memberOf" : "Roo.dd.DD",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the click",
- "isOptional" : false
- },
- {
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the click",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeDragDrop",
+ "name" : "enable",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dropped onto the target and optionally cancel the onDragDrop.",
- "sig" : "(target, e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dragged element",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "isValid True if the drag drop event is valid, else false to cancel"
- }
- ]
+ "returns" : []
},
{
- "name" : "beforeDragEnter",
+ "name" : "focus",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action\nbefore the dragged item enters the drop target and optionally cancel the onDragEnter.",
- "sig" : "(target, e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dragged element",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "isValid True if the drag event is valid, else false to cancel"
- }
- ]
+ "returns" : []
},
{
- "name" : "beforeDragOut",
+ "name" : "hide",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dragged out of the target without dropping, and optionally cancel the onDragOut.",
- "sig" : "(target, e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dragged element",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "isValid True if the drag event is valid, else false to cancel"
- }
- ]
+ "returns" : []
},
{
- "name" : "beforeDragOver",
+ "name" : "invalid",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhile the dragged item is over the drop target and optionally cancel the onDragOver.",
- "sig" : "(target, e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "id",
+ "name" : "msg",
"type" : "String",
- "desc" : "The id of the dragged element",
+ "desc" : "The validation message",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "isValid True if the drag event is valid, else false to cancel"
- }
- ]
+ "returns" : []
},
{
- "name" : "beforeInvalidDrop",
+ "name" : "keyup",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action after an invalid\ndrop has occurred.",
- "sig" : "(target, e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
},
{
"name" : "e",
- "type" : "Event",
- "desc" : "The event object",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dragged element",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "isValid True if the invalid drop should proceed, else false to cancel"
- }
- ]
- },
- {
- "name" : "cachePosition",
- "type" : "function",
- "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.",
- "sig" : "(iPageX, iPageY)",
- "static" : false,
- "memberOf" : "Roo.dd.DD",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "iPageX",
- "type" : "",
- "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)",
- "isOptional" : false
- },
- {
- "name" : "iPageY",
- "type" : "",
- "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "move",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is moved.",
+ "sig" : "function (_self, x, y)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "clearConstraints",
- "type" : "function",
- "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "clearTicks",
- "type" : "function",
- "desc" : "Clears any tick interval defined for this instance",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "createFrame",
- "type" : "function",
- "desc" : "Creates the proxy element if it does not yet exist",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DDProxy",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "endDrag",
- "type" : "function",
- "desc" : "Fired when we are done dragging the object",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "remove",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when remove the value from the list",
+ "sig" : "function (_self, item)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
+ "name" : "_self",
+ "type" : "Roo.form.ComboBoxArray",
+ "desc" : "This combo box array",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "item",
+ "type" : "Roo.form.ComboBoxArray.Item",
+ "desc" : "removed item",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
},
{
- "name" : "getDragData",
+ "name" : "render",
"type" : "function",
- "desc" : "Called when a mousedown occurs in this container. Looks in {@link Roo.dd.Registry}\nfor a valid target to drag based on the mouse down. Override this method\nto provide your own lookup logic (e.g. finding a child by class name). Make sure your returned\nobject has a \"ddel\" attribute (with an HTML Element) for other functions to work.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "EventObject",
- "desc" : "The mouse down event",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "The dragData"
- }
- ]
- },
- {
- "name" : "getDragEl",
- "type" : "function",
- "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "HTMLElement",
- "desc" : "the html element"
- }
- ]
- },
- {
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns a reference to the linked element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "HTMLElement",
- "desc" : "the html element"
- }
- ]
- },
- {
- "name" : "getProxy",
- "type" : "function",
- "desc" : "Returns the drag source's underlying {@link Roo.dd.StatusProxy}",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.dd.StatusProxy",
- "desc" : "proxy The StatusProxy"
- }
- ]
+ "returns" : []
},
{
- "name" : "getRepairXY",
+ "name" : "resize",
"type" : "function",
- "desc" : "Called before a repair of an invalid drop to get the XY to animate to. By default returns\nthe XY of this.dragData.ddel",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is resized.",
+ "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "EventObject",
- "desc" : "The mouse up event",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Array",
- "desc" : "The xy location (e.g. [100, 200])"
- }
- ]
- },
- {
- "name" : "hasListener",
- "type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
"isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
- },
- {
- "name" : "hideProxy",
- "type" : "function",
- "desc" : "Hides the drag source's {@link Roo.dd.StatusProxy}",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "init",
- "type" : "function",
- "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
- "sig" : "(id, sGroup, config)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "id",
- "type" : "",
- "desc" : "the id of the linked element",
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
"isOptional" : false
},
{
- "name" : "sGroup",
- "type" : "String",
- "desc" : "the group of related items",
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
"isOptional" : false
},
{
- "name" : "config",
- "type" : "object",
- "desc" : "configuration attributes",
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "initFrame",
- "type" : "function",
- "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DDProxy",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "initTarget",
+ "name" : "show",
"type" : "function",
- "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
- "sig" : "(id, sGroup, config)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "the id of the linked element",
- "isOptional" : false
- },
- {
- "name" : "sGroup",
- "type" : "String",
- "desc" : "the group of related items",
- "isOptional" : false
- },
- {
- "name" : "config",
- "type" : "object",
- "desc" : "configuration attributes",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "isLocked",
+ "name" : "specialkey",
"type" : "function",
- "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "boolean",
- "desc" : "true if this obj or all drag/drop is locked, else\nfalse"
- }
- ]
- },
- {
- "name" : "isTarget",
- "type" : "function",
- "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "isValidHandleChild",
+ "name" : "valid",
"type" : "function",
- "desc" : "Checks the tag exclusion list to see if this click should be ignored",
- "sig" : "(node)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "HTMLElement",
- "desc" : "the HTMLElement to evaluate",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "boolean",
- "desc" : "true if this is a valid tag type, false if not"
- }
- ]
- },
+ "returns" : []
+ }
+ ],
+ "methods" : [
{
- "name" : "lock",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Lock this instance",
- "sig" : "()\n{\n\n}",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "on",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "desc" : "Appends an event handler to this component",
"sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
{
"name" : "options",
"type" : "Object",
- "desc" : "(optional)",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onAvailable",
- "type" : "function",
- "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "onBeforeDrag",
+ "name" : "applyTo",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action before the initial\ndrag event begins and optionally cancel it.",
- "sig" : "(data, e)",
+ "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "Roo.dd.DragSource",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data to be shared with drop targets",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id of the node, a DOM node or an existing Element",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "isValid True if the drag event is valid, else false to cancel"
+ "type" : "Roo.form.Field",
+ "desc" : "this"
}
]
},
{
- "name" : "onDrag",
+ "name" : "autoSize",
"type" : "function",
- "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
- "sig" : "(e)",
+ "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.TextField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "onDragDrop",
+ "name" : "capture",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
- "sig" : "(e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "onDragEnter",
- "type" : "function",
- "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
- "sig" : "(e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onDragOut",
+ "name" : "clearInvalid",
"type" : "function",
- "desc" : "Abstract method called when we are no longer hovering over an element",
- "sig" : "(e, id)",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "onDragOver",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
- "sig" : "(e, id)",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "onInitDrag",
+ "name" : "disable",
"type" : "function",
- "desc" : "Called once drag threshold has been reached to initialize the proxy element. By default, it clones the\nthis.dragData.ddel",
- "sig" : "(x, y)",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The x position of the click on the dragged object",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The y position of the click on the dragged object",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "true to continue the drag, false to cancel"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "onInvalidDrop",
+ "name" : "enable",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
- "sig" : "(e)",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "onMouseDown",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
- "sig" : "(e)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousedown event",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "onMouseUp",
+ "name" : "focus",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
- "sig" : "(e)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "onStartDrag",
+ "name" : "getBox",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action once the initial\ndrag event has begun. The drag cannot be canceled from this function.",
- "sig" : "(x, y)",
+ "desc" : "Gets the current box measurements of the component's underlying element.",
+ "sig" : "(local)",
"static" : false,
- "memberOf" : "Roo.dd.DragSource",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "x",
- "type" : "Number",
- "desc" : "The x position of the click on the dragged object",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The y position of the click on the dragged object",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "padding",
+ "name" : "getEl",
"type" : "function",
- "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "The element"
+ }
+ ]
},
{
- "name" : "purgeListeners",
+ "name" : "getId",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ "returns" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "removeFromGroup",
+ "name" : "getName",
"type" : "function",
- "desc" : "Remove's this instance from the supplied interaction group",
- "sig" : "(sGroup)",
+ "desc" : "Returns the name attribute of the field if available",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "sGroup",
- "type" : "string",
- "desc" : "The group to drop",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "name The field name"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "removeInvalidHandleClass",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "Unsets an invalid css class",
- "sig" : "(cssClass)",
+ "desc" : "Gets the current XY position of the component's underlying element.",
+ "sig" : "(local)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the element(s) you wish to\nre-enable",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "The XY position of the element (e.g., [100, 200])"
+ }
+ ]
},
{
- "name" : "removeInvalidHandleId",
+ "name" : "getRawValue",
"type" : "function",
- "desc" : "Unsets an invalid handle id",
- "sig" : "(id)",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "id",
- "type" : "string",
- "desc" : "the id of the element to re-enable",
- "isOptional" : false
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "removeInvalidHandleType",
+ "name" : "getSize",
"type" : "function",
- "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
- "sig" : "(tagName)",
+ "desc" : "Gets the current size of the component's underlying element.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to unexclude",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "removeListener",
+ "name" : "getValue",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "resetConstraints",
+ "name" : "hasChanged",
"type" : "function",
- "desc" : "resetConstraints must be called if you manually reposition a dd element.",
- "sig" : "(maintainOffset)",
+ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "maintainOffset",
- "type" : "boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setDelta",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)",
- "sig" : "(iDeltaX, iDeltaY)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iDeltaX",
- "type" : "int",
- "desc" : "the distance from the left",
- "isOptional" : false
- },
- {
- "name" : "iDeltaY",
- "type" : "int",
- "desc" : "the distance from the top",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "setDragElId",
+ "name" : "hide",
"type" : "function",
- "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
- "sig" : "(id)",
+ "desc" : "Hide this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "{string} the id of the element that will be used to initiate the drag",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setDragElPos",
+ "name" : "isDirty",
"type" : "function",
- "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
- "sig" : "(iPageX, iPageY)",
+ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the mousedown or drag event",
- "isOptional" : false
- },
- {
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the mousedown or drag event",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setHandleElId",
+ "name" : "isValid",
"type" : "function",
- "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
- "sig" : "(id)",
+ "desc" : "Returns whether or not the field value is currently valid",
+ "sig" : "(preventMark)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "True to disable marking the field invalid",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
},
{
- "name" : "setInitPosition",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Stores the initial placement of the linked element.",
- "sig" : "(diffX, diffY)",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "diffX",
- "type" : "int",
- "desc" : "the X offset, default 0",
- "isOptional" : false
- },
- {
- "name" : "diffY",
- "type" : "int",
- "desc" : "the Y offset, default 0",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setOuterHandleElId",
+ "name" : "markInvalid",
"type" : "function",
- "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
- "sig" : "(id)",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "the id of the element that will be used to initiate the drag",
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setPadding",
+ "name" : "on",
"type" : "function",
- "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
- "sig" : "(iTop, iRight, iBot, iLeft)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iTop",
- "type" : "int",
- "desc" : "Top pad",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "iRight",
- "type" : "int",
- "desc" : "Right pad",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "iBot",
- "type" : "int",
- "desc" : "Bot pad",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
},
{
- "name" : "iLeft",
- "type" : "int",
- "desc" : "Left pad",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setXConstraint",
+ "name" : "onPosition",
"type" : "function",
- "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
- "sig" : "(iLeft, iRight, iTickSize)",
+ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
+ "sig" : "(x, y)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iLeft",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the left",
- "isOptional" : false
- },
- {
- "name" : "iRight",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the\nright",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
"isOptional" : false
},
{
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setYConstraint",
+ "name" : "onResize",
"type" : "function",
- "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
- "sig" : "(iUp, iDown, iTickSize)",
+ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
+ "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iUp",
- "type" : "int",
- "desc" : "the number of pixels the element can move up",
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
"isOptional" : false
},
{
- "name" : "iDown",
- "type" : "int",
- "desc" : "the number of pixels the element can move down",
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
"isOptional" : false
},
{
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "startDrag",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
- "sig" : "(X, Y)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "X",
- "type" : "int",
- "desc" : "click location",
- "isOptional" : false
- },
- {
- "name" : "Y",
- "type" : "int",
- "desc" : "click location",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "toString",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "toString method",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "string",
- "desc" : "string representation of the dd obj"
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "un",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
+ "desc" : "Removes a listener",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"returns" : []
},
{
- "name" : "unlock",
+ "name" : "render",
"type" : "function",
- "desc" : "Unlock this instace",
- "sig" : "()\n{\n\n}",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "unreg",
+ "name" : "reset",
"type" : "function",
- "desc" : "Remove all drag and drop hooks for this element",
+ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.TextField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.dd.DropTarget" : {
- "props" : [
- {
- "name" : "ddGroup",
- "type" : "String",
- "desc" : "The drag drop group to handle drop events for",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "dropAllowed",
- "type" : "String",
- "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "dropNotAllowed",
- "type" : "String",
- "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "overClass",
- "type" : "String",
- "desc" : "The CSS class applied to the drop target element while the drag source is over it (defaults to \"\").",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "success",
- "type" : "boolean",
- "desc" : "set this after drop listener..",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "valid",
- "type" : "boolean|String",
- "desc" : "true/false or string (ok-add/ok-sub/ok/nodrop)\nif the drop point is valid for over/enter..",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "drop",
- "type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the dragged item has\nbeen dropped on it. This method has no default implementation and returns false, so you must provide an\nimplementation that does something to process the drop event and returns true so that the drag source's\nrepair action does not run.\n\nIMPORTANT : it should set this.success",
- "sig" : "function (source, e, data)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "enter",
- "type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the\ntarget. This default implementation adds the CSS class specified by overClass (if any) to the drop element\nand returns the dropAllowed config value. This method should be overridden if drop validation is required.\n\nIMPORTANT : it should set this.valid to true|false",
- "sig" : "function (source, e, data)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "out",
- "type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged\nout of the target without dropping. This default implementation simply removes the CSS class specified by\noverClass (if any) from the drop element.",
- "sig" : "function (source, e, data)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "over",
- "type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.\nThis method will be called on every mouse movement while the drag source is over the drop target.\nThis default implementation simply returns the dropAllowed config value.\n\nIMPORTANT : it should set this.valid to true|false",
- "sig" : "function (source, e, data)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "methods" : [
+ "returns" : []
+ },
{
- "name" : "addEvents",
+ "name" : "resetHasChanged",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "stores the current value in loadedValue",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "addInvalidHandleClass",
+ "name" : "selectText",
"type" : "function",
- "desc" : "Lets you specify a css class of elements that will not initiate a drag",
- "sig" : "(cssClass)",
+ "desc" : "Selects text in this field",
+ "sig" : "(start, end)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.TextField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the elements you wish to ignore",
+ "name" : "start",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should start (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "end",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should end (defaults to the text length)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addInvalidHandleId",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
- "sig" : "(id)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "string",
- "desc" : "the element id of the element you wish to ignore",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addInvalidHandleType",
+ "name" : "setPagePosition",
"type" : "function",
- "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
- "sig" : "(tagName)",
+ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
+ "sig" : "(x, y)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to exclude",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "setPosition",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
+ "sig" : "(left, top)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "left",
+ "type" : "Number",
+ "desc" : "The new left",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "top",
+ "type" : "Number",
+ "desc" : "The new top",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addToGroup",
+ "name" : "setRawValue",
"type" : "function",
- "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
- "sig" : "(sGroup)",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "sGroup",
- "type" : "",
- "desc" : "{string} the name of the group",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "applyConfig",
+ "name" : "setSize",
"type" : "function",
- "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
+ "sig" : "(width, height)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "width",
+ "type" : "Number/Object",
+ "desc" : "The new width to set, or a size object in the format {width, height}",
+ "isOptional" : false
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height to set (not required if a size object is passed as the first arg)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.BoxComponent",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "capture",
+ "name" : "setValue",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "clearConstraints",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "clearTicks",
+ "name" : "show",
"type" : "function",
- "desc" : "Clears any tick interval defined for this instance",
+ "desc" : "Show this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "endDrag",
+ "name" : "syncSize",
"type" : "function",
- "desc" : "Fired when we are done dragging the object",
- "sig" : "(e)",
+ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "un",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getDragEl",
+ "name" : "updateBox",
"type" : "function",
- "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the current box measurements of the component's underlying element.",
+ "sig" : "(box)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "HTMLElement",
- "desc" : "the html element"
+ "name" : "box",
+ "type" : "Object",
+ "desc" : "An object in the format {x, y, width, height}",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getEl",
+ "name" : "validate",
"type" : "function",
- "desc" : "Returns a reference to the linked element",
+ "desc" : "Validates the combox array value",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "HTMLElement",
- "desc" : "the html element"
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
}
]
},
{
- "name" : "hasListener",
+ "name" : "validateValue",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.form.TextField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "desc" : "True if the value is valid, else false"
}
]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.form.ComboBoxArray.Item" : {
+ "props" : [
+ {
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "height (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "init",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "width (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
- "sig" : "(id, sGroup, config)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "the id of the linked element",
- "isOptional" : false
- },
- {
- "name" : "sGroup",
- "type" : "String",
- "desc" : "the group of related items",
- "isOptional" : false
- },
- {
- "name" : "config",
- "type" : "object",
- "desc" : "configuration attributes",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "initTarget",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
- "sig" : "(id, sGroup, config)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "the id of the linked element",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforerender",
+ "type" : "function",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "sGroup",
- "type" : "String",
- "desc" : "the group of related items",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "config",
- "type" : "object",
- "desc" : "configuration attributes",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "isLocked",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "boolean",
- "desc" : "true if this obj or all drag/drop is locked, else\nfalse"
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "isTarget",
+ "name" : "disable",
"type" : "function",
- "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "isValidHandleChild",
+ "name" : "enable",
"type" : "function",
- "desc" : "Checks the tag exclusion list to see if this click should be ignored",
- "sig" : "(node)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "HTMLElement",
- "desc" : "the HTMLElement to evaluate",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "boolean",
- "desc" : "true if this is a valid tag type, false if not"
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "lock",
+ "name" : "move",
"type" : "function",
- "desc" : "Lock this instance",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is moved.",
+ "sig" : "function (_self, x, y)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "notifyDrop",
+ "name" : "render",
"type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "notifyEnter",
+ "name" : "resize",
"type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is resized.",
+ "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "notifyOut",
+ "name" : "show",
"type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "notifyOver",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "on",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "desc" : "Appends an event handler to this component",
"sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
{
"name" : "options",
"type" : "Object",
- "desc" : "(optional)",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onAvailable",
+ "name" : "capture",
"type" : "function",
- "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "onDrag",
+ "name" : "disable",
"type" : "function",
- "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
- "sig" : "(e)",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "onDragDrop",
+ "name" : "enable",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
- "sig" : "(e, id)",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "fireEvent",
+ "type" : "function",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "onDragEnter",
+ "name" : "focus",
"type" : "function",
- "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
- "sig" : "(e, id)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.",
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "onDragOut",
+ "name" : "getBox",
"type" : "function",
- "desc" : "Abstract method called when we are no longer hovering over an element",
- "sig" : "(e, id)",
+ "desc" : "Gets the current box measurements of the component's underlying element.",
+ "sig" : "(local)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onDragOver",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
- "sig" : "(e, id)",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- },
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "The element"
+ }
+ ]
+ },
+ {
+ "name" : "getId",
+ "type" : "function",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "onInvalidDrop",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
- "sig" : "(e)",
+ "desc" : "Gets the current XY position of the component's underlying element.",
+ "sig" : "(local)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "The XY position of the element (e.g., [100, 200])"
+ }
+ ]
},
{
- "name" : "onMouseDown",
+ "name" : "getSize",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
- "sig" : "(e)",
+ "desc" : "Gets the current size of the component's underlying element.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousedown event",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "onMouseUp",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
- "sig" : "(e)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "padding",
+ "name" : "hide",
"type" : "function",
- "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
+ "desc" : "Hide this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "purgeListeners",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "on",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
"memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeFromGroup",
+ "name" : "onPosition",
"type" : "function",
- "desc" : "Remove's this instance from the supplied interaction group",
- "sig" : "(sGroup)",
+ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
+ "sig" : "(x, y)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "sGroup",
- "type" : "string",
- "desc" : "The group to drop",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeInvalidHandleClass",
+ "name" : "onResize",
"type" : "function",
- "desc" : "Unsets an invalid css class",
- "sig" : "(cssClass)",
+ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
+ "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the element(s) you wish to\nre-enable",
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeInvalidHandleId",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Unsets an invalid handle id",
- "sig" : "(id)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "string",
- "desc" : "the id of the element to re-enable",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "removeInvalidHandleType",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
- "sig" : "(tagName)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to unexclude",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resetConstraints",
- "type" : "function",
- "desc" : "resetConstraints must be called if you manually reposition a dd element.",
- "sig" : "(maintainOffset)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "maintainOffset",
- "type" : "boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setDragElId",
+ "name" : "render",
"type" : "function",
- "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
- "sig" : "(id)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "{string} the id of the element that will be used to initiate the drag",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setHandleElId",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
- "sig" : "(id)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setInitPosition",
+ "name" : "setPagePosition",
"type" : "function",
- "desc" : "Stores the initial placement of the linked element.",
- "sig" : "(diffX, diffY)",
+ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
+ "sig" : "(x, y)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "diffX",
- "type" : "int",
- "desc" : "the X offset, default 0",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
"isOptional" : false
},
{
- "name" : "diffY",
- "type" : "int",
- "desc" : "the Y offset, default 0",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setOuterHandleElId",
- "type" : "function",
- "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "",
- "desc" : "the id of the element that will be used to initiate the drag",
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setPadding",
+ "name" : "setPosition",
"type" : "function",
- "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
- "sig" : "(iTop, iRight, iBot, iLeft)",
+ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
+ "sig" : "(left, top)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iTop",
- "type" : "int",
- "desc" : "Top pad",
- "isOptional" : false
- },
- {
- "name" : "iRight",
- "type" : "int",
- "desc" : "Right pad",
- "isOptional" : false
- },
- {
- "name" : "iBot",
- "type" : "int",
- "desc" : "Bot pad",
+ "name" : "left",
+ "type" : "Number",
+ "desc" : "The new left",
"isOptional" : false
},
{
- "name" : "iLeft",
- "type" : "int",
- "desc" : "Left pad",
+ "name" : "top",
+ "type" : "Number",
+ "desc" : "The new top",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setXConstraint",
+ "name" : "setSize",
"type" : "function",
- "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
- "sig" : "(iLeft, iRight, iTickSize)",
+ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
+ "sig" : "(width, height)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iLeft",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the left",
- "isOptional" : false
- },
- {
- "name" : "iRight",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the\nright",
+ "name" : "width",
+ "type" : "Number/Object",
+ "desc" : "The new width to set, or a size object in the format {width, height}",
"isOptional" : false
},
{
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height to set (not required if a size object is passed as the first arg)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.BoxComponent",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "setYConstraint",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
- "sig" : "(iUp, iDown, iTickSize)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iUp",
- "type" : "int",
- "desc" : "the number of pixels the element can move up",
- "isOptional" : false
- },
- {
- "name" : "iDown",
- "type" : "int",
- "desc" : "the number of pixels the element can move down",
- "isOptional" : false
- },
- {
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "startDrag",
+ "name" : "show",
"type" : "function",
- "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
- "sig" : "(X, Y)",
+ "desc" : "Show this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "X",
- "type" : "int",
- "desc" : "click location",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "Y",
- "type" : "int",
- "desc" : "click location",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "toString",
+ "name" : "syncSize",
"type" : "function",
- "desc" : "toString method",
+ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "string",
- "desc" : "string representation of the dd obj"
- }
- ]
+ "returns" : []
},
{
"name" : "un",
"returns" : []
},
{
- "name" : "unlock",
- "type" : "function",
- "desc" : "Unlock this instace",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "unreg",
+ "name" : "updateBox",
"type" : "function",
- "desc" : "Remove all drag and drop hooks for this element",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the current box measurements of the component's underlying element.",
+ "sig" : "(box)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "box",
+ "type" : "Object",
+ "desc" : "An object in the format {x, y, width, height}",
+ "isOptional" : false
+ }
+ ],
"returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.dd.DropZone"
- ],
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.dd.DropZone" : {
+ "Roo.form.ComboCheck" : {
"props" : [
{
- "name" : "ddGroup",
+ "name" : "actionMode",
"type" : "String",
- "desc" : "The drag drop group to handle drop events for",
- "memberOf" : "Roo.dd.DropTarget",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "dropAllowed",
+ "name" : "allQuery",
"type" : "String",
- "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
- "memberOf" : "Roo.dd.DropTarget",
+ "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
+ "memberOf" : "Roo.form.ComboBox",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "dropNotAllowed",
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "alwaysQuery",
+ "type" : "Boolean",
+ "desc" : "Disable caching of results, and always send query",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoCreate",
+ "type" : "Boolean/Object",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "blankText",
"type" : "String",
- "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
- "memberOf" : "Roo.dd.DropTarget",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "blockFocus",
+ "type" : "Boolean",
+ "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "A CSS class to apply to the field's underlying element.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClear",
+ "type" : "Boolean",
+ "desc" : "Disable showing of clear button.",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "True to disable the field (defaults to false).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "displayField",
+ "type" : "String",
+ "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "editable",
+ "type" : "Boolean",
+ "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "emptyText",
+ "type" : "String",
+ "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldClass",
+ "type" : "String",
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "String",
+ "desc" : "Label to use when rendering a form.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "forceSelection",
+ "type" : "Boolean",
+ "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "grow",
+ "type" : "Boolean",
+ "desc" : "",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMax",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "handleHeight",
+ "type" : "Number",
+ "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "height (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hiddenName",
+ "type" : "String",
+ "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "hideTrigger",
+ "type" : "Boolean",
+ "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf" : "Roo.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "lazyRender",
+ "type" : "Boolean",
+ "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listAlign",
+ "type" : "String",
+ "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listWidth",
+ "type" : "Number",
+ "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
+ "memberOf" : "Roo.form.ComboBox",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "overClass",
+ "name" : "loadingText",
+ "type" : "String",
+ "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxHeight",
+ "type" : "Number",
+ "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minChars",
+ "type" : "Number",
+ "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minListWidth",
+ "type" : "Number",
+ "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "mode",
+ "type" : "String",
+ "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "msgFx",
+ "type" : "String",
+ "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "msgTarget",
+ "type" : "String",
+ "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The field's HTML name attribute.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "pageSize",
+ "type" : "Number",
+ "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "qtip",
+ "type" : "String",
+ "desc" : "Mouse over tip",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "queryDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "queryParam",
+ "type" : "String",
+ "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "resizable",
+ "type" : "Boolean",
+ "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "selectedClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "shadow",
+ "type" : "Boolean/String",
+ "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to which this combo is bound (defaults to undefined)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tabIndex",
+ "type" : "Number",
+ "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tpl",
+ "type" : "String/Roo.Template",
+ "desc" : "The template to use to render the output",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "transform",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "triggerAction",
+ "type" : "String",
+ "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "triggerClass",
+ "type" : "String",
+ "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "typeAhead",
+ "type" : "Boolean",
+ "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "typeAheadDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "A value to initialize this field with.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "valueField",
+ "type" : "String",
+ "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "valueNotFoundText",
"type" : "String",
- "desc" : "The CSS class applied to the drop target element while the drag source is over it (defaults to \"\").",
- "memberOf" : "Roo.dd.DropTarget",
+ "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
+ "memberOf" : "Roo.form.ComboBox",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "success",
- "type" : "boolean",
- "desc" : "set this after drop listener..",
- "memberOf" : "Roo.dd.DropTarget",
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.form.TextField",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "valid",
- "type" : "boolean|String",
- "desc" : "true/false or string (ok-add/ok-sub/ok/nodrop)\nif the drop point is valid for over/enter..",
- "memberOf" : "Roo.dd.DropTarget",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "width (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
{
- "name" : "drop",
+ "name" : "add",
"type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the dragged item has\nbeen dropped on it. This method has no default implementation and returns false, so you must provide an\nimplementation that does something to process the drop event and returns true so that the drag source's\nrepair action does not run.\n\nIMPORTANT : it should set this.success",
- "sig" : "function (source, e, data)\n{\n\n}",
- "memberOf" : "Roo.dd.DropTarget",
+ "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enter",
+ "name" : "autosize",
"type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the\ntarget. This default implementation adds the CSS class specified by overClass (if any) to the drop element\nand returns the dropAllowed config value. This method should be overridden if drop validation is required.\n\nIMPORTANT : it should set this.valid to true|false",
- "sig" : "function (source, e, data)\n{\n\n}",
- "memberOf" : "Roo.dd.DropTarget",
+ "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
+ "sig" : "function (_self, width)\n{\n\n}",
+ "memberOf" : "Roo.form.TextField",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "This text field",
"isOptional" : false
},
{
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The new field width",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "out",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged\nout of the target without dropping. This default implementation simply removes the CSS class specified by\noverClass (if any) from the drop element.",
- "sig" : "function (source, e, data)\n{\n\n}",
- "memberOf" : "Roo.dd.DropTarget",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforehide",
+ "type" : "function",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "over",
+ "name" : "beforequery",
"type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.\nThis method will be called on every mouse movement while the drag source is over the drop target.\nThis default implementation simply returns the dropAllowed config value.\n\nIMPORTANT : it should set this.valid to true|false",
- "sig" : "function (source, e, data)\n{\n\n}",
- "memberOf" : "Roo.dd.DropTarget",
+ "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
+ "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop target",
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "name" : "query",
+ "type" : "String",
+ "desc" : "The query",
"isOptional" : false
},
{
- "name" : "data",
+ "name" : "forceAll",
+ "type" : "Boolean",
+ "desc" : "true to force \"all\" query",
+ "isOptional" : false
+ },
+ {
+ "name" : "cancel",
+ "type" : "Boolean",
+ "desc" : "true to cancel the query",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
"type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "desc" : "The query event object",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "addEvents",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addInvalidHandleClass",
+ "name" : "beforeselect",
"type" : "function",
- "desc" : "Lets you specify a css class of elements that will not initiate a drag",
- "sig" : "(cssClass)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
+ "sig" : "function (combo, record, index)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the elements you wish to ignore",
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The data record returned from the underlying store",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the selected item in the dropdown list",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addInvalidHandleId",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "string",
- "desc" : "the element id of the element you wish to ignore",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addInvalidHandleType",
+ "name" : "blur",
"type" : "function",
- "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
- "sig" : "(tagName)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to exclude",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "change",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addToGroup",
+ "name" : "collapse",
"type" : "function",
- "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
- "sig" : "(sGroup)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the dropdown list is collapsed",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "sGroup",
- "type" : "",
- "desc" : "{string} the name of the group",
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "applyConfig",
- "type" : "function",
- "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "capture",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "clearConstraints",
- "type" : "function",
- "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "clearTicks",
+ "name" : "disable",
"type" : "function",
- "desc" : "Clears any tick interval defined for this instance",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "endDrag",
+ "name" : "edit",
"type" : "function",
- "desc" : "Fired when we are done dragging the object",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo, record)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record|false",
+ "desc" : "The data record returned from the underlying store (or false on nothing selected)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
},
{
- "name" : "getDragEl",
+ "name" : "expand",
"type" : "function",
- "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the dropdown list is expanded",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "HTMLElement",
- "desc" : "the html element"
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getEl",
+ "name" : "focus",
"type" : "function",
- "desc" : "Returns a reference to the linked element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "HTMLElement",
- "desc" : "the html element"
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getTargetFromEvent",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns a custom data object associated with the DOM node that is the target of the event. By default\nthis looks up the event target in the {@link Roo.dd.Registry}, although you can override this method to\nprovide your own custom lookup.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "data The custom data"
- }
- ]
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "invalid",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
"type" : "String",
- "desc" : "The name of the event to check for",
+ "desc" : "The validation message",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "init",
+ "name" : "keyup",
"type" : "function",
- "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
- "sig" : "(id, sGroup, config)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "the id of the linked element",
- "isOptional" : false
- },
- {
- "name" : "sGroup",
- "type" : "String",
- "desc" : "the group of related items",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "config",
- "type" : "object",
- "desc" : "configuration attributes",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "initTarget",
+ "name" : "move",
"type" : "function",
- "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
- "sig" : "(id, sGroup, config)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is moved.",
+ "sig" : "function (_self, x, y)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "the id of the linked element",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "sGroup",
- "type" : "String",
- "desc" : "the group of related items",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
"isOptional" : false
},
{
- "name" : "config",
- "type" : "object",
- "desc" : "configuration attributes",
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "isLocked",
+ "name" : "render",
"type" : "function",
- "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "boolean",
- "desc" : "true if this obj or all drag/drop is locked, else\nfalse"
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "isTarget",
- "type" : "function",
- "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ ],
"returns" : []
},
{
- "name" : "isValidHandleChild",
+ "name" : "resize",
"type" : "function",
- "desc" : "Checks the tag exclusion list to see if this click should be ignored",
- "sig" : "(node)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is resized.",
+ "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "HTMLElement",
- "desc" : "the HTMLElement to evaluate",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "boolean",
- "desc" : "true if this is a valid tag type, false if not"
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "lock",
- "type" : "function",
- "desc" : "Lock this instance",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ ],
"returns" : []
},
{
- "name" : "notifyDrop",
+ "name" : "select",
"type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the dragged item has\nbeen dropped on it. The drag zone will look up the target node based on the event passed in, and if there\nis a node registered for that event, it will delegate to {@link #onNodeDrop} for node-specific handling,\notherwise it will call {@link #onContainerDrop}.",
- "sig" : "(source, e, data)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a list item is selected",
+ "sig" : "function (combo, record, index)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop zone",
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The data record returned from the underlying store (or false on clear)",
"isOptional" : false
},
{
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the selected item in the dropdown list",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the drop was valid, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "notifyEnter",
+ "name" : "show",
"type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the source is now over\nthe zone. The default implementation returns this.dropNotAllowed and expects that only registered drop\nnodes can process drag drop operations, so if you need the drop zone itself to be able to process drops\nyou should override this method and provide a custom implementation.",
- "sig" : "(source, e, data)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop zone",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated"
- }
- ]
+ "returns" : []
},
{
- "name" : "notifyOut",
+ "name" : "specialkey",
"type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the source has been dragged\nout of the zone without dropping. If the drag source is currently over a registered node, the notification\nwill be delegated to {@link #onNodeOut} for node-specific handling, otherwise it will be ignored.",
- "sig" : "(source, e, data)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop target",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
},
{
"name" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag zone",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "notifyOver",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the drop zone.\nThis method will be called on every mouse movement while the drag source is over the drop zone.\nIt will call {@link #onNodeOver} while the drag source is over a registered node, and will also automatically\ndelegate to the appropriate node-specific methods as necessary when the drag source enters and exits\nregistered nodes ({@link #onNodeEnter}, {@link #onNodeOut}). If the drag source is not currently over a\nregistered node, it will call {@link #onContainerOver}.",
- "sig" : "(source, e, data)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop zone",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
- "isOptional" : false
- },
- {
- "name" : "data",
+ "name" : "object",
"type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated"
- }
- ]
+ "returns" : []
},
{
- "name" : "on",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "desc" : "Appends an event handler to this component",
"sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
{
"name" : "options",
"type" : "Object",
- "desc" : "(optional)",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onAvailable",
+ "name" : "applyTo",
"type" : "function",
- "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id of the node, a DOM node or an existing Element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.form.Field",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "onContainerDrop",
+ "name" : "autoSize",
"type" : "function",
- "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dropped on it,\nbut not on any of its registered drop nodes. The default implementation returns false, so it should be\noverridden to provide the appropriate processing of the drop event if you need the drop zone itself to\nbe able to accept drops. It should return true when valid so that the drag source's repair action does not run.",
- "sig" : "(source, e, data)",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.TriggerField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop zone",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the drop was valid, else false"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "onContainerOver",
+ "name" : "capture",
"type" : "function",
- "desc" : "Called internally while the DropZone determines that a {@link Roo.dd.DragSource} is being dragged over it,\nbut not over any of its registered drop nodes. The default implementation returns this.dropNotAllowed, so\nit should be overridden to provide the proper feedback if necessary.",
- "sig" : "(source, e, data)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop zone",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
"isOptional" : false
},
{
- "name" : "data",
+ "name" : "scope",
"type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated"
- }
- ]
+ "returns" : []
},
{
- "name" : "onDrag",
+ "name" : "clearInvalid",
"type" : "function",
- "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
- "sig" : "(e)",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "onDragDrop",
+ "name" : "clearValue",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
- "sig" : "(e, id)",
+ "desc" : "Clears any text/value currently set in the field",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "onDragEnter",
+ "name" : "collapse",
"type" : "function",
- "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
- "sig" : "(e, id)",
+ "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "onDragOut",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Abstract method called when we are no longer hovering over an element",
- "sig" : "(e, id)",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "onDragOver",
+ "name" : "disable",
"type" : "function",
- "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
- "sig" : "(e, id)",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "onInvalidDrop",
+ "name" : "doQuery",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
- "sig" : "(e)",
+ "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
+ "sig" : "(query, forceAll)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "query",
+ "type" : "String",
+ "desc" : "The SQL query to execute",
+ "isOptional" : false
+ },
+ {
+ "name" : "forceAll",
+ "type" : "Boolean",
+ "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onMouseDown",
+ "name" : "enable",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
- "sig" : "(e)",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousedown event",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "onMouseUp",
+ "name" : "expand",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
- "sig" : "(e)",
+ "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "onNodeDrop",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dropped onto\nthe drop node. The default implementation returns false, so it should be overridden to provide the\nappropriate processing of the drop event and return true so that the drag source's repair action does not run.",
- "sig" : "(nodeData, source, e, data)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "nodeData",
- "type" : "Object",
- "desc" : "The custom data associated with the drop node (this is the same value returned from\n{@link #getTargetFromEvent} for this node)",
- "isOptional" : false
- },
- {
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop zone",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Boolean",
- "desc" : "True if the drop was valid, else false"
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "onNodeEnter",
+ "name" : "focus",
"type" : "function",
- "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has entered a drop node\nthat it has registered. This method has no default implementation and should be overridden to provide\nnode-specific processing if necessary.",
- "sig" : "(nodeData, source, e, data)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "nodeData",
- "type" : "Object",
- "desc" : "The custom data associated with the drop node (this is the same value returned from \n{@link #getTargetFromEvent} for this node)",
- "isOptional" : false
- },
- {
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop zone",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "onNodeOut",
+ "name" : "getBox",
"type" : "function",
- "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dragged out of\nthe drop node without dropping. This method has no default implementation and should be overridden to provide\nnode-specific processing if necessary.",
- "sig" : "(nodeData, source, e, data)",
+ "desc" : "Gets the current box measurements of the component's underlying element.",
+ "sig" : "(local)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "nodeData",
- "type" : "Object",
- "desc" : "The custom data associated with the drop node (this is the same value returned from\n{@link #getTargetFromEvent} for this node)",
- "isOptional" : false
- },
- {
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop zone",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onNodeOver",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Called internally while the DropZone determines that a {@link Roo.dd.DragSource} is over a drop node\nthat it has registered. The default implementation returns this.dropNotAllowed, so it should be\noverridden to provide the proper feedback.",
- "sig" : "(nodeData, source, e, data)",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "nodeData",
- "type" : "Object",
- "desc" : "The custom data associated with the drop node (this is the same value returned from\n{@link #getTargetFromEvent} for this node)",
- "isOptional" : false
- },
- {
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop zone",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated"
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "padding",
+ "name" : "getId",
"type" : "function",
- "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "purgeListeners",
+ "name" : "getName",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Returns the name attribute of the field if available",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "name The field name"
+ }
+ ]
},
{
- "name" : "releaseCapture",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Gets the current XY position of the component's underlying element.",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "The XY position of the element (e.g., [100, 200])"
+ }
+ ]
},
{
- "name" : "removeFromGroup",
+ "name" : "getRawValue",
"type" : "function",
- "desc" : "Remove's this instance from the supplied interaction group",
- "sig" : "(sGroup)",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "sGroup",
- "type" : "string",
- "desc" : "The group to drop",
- "isOptional" : false
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "removeInvalidHandleClass",
+ "name" : "getSize",
"type" : "function",
- "desc" : "Unsets an invalid css class",
- "sig" : "(cssClass)",
+ "desc" : "Gets the current size of the component's underlying element.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the element(s) you wish to\nre-enable",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "removeInvalidHandleId",
+ "name" : "getValue",
"type" : "function",
- "desc" : "Unsets an invalid handle id",
- "sig" : "(id)",
+ "desc" : "Returns the currently selected field value or empty string if no value is set.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "id",
- "type" : "string",
- "desc" : "the id of the element to re-enable",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "value The selected value"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "removeInvalidHandleType",
+ "name" : "hasChanged",
"type" : "function",
- "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
- "sig" : "(tagName)",
+ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to unexclude",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "resetConstraints",
+ "name" : "hide",
"type" : "function",
- "desc" : "resetConstraints must be called if you manually reposition a dd element.",
- "sig" : "(maintainOffset)",
+ "desc" : "Hide this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "maintainOffset",
- "type" : "boolean",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setDragElId",
+ "name" : "isDirty",
"type" : "function",
- "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
- "sig" : "(id)",
+ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "",
- "desc" : "{string} the id of the element that will be used to initiate the drag",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setHandleElId",
+ "name" : "isExpanded",
"type" : "function",
- "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
- "sig" : "(id)",
+ "desc" : "Returns true if the dropdown list is expanded, else false.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "",
- "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setInitPosition",
+ "name" : "isValid",
"type" : "function",
- "desc" : "Stores the initial placement of the linked element.",
- "sig" : "(diffX, diffY)",
+ "desc" : "Returns whether or not the field value is currently valid",
+ "sig" : "(preventMark)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "diffX",
- "type" : "int",
- "desc" : "the X offset, default 0",
- "isOptional" : false
- },
- {
- "name" : "diffY",
- "type" : "int",
- "desc" : "the Y offset, default 0",
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "True to disable marking the field invalid",
"isOptional" : false
}
],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "setOuterHandleElId",
+ "name" : "markInvalid",
"type" : "function",
- "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
- "sig" : "(id)",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "the id of the element that will be used to initiate the drag",
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setPadding",
+ "name" : "on",
"type" : "function",
- "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
- "sig" : "(iTop, iRight, iBot, iLeft)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iTop",
- "type" : "int",
- "desc" : "Top pad",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "iRight",
- "type" : "int",
- "desc" : "Right pad",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "iBot",
- "type" : "int",
- "desc" : "Bot pad",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
},
{
- "name" : "iLeft",
- "type" : "int",
- "desc" : "Left pad",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setXConstraint",
+ "name" : "onPosition",
"type" : "function",
- "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
- "sig" : "(iLeft, iRight, iTickSize)",
+ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
+ "sig" : "(x, y)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iLeft",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the left",
- "isOptional" : false
- },
- {
- "name" : "iRight",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the\nright",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
"isOptional" : false
},
{
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setYConstraint",
+ "name" : "onResize",
"type" : "function",
- "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
- "sig" : "(iUp, iDown, iTickSize)",
+ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
+ "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iUp",
- "type" : "int",
- "desc" : "the number of pixels the element can move up",
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
"isOptional" : false
},
{
- "name" : "iDown",
- "type" : "int",
- "desc" : "the number of pixels the element can move down",
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
"isOptional" : false
},
{
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "startDrag",
+ "name" : "onTriggerClick",
"type" : "function",
- "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
- "sig" : "(X, Y)",
+ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.TriggerField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "X",
- "type" : "int",
- "desc" : "click location",
- "isOptional" : false
- },
- {
- "name" : "Y",
- "type" : "int",
- "desc" : "click location",
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "toString",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "toString method",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "string",
- "desc" : "string representation of the dd obj"
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "un",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
+ "desc" : "Removes a listener",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"returns" : []
},
{
- "name" : "unlock",
+ "name" : "render",
"type" : "function",
- "desc" : "Unlock this instace",
- "sig" : "()\n{\n\n}",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "unreg",
+ "name" : "reset",
"type" : "function",
- "desc" : "Remove all drag and drop hooks for this element",
+ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.form.TextField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.dd.Registry" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "getHandle",
+ "name" : "resetHasChanged",
"type" : "function",
- "desc" : "Returns the handle registered for a DOM Node by id",
- "sig" : "(id)",
+ "desc" : "stores the current value in loadedValue",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String|HTMLElement",
- "desc" : "The DOM node or id to look up",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "handle The custom handle data"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "getHandleFromEvent",
+ "name" : "select",
"type" : "function",
- "desc" : "Returns the handle that is registered for the DOM node that is the target of the event",
- "sig" : "(e)",
+ "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(index, scrollIntoView)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The zero-based index of the list item to select",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Object",
- "desc" : "handle The custom handle data"
+ "name" : "scrollIntoView",
+ "type" : "Boolean",
+ "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getTarget",
+ "name" : "selectByValue",
"type" : "function",
- "desc" : "Returns a custom data object that is registered for a DOM node by id",
- "sig" : "(id)",
+ "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(value, scrollIntoView)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String|HTMLElement",
- "desc" : "The DOM node or id to look up",
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The data value of the item to select",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollIntoView",
+ "type" : "Boolean",
+ "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "data The custom data"
+ "type" : "Boolean",
+ "desc" : "True if the value matched an item in the list, else false"
}
]
},
{
- "name" : "getTargetFromEvent",
+ "name" : "selectText",
"type" : "function",
- "desc" : "Returns a custom data object that is registered for the DOM node that is the target of the event",
- "sig" : "(e)",
+ "desc" : "Selects text in this field",
+ "sig" : "(start, end)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.TextField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "name" : "start",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should start (defaults to 0)",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Object",
- "desc" : "data The custom data"
+ "name" : "end",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should end (defaults to the text length)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "register",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Register a drag drop element",
- "sig" : "(element, data)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "element",
- "type" : "String|HTMLElement",
- "desc" : "The id or DOM node to register",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "(optional) A custom data object that will be passed between the elements that are involved\nin drag drop operations. You can populate this object with any arbitrary properties that your own code\nknows how to interpret, plus there are some specific properties known to the Registry that should be\npopulated in the data object (if applicable):\n<pre>\nValue Description<br />\n--------- ------------------------------------------<br />\nhandles Array of DOM nodes that trigger dragging<br />\n for the element being registered<br />\nisHandle True if the element passed in triggers<br />\n dragging itself, else false\n</pre>",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "unregister",
+ "name" : "setEditable",
"type" : "function",
- "desc" : "Unregister a drag drop element",
- "sig" : "(element)",
+ "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "element",
- "type" : "String|HTMLElement",
- "desc" : "The id or DOM node to unregister",
+ "name" : "value",
+ "type" : "Boolean",
+ "desc" : "True to allow the user to directly edit the field text",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.dd.ScrollManager" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "refreshCache",
+ "name" : "setFromData",
"type" : "function",
- "desc" : "Manually trigger a cache refresh.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Object",
+ "desc" : "the value to set as. or false on reset?",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "register",
+ "name" : "setPagePosition",
"type" : "function",
- "desc" : "Registers new overflow element(s) to auto scroll",
- "sig" : "(el)",
+ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
+ "sig" : "(x, y)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element/Array",
- "desc" : "The id of or the element to be scrolled or an array of either",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "unregister",
+ "name" : "setPosition",
"type" : "function",
- "desc" : "Unregisters overflow element(s) so they are no longer scrolled",
- "sig" : "(el)",
+ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
+ "sig" : "(left, top)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element/Array",
- "desc" : "The id of or the element to be removed or an array of either",
+ "name" : "left",
+ "type" : "Number",
+ "desc" : "The new left",
+ "isOptional" : false
+ },
+ {
+ "name" : "top",
+ "type" : "Number",
+ "desc" : "The new top",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.dd.StatusProxy" : {
- "props" : [
- {
- "name" : "dropAllowed",
- "type" : "String",
- "desc" : "The CSS class to apply to the status element when drop is allowed (defaults to \"x-dd-drop-ok\").",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
},
{
- "name" : "dropNotAllowed",
- "type" : "String",
- "desc" : "The CSS class to apply to the status element when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
- {
- "name" : "getEl",
+ "name" : "setRawValue",
"type" : "function",
- "desc" : "Returns the underlying proxy {@link Roo.Layer}",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Layer",
- "desc" : "el"
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getGhost",
+ "name" : "setSize",
"type" : "function",
- "desc" : "Returns the ghost element",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
+ "sig" : "(width, height)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "width",
+ "type" : "Number/Object",
+ "desc" : "The new width to set, or a size object in the format {width, height}",
+ "isOptional" : false
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height to set (not required if a size object is passed as the first arg)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "el"
+ "type" : "Roo.BoxComponent",
+ "desc" : "this"
}
]
},
{
- "name" : "hide",
+ "name" : "setValue",
"type" : "function",
- "desc" : "Hides the proxy",
- "sig" : "(clear)",
+ "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "clear",
- "type" : "Boolean",
- "desc" : "True to reset the status and clear the ghost contents, false to preserve them",
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The value to match",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "repair",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Causes the proxy to return to its position of origin via an animation. Should be called after an\ninvalid drop operation by the item being dragged.",
- "sig" : "(xy, callback, scope)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "xy",
- "type" : "Array",
- "desc" : "The XY position of the element ([x, y])",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "The function to call after the repair is complete",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "The scope in which to execute the callback",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "reset",
+ "name" : "show",
"type" : "function",
- "desc" : "Resets the status indicator to the default dropNotAllowed value",
- "sig" : "(clearGhost)",
+ "desc" : "Show this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "clearGhost",
- "type" : "Boolean",
- "desc" : "True to also remove all content from the ghost, false to preserve it",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setStatus",
+ "name" : "syncSize",
"type" : "function",
- "desc" : "Updates the proxy's visual element to indicate the status of whether or not drop is allowed\nover the current target element.",
- "sig" : "(cssClass)",
+ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "cssClass",
- "type" : "String",
- "desc" : "The css class for the new drop status indicator image",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "show",
+ "name" : "un",
"type" : "function",
- "desc" : "Displays this proxy",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "stop",
+ "name" : "updateBox",
"type" : "function",
- "desc" : "Stops the repair animation if it's currently running",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the current box measurements of the component's underlying element.",
+ "sig" : "(box)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "box",
+ "type" : "Object",
+ "desc" : "An object in the format {x, y, width, height}",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "sync",
+ "name" : "validate",
"type" : "function",
- "desc" : "Force the Layer to sync its shadow and shim positions to the element",
+ "desc" : "Validates the field value",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
},
{
- "name" : "update",
+ "name" : "validateValue",
"type" : "function",
- "desc" : "Updates the contents of the ghost element",
- "sig" : "(html)",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.TextField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "html",
- "type" : "String",
- "desc" : "The html that will replace the current innerHTML of the ghost element",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.dialog" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.dialog.UploadCropbox" : {
+ "Roo.form.ComboNested" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "allQuery",
+ "type" : "String",
+ "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"optvals" : []
},
{
- "name" : "buttons",
- "type" : "Array",
- "desc" : "default ['rotateLeft', 'pictureBtn', 'rotateRight']",
- "memberOf" : "",
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "alwaysQuery",
+ "type" : "Boolean",
+ "desc" : "Disable caching of results, and always send query",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoCreate",
+ "type" : "Boolean/Object",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "blockFocus",
+ "type" : "Boolean",
+ "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "A CSS class to apply to the field's underlying element.",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "disableClear",
+ "type" : "Boolean",
+ "desc" : "Disable showing of clear button.",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "True to disable the field (defaults to false).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "displayField",
+ "type" : "String",
+ "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "editable",
+ "type" : "Boolean",
+ "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "emptyText",
"type" : "String",
- "desc" : "show when image has been loaded",
- "memberOf" : "",
+ "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf" : "Roo.form.TextField",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "errorTimeout",
+ "name" : "fieldClass",
+ "type" : "String",
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "String",
+ "desc" : "Label to use when rendering a form.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "forceSelection",
+ "type" : "Boolean",
+ "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "grow",
+ "type" : "Boolean",
+ "desc" : "",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMax",
"type" : "Number",
- "desc" : "default 3000",
- "memberOf" : "",
+ "desc" : "",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "handleHeight",
+ "type" : "Number",
+ "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
+ "memberOf" : "Roo.form.ComboBox",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "hiddenName",
+ "type" : "String",
+ "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "hideMode",
"type" : "String",
]
},
{
- "name" : "isDocument",
+ "name" : "hideTrigger",
"type" : "Boolean",
- "desc" : "e) default fal",
- "memberOf" : "",
+ "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf" : "Roo.form.TriggerField",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
+ "optvals" : []
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "lazyRender",
+ "type" : "Boolean",
+ "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listAlign",
+ "type" : "String",
+ "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listWidth",
+ "type" : "Number",
+ "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "listeners",
"optvals" : []
},
{
- "name" : "loadMask",
- "type" : "Boolean",
- "desc" : "e) default tr",
- "memberOf" : "",
+ "name" : "loadingText",
+ "type" : "String",
+ "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
+ "memberOf" : "Roo.form.ComboBox",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
+ "optvals" : []
},
{
- "name" : "loadingText",
- "type" : "Boolean",
- "desc" : "default 'Loading...'",
- "memberOf" : "",
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.form.TextField",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "method",
+ "name" : "maxHeight",
+ "type" : "Number",
+ "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLengthText",
"type" : "String",
- "desc" : "default POST",
- "memberOf" : "",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "Roo.form.TextField",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "minHeight",
+ "name" : "minChars",
"type" : "Number",
- "desc" : "default 300",
- "memberOf" : "",
+ "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
+ "memberOf" : "Roo.form.ComboBox",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "minWidth",
+ "name" : "minLength",
"type" : "Number",
- "desc" : "default 300",
- "memberOf" : "",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.form.TextField",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "outputMaxWidth",
+ "name" : "minLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minListWidth",
"type" : "Number",
- "desc" : "default 1200",
- "memberOf" : "",
+ "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
+ "memberOf" : "Roo.form.ComboBox",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "paramName",
+ "name" : "mode",
"type" : "String",
- "desc" : "default 'imageUpload'",
- "memberOf" : "",
+ "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
+ "memberOf" : "Roo.form.ComboBox",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "rotateNotify",
+ "name" : "msgFx",
"type" : "String",
- "desc" : "show when image too small to rotate",
- "memberOf" : "",
+ "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "msgTarget",
+ "type" : "String",
+ "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The field's HTML name attribute.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "pageSize",
+ "type" : "Number",
+ "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "qtip",
+ "type" : "String",
+ "desc" : "Mouse over tip",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "queryDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "queryParam",
+ "type" : "String",
+ "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "resizable",
+ "type" : "Boolean",
+ "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "selectedClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "shadow",
+ "type" : "Boolean/String",
+ "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to which this combo is bound (defaults to undefined)",
+ "memberOf" : "Roo.form.ComboBox",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "url",
+ "name" : "tabIndex",
+ "type" : "Number",
+ "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "title",
"type" : "String",
- "desc" : "action url",
- "memberOf" : "",
+ "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
+ "memberOf" : "Roo.form.ComboBox",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "width",
+ "name" : "tpl",
+ "type" : "String/Roo.Template",
+ "desc" : "The template to use to render the output",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "transform",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "triggerAction",
+ "type" : "String",
+ "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "triggerClass",
+ "type" : "String",
+ "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "typeAhead",
+ "type" : "Boolean",
+ "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "typeAheadDelay",
"type" : "Number",
- "desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent",
+ "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
+ "memberOf" : "Roo.form.ComboBox",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "windowSize",
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationDelay",
"type" : "Number",
- "desc" : "default 300",
- "memberOf" : "",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "A value to initialize this field with.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "valueField",
+ "type" : "String",
+ "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "valueNotFoundText",
+ "type" : "String",
+ "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "width (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
{
- "name" : "arrange",
+ "name" : "add",
"type" : "function",
- "desc" : "Fire when arrange the file data",
- "sig" : "function (_self, formData)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "autosize",
+ "type" : "function",
+ "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
+ "sig" : "function (_self, width)\n{\n\n}",
+ "memberOf" : "Roo.form.TextField",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.dialog.UploadCropbox",
- "desc" : "",
+ "type" : "Roo.form.Field",
+ "desc" : "This text field",
"isOptional" : false
},
{
- "name" : "formData",
- "type" : "Object",
- "desc" : "",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The new field width",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeloadcanvas",
+ "name" : "beforequery",
"type" : "function",
- "desc" : "Fire before load the canvas",
- "sig" : "function (_self, src)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
+ "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.dialog.UploadCropbox",
- "desc" : "",
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
},
{
- "name" : "src",
+ "name" : "query",
"type" : "String",
- "desc" : "",
+ "desc" : "The query",
+ "isOptional" : false
+ },
+ {
+ "name" : "forceAll",
+ "type" : "Boolean",
+ "desc" : "true to force \"all\" query",
+ "isOptional" : false
+ },
+ {
+ "name" : "cancel",
+ "type" : "Boolean",
+ "desc" : "true to cancel the query",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "The query event object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeselectfile",
+ "name" : "beforeselect",
"type" : "function",
- "desc" : "Fire before select file",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
+ "sig" : "function (combo, record, index)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.dialog.UploadCropbox",
- "desc" : "",
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The data record returned from the underlying store",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the selected item in the dropdown list",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "crop",
+ "name" : "blur",
"type" : "function",
- "desc" : "Fire after initEvent",
- "sig" : "function (_self, data)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.dialog.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "String",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "change",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "collapse",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when the dropdown list is collapsed",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "download",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fire when download the image",
+ "desc" : "Fires after the component is destroyed.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.dialog.UploadCropbox",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "enable",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
+ "desc" : "Fires after the component is disabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "exception",
+ "name" : "edit",
"type" : "function",
- "desc" : "Fire when get exception",
- "sig" : "function (_self, xhr)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo, record)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.dialog.UploadCropbox",
- "desc" : "",
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
},
{
- "name" : "xhr",
- "type" : "XMLHttpRequest",
- "desc" : "",
+ "name" : "record",
+ "type" : "Roo.data.Record|false",
+ "desc" : "The data record returned from the underlying store (or false on nothing selected)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "footerbuttonclick",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fire when footerbuttonclick",
- "sig" : "function (_self, type)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.dialog.UploadCropbox",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Fires when the dropdown list is expanded",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "type",
- "type" : "String",
- "desc" : "",
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "hide",
+ "name" : "focus",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires when this field receives input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "initial",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fire after initEvent",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.dialog.UploadCropbox",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "inspect",
+ "name" : "invalid",
"type" : "function",
- "desc" : "Fire when inspect the file",
- "sig" : "function (_self, file)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.dialog.UploadCropbox",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
},
- {
- "name" : "file",
- "type" : "Object",
- "desc" : "",
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "loadcanvas",
+ "name" : "keyup",
"type" : "function",
- "desc" : "Fire after load the canvas",
- "sig" : "function (, imgEl)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "",
- "type" : "Roo.dialog.UploadCropbox",
+ "name" : "this",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
},
{
- "name" : "imgEl",
- "type" : "Object",
- "desc" : "",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
"isOptional" : false
}
],
],
"returns" : []
},
- {
- "name" : "prepare",
- "type" : "function",
- "desc" : "Fire when preparing the file data",
- "sig" : "function (_self, file)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.dialog.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "file",
- "type" : "Object",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
{
"name" : "resize",
"type" : "function",
- "desc" : "Fire when resize",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is resized.",
+ "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.dialog.UploadCropbox",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "rotate",
+ "name" : "select",
"type" : "function",
- "desc" : "Fire when rotate the image",
- "sig" : "function (_self, pos)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when a list item is selected",
+ "sig" : "function (combo, record, index)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.dialog.UploadCropbox",
- "desc" : "",
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
},
{
- "name" : "pos",
- "type" : "String",
- "desc" : "",
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The data record returned from the underlying store (or false on clear)",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the selected item in the dropdown list",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "trash",
+ "name" : "specialkey",
"type" : "function",
- "desc" : "Fire when trash image",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.dialog.UploadCropbox",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "upload",
+ "name" : "valid",
"type" : "function",
- "desc" : "Fire when xhr upload the file",
- "sig" : "function (_self, data)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.dialog.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "Object",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "capture",
+ "name" : "applyTo",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
+ "sig" : "(el)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id of the node, a DOM node or an existing Element",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "this"
}
]
},
{
- "name" : "enable",
+ "name" : "autoSize",
"type" : "function",
- "desc" : "Enable this component.",
+ "desc" : "",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.TriggerField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "capture",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
"memberOf" : "Roo.util.Observable",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
"isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "getBox",
+ "name" : "clearInvalid",
"type" : "function",
- "desc" : "Gets the current box measurements of the component's underlying element.",
- "sig" : "(local)",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "getEl",
+ "name" : "clearValue",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Clears any text/value currently set in the field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
- }
- ]
+ "returns" : []
},
{
- "name" : "getId",
+ "name" : "collapse",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getPosition",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Gets the current XY position of the component's underlying element.",
- "sig" : "(local)",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Array",
- "desc" : "The XY position of the element (e.g., [100, 200])"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "getSize",
+ "name" : "disable",
"type" : "function",
- "desc" : "Gets the current size of the component's underlying element.",
+ "desc" : "Disable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "hasListener",
+ "name" : "doQuery",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
+ "sig" : "(query, forceAll)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "query",
"type" : "String",
- "desc" : "The name of the event to check for",
+ "desc" : "The SQL query to execute",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
+ "name" : "forceAll",
"type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hide",
+ "name" : "enable",
"type" : "function",
- "desc" : "Hide this component.",
+ "desc" : "Enable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component",
]
},
{
- "name" : "isVisible",
+ "name" : "expand",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
+ "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "on",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "onPosition",
+ "name" : "focus",
"type" : "function",
- "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
- "sig" : "(x, y)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "onResize",
+ "name" : "getBox",
"type" : "function",
- "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
- "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
+ "desc" : "Gets the current box measurements of the component's underlying element.",
+ "sig" : "(local)",
"static" : false,
"memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
- "isOptional" : false
- },
- {
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
- "isOptional" : false
- },
- {
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "The element"
+ }
+ ]
},
{
- "name" : "releaseCapture",
+ "name" : "getId",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "removeListener",
+ "name" : "getName",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Returns the name attribute of the field if available",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "eventName",
+ "name" : "",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
+ "desc" : "name The field name"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "render",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Gets the current XY position of the component's underlying element.",
+ "sig" : "(local)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "The XY position of the element (e.g., [100, 200])"
+ }
+ ]
},
{
- "name" : "setDisabled",
+ "name" : "getRawValue",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setPagePosition",
+ "name" : "getSize",
"type" : "function",
- "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
- "sig" : "(x, y)",
+ "desc" : "Gets the current size of the component's underlying element.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setPosition",
+ "name" : "getValue",
"type" : "function",
- "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
- "sig" : "(left, top)",
+ "desc" : "Returns the currently selected field value or empty string if no value is set.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "left",
- "type" : "Number",
- "desc" : "The new left",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "top",
- "type" : "Number",
- "desc" : "The new top",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "value The selected value"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setSize",
+ "name" : "hasChanged",
"type" : "function",
- "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
- "sig" : "(width, height)",
+ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "width",
- "type" : "Number/Object",
- "desc" : "The new width to set, or a size object in the format {width, height}",
- "isOptional" : false
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "The new height to set (not required if a size object is passed as the first arg)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.BoxComponent",
- "desc" : "this"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "setVisible",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "show",
+ "name" : "hide",
"type" : "function",
- "desc" : "Show this component.",
+ "desc" : "Hide this component.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component",
]
},
{
- "name" : "syncSize",
+ "name" : "isDirty",
"type" : "function",
- "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
+ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "updateBox",
+ "name" : "isExpanded",
"type" : "function",
- "desc" : "Sets the current box measurements of the component's underlying element.",
- "sig" : "(box)",
+ "desc" : "Returns true if the dropdown list is expanded, else false.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "box",
- "type" : "Object",
- "desc" : "An object in the format {x, y, width, height}",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.form" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.form.Action" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.form.BasicForm" : {
- "props" : [
- {
- "name" : "baseParams",
- "type" : "Object",
- "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "errorMask",
- "type" : "Boolean",
- "desc" : "Should the form be masked (and the active element highlighted on error - default false",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "errorReader",
- "type" : "DataReader",
- "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when reading validation errors on \"submit\" actions.\nThis is completely optional as there is built-in support for processing JSON.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fileUpload",
- "type" : "Boolean",
- "desc" : "Set to true if this form is a file upload.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maskOffset",
- "type" : "Number",
- "desc" : "space around form element to mask if there is an error Default 100",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "method",
- "type" : "String",
- "desc" : "The request method to use (GET or POST) for form actions if one isn't supplied in the action options.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "reader",
- "type" : "DataReader",
- "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when executing \"load\" actions.\nThis is optional as there is built-in support for processing JSON.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "timeout",
- "type" : "Number",
- "desc" : "Timeout for form actions in seconds (default is 30 seconds).",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "trackResetOnLoad",
- "type" : "Boolean",
- "desc" : "If set to true, form.reset() resets to the last loaded\nor setValues() data instead of when the form was first created.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "url",
- "type" : "String",
- "desc" : "The URL to use for form actions if one isn't supplied in the action options.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "actioncomplete",
- "type" : "function",
- "desc" : "Fires when an action is completed.",
- "sig" : "function (_self, action)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Form",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "action",
- "type" : "Action",
- "desc" : "The action that completed",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "actionfailed",
- "type" : "function",
- "desc" : "Fires when an action fails.",
- "sig" : "function (_self, action)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Form",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "action",
- "type" : "Action",
- "desc" : "The action that failed",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "beforeaction",
- "type" : "function",
- "desc" : "Fires before any action is performed. Return false to cancel the action.",
- "sig" : "function (_self, action)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Form",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "action",
- "type" : "Action",
- "desc" : "The action to be performed",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "methods" : [
- {
- "name" : "add",
+ "name" : "isValid",
"type" : "function",
- "desc" : "Add Roo.form components to this form.",
- "sig" : "(field1, field2, etc)",
+ "desc" : "Returns whether or not the field value is currently valid",
+ "sig" : "(preventMark)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "field1",
- "type" : "Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "field2",
- "type" : "Field",
- "desc" : "(optional)",
- "isOptional" : false
- },
- {
- "name" : "etc",
- "type" : "Field",
- "desc" : "(optional)",
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "True to disable marking the field invalid",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "BasicForm",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
}
]
},
{
- "name" : "addEvents",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "addForm",
+ "name" : "markInvalid",
"type" : "function",
- "desc" : "Add a secondary form to this one, \nUsed to provide tabbed forms. One form is primary, with hidden values \nwhich mirror the elements from the other forms.",
- "sig" : "(form)",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "form",
- "type" : "Roo.form.Form",
- "desc" : "to add.",
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "on",
"type" : "function",
- "desc" : "Appends an event handler to this component",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
"sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
{
"name" : "options",
"type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "applyIfToFields",
+ "name" : "onPosition",
"type" : "function",
- "desc" : "Calls {@link Ext#applyIf} for all field in this form with the passed object.",
- "sig" : "(values)",
+ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
+ "sig" : "(x, y)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "values",
- "type" : "Object",
- "desc" : "",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "applyToFields",
+ "name" : "onResize",
"type" : "function",
- "desc" : "Calls {@link Ext#apply} for all fields in this form with the passed object.",
- "sig" : "(values)",
+ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
+ "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "values",
- "type" : "Object",
- "desc" : "",
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
"isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "capture",
- "type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
"isOptional" : false
},
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "clearInvalid",
+ "name" : "onTriggerClick",
"type" : "function",
- "desc" : "Clears all invalid messages in this form.",
- "sig" : "()\n{\n\n}",
+ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.TriggerField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "doAction",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.",
- "sig" : "(actionName, options)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "actionName",
- "type" : "String",
- "desc" : "The name of the action type",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) The options to pass to the action. All of the config options listed\nbelow are supported by both the submit and load actions unless otherwise noted (custom actions could also\naccept other config options):\n<pre>\nProperty Type Description\n---------------- --------------- ----------------------------------------------------------------------------------\nurl String The url for the action (defaults to the form's url)\nmethod String The form method to use (defaults to the form's method, or POST if not defined)\nparams String/Object The params to pass (defaults to the form's baseParams, or none if not defined)\nclientValidation Boolean Applies to submit only. Pass true to call form.isValid() prior to posting to\n validate the form on the client (defaults to false)\n</pre>",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "findField",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String",
- "desc" : "The value to search for",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "",
- "desc" : "Field"
- }
- ]
+ "returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getFieldValues",
+ "name" : "render",
"type" : "function",
- "desc" : "Returns the fields in this form as an object with key/value pairs. \nThis differs from getValues as it calls getValue on each child item, rather than using dom data.\nNormally this will not return readOnly data",
- "sig" : "(with_readonly)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "with_readonly",
- "type" : "Boolean",
- "desc" : "return readonly field data.",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getValues",
+ "name" : "reset",
"type" : "function",
- "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.",
- "sig" : "(asString)",
+ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.TextField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "asString",
- "type" : "Boolean",
- "desc" : "(def)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : ""
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "hasChanged",
+ "name" : "resetHasChanged",
"type" : "function",
- "desc" : "Returns true if any fields in this form have changed since their original load. (New version)",
+ "desc" : "stores the current value in loadedValue",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "",
- "desc" : "Boolean"
- }
- ]
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "select",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(index, scrollIntoView)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The zero-based index of the list item to select",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
+ "name" : "scrollIntoView",
"type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "invalidFields",
+ "name" : "selectByValue",
"type" : "function",
- "desc" : "Returns array of invalid form fields.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(value, scrollIntoView)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The data value of the item to select",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollIntoView",
+ "type" : "Boolean",
+ "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "",
- "desc" : "Array"
+ "type" : "Boolean",
+ "desc" : "True if the value matched an item in the list, else false"
}
]
},
{
- "name" : "isDirty",
+ "name" : "selectText",
"type" : "function",
- "desc" : "DEPRICATED Returns true if any fields in this form have changed since their original load.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Selects text in this field",
+ "sig" : "(start, end)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.TextField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "",
- "desc" : "Boolean"
+ "name" : "start",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should start (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "end",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should end (defaults to the text length)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "isValid",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Returns true if client-side validation on the form is successful.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "",
- "desc" : "Boolean"
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "load",
+ "name" : "setEditable",
"type" : "function",
- "desc" : "Shortcut to do a load action.",
- "sig" : "(options)",
+ "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "The options to pass to the action (see {@link #doAction} for details)",
+ "name" : "value",
+ "type" : "Boolean",
+ "desc" : "True to allow the user to directly edit the field text",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "loadRecord",
+ "name" : "setFromData",
"type" : "function",
- "desc" : "Loads an Roo.data.Record into this form.",
- "sig" : "(record)",
+ "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "record",
- "type" : "Record",
- "desc" : "The record to load",
+ "name" : "value",
+ "type" : "Object",
+ "desc" : "the value to set as. or false on reset?",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "markInvalid",
+ "name" : "setPagePosition",
"type" : "function",
- "desc" : "Mark fields in this form invalid in bulk.",
- "sig" : "(errors)",
+ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
+ "sig" : "(x, y)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "errors",
- "type" : "Array/Object",
- "desc" : "Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "on",
+ "name" : "setPosition",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
+ "sig" : "(left, top)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "left",
+ "type" : "Number",
+ "desc" : "The new left",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "top",
+ "type" : "Number",
+ "desc" : "The new top",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "setRawValue",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "setSize",
"type" : "function",
- "desc" : "Removes a field from the items collection (does NOT remove its markup).",
- "sig" : "(field)",
+ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
+ "sig" : "(width, height)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "field",
- "type" : "Field",
- "desc" : "",
+ "name" : "width",
+ "type" : "Number/Object",
+ "desc" : "The new width to set, or a size object in the format {width, height}",
+ "isOptional" : false
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height to set (not required if a size object is passed as the first arg)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "BasicForm",
+ "type" : "Roo.BoxComponent",
"desc" : "this"
}
]
},
{
- "name" : "removeListener",
+ "name" : "setValue",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "value",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "The value to match",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Looks at the fields in this form, checks them for an id attribute,\nand calls applyTo on the existing dom element with that id.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "BasicForm",
+ "type" : "Roo.Component",
"desc" : "this"
}
]
},
{
- "name" : "reset",
+ "name" : "show",
"type" : "function",
- "desc" : "Resets this form.",
+ "desc" : "Show this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "BasicForm",
+ "type" : "Roo.Component",
"desc" : "this"
}
]
},
{
- "name" : "resetHasChanged",
+ "name" : "syncSize",
"type" : "function",
- "desc" : "Resets all hasChanged to 'false' -\nThe old 'isDirty' used 'original value..' however this breaks reset() and a few other things.\nSo hasChanged storage is only to be used for this purpose",
+ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "",
- "desc" : "Boolean"
- }
- ]
+ "returns" : []
},
{
- "name" : "setValues",
+ "name" : "un",
"type" : "function",
- "desc" : "Set values for fields in this form in bulk.",
- "sig" : "(values)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "values",
- "type" : "Array/Object",
- "desc" : "Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "submit",
+ "name" : "updateBox",
"type" : "function",
- "desc" : "Shortcut to do a submit action.",
- "sig" : "(options)",
+ "desc" : "Sets the current box measurements of the component's underlying element.",
+ "sig" : "(box)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "options",
+ "name" : "box",
"type" : "Object",
- "desc" : "The options to pass to the action (see {@link #doAction} for details)",
+ "desc" : "An object in the format {x, y, width, height}",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "un",
+ "name" : "validate",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "updateRecord",
+ "name" : "validateValue",
"type" : "function",
- "desc" : "Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.",
- "sig" : "(record)",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.TextField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "record",
- "type" : "Record",
- "desc" : "The record to edit",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "BasicForm",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
}
]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.form.Form"
- ],
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.Checkbox" : {
+ "Roo.form.DateField" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"optvals" : []
},
{
- "name" : "autoCreate",
- "type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
- "memberOf" : "",
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "boxLabel",
+ "name" : "altFormats",
"type" : "String",
- "desc" : "The text that appears beside the checkbox",
+ "desc" : "Multiple date formats separated by \"|\" to try when parsing a user input value and it doesn't match the defined\nformat (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d').",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "checked",
- "type" : "Boolean",
- "desc" : "True if the the checkbox should render already checked (defaults to false)",
+ "name" : "autoCreate",
+ "type" : "String/Object",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"10\", autocomplete: \"off\"})",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "cls",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "disabled",
"type" : "Boolean",
"optvals" : []
},
{
- "name" : "fieldClass",
+ "name" : "disabledDates",
+ "type" : "Array",
+ "desc" : "An array of \"dates\" to disable, as strings. These strings will be used to build a dynamic regular\nexpression so they are very powerful. Some examples:\n<ul>\n<li>[\"03/08/2003\", \"09/16/2003\"] would disable those exact dates</li>\n<li>[\"03/08\", \"09/16\"] would disable those days for every year</li>\n<li>[\"^03/08\"] would only match the beginning (useful if you are using short years)</li>\n<li>[\"03/../2006\"] would disable every day in March 2006</li>\n<li>[\"^03\"] would disable every day in every March</li>\n</ul>\nIn order to support regular expressions, if you are using a date format that has \".\" in it, you will have to\nescape the dot when restricting dates. For example: [\"03\\\\.08\\\\.03\"].",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabledDatesText",
"type" : "String",
- "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
+ "desc" : "The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabledDays",
+ "type" : "Array",
+ "desc" : "An array of days to disable, 0 based. For example, [0, 6] disables Sunday and Saturday (defaults to null).",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabledDaysText",
+ "type" : "String",
+ "desc" : "The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "emptyText",
+ "type" : "String",
+ "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldClass",
+ "type" : "String",
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "fieldLabel",
"type" : "String",
{
"name" : "focusClass",
"type" : "String",
- "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "format",
+ "type" : "String",
+ "desc" : "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
]
},
{
- "name" : "inputType",
- "type" : "String",
- "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field",
+ "name" : "hideTrigger",
+ "type" : "Boolean",
+ "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf" : "Roo.form.TriggerField",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "inputValue",
+ "name" : "inputType",
"type" : "String",
- "desc" : "The value that should go into the generated input element's value attribute",
- "memberOf" : "",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
{
"name" : "invalidText",
"type" : "String",
- "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : "Roo.form.Field",
+ "desc" : "The error text to display when the date in the field is invalid (defaults to\n'{value} is not a valid date - it must be in the format {format}').",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxText",
+ "type" : "String",
+ "desc" : "The error text to display when the date in the cell is after maxValue (defaults to\n'The date in this field must be before {maxValue}').",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxValue",
+ "type" : "Date/String",
+ "desc" : "The maximum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minText",
+ "type" : "String",
+ "desc" : "The error text to display when the date in the cell is before minValue (defaults to\n'The date in this field must be after {minValue}').",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minValue",
+ "type" : "Date/String",
+ "desc" : "The minimum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "msgFx",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "style",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "triggerClass",
+ "type" : "String",
+ "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-date-trigger'\nwhich displays a calendar icon).",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "useIso",
+ "type" : "Boolean",
+ "desc" : "if enabled, then the date field will use a hidden field to store the \nreal value as iso formated date. default (false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "validateOnBlur",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "value",
"type" : "Mixed",
"optvals" : []
},
{
- "name" : "valueOff",
+ "name" : "vtype",
"type" : "String",
- "desc" : "The value that should go into the generated input element's value when unchecked.",
- "memberOf" : "",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.form.TextField",
"isOptional" : false,
"optvals" : []
},
"memberOf" : "Roo.BoxComponent",
"isOptional" : false,
"optvals" : []
+ },
+ {
+ "name" : "zeroValue",
+ "type" : "Date/String",
+ "desc" : "if the date is less that this number, then the field is rendered as empty\ndefault is 1800",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
+ {
+ "name" : "autosize",
+ "type" : "function",
+ "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
+ "sig" : "function (_self, width)\n{\n\n}",
+ "memberOf" : "Roo.form.TextField",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "This text field",
+ "isOptional" : false
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The new field width",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "check",
- "type" : "function",
- "desc" : "Fires when the checkbox is checked or unchecked.",
- "sig" : "function (_self, checked)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Checkbox",
- "desc" : "This checkbox",
- "isOptional" : false
- },
- {
- "name" : "checked",
- "type" : "Boolean",
- "desc" : "The new checked value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "Fires when a date is selected",
+ "sig" : "function (combo, date)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.form.DateField",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "date",
+ "type" : "Date",
+ "desc" : "The date selected",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
}
]
},
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.TriggerField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
{
"name" : "getValue",
"type" : "function",
- "desc" : "Returns the checked state of the checkbox.",
+ "desc" : "Returns the current date value of the date field.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if checked, else false"
+ "type" : "Date",
+ "desc" : "The date value"
}
]
},
],
"returns" : []
},
+ {
+ "name" : "onTriggerClick",
+ "type" : "function",
+ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.form.TriggerField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "purgeListeners",
"type" : "function",
{
"name" : "reset",
"type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.form.TextField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
+ {
+ "name" : "selectText",
+ "type" : "function",
+ "desc" : "Selects text in this field",
+ "sig" : "(start, end)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "start",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should start (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "end",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should end (defaults to the text length)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.",
- "sig" : "(value, suppressEvent)",
+ "desc" : "Sets the value of the date field. You can pass a date object or any string that can be parsed into a valid\ndate, using DateField.format as the date format, according to the same rules as {@link Date#parseDate}\n(the default format used is \"m/d/y\").\n<br />Usage:\n<pre><code>\n//All of these calls set the same date value (May 4, 2006)\n\n//Pass a date object:\nvar dt = new Date('5/4/06');\ndateField.setValue(dt);\n\n//Pass a date string (default format):\ndateField.setValue('5/4/06');\n\n//Pass a date string (custom format):\ndateField.format = 'Y-m-d';\ndateField.setValue('2006-5-4');\n</code></pre>",
+ "sig" : "(date)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Boolean/String",
- "desc" : "- the value to set",
- "isOptional" : false
- },
- {
- "name" : "suppressEvent",
- "type" : "Boolean/String",
- "desc" : "- whether to suppress the checkchange event.",
+ "name" : "date",
+ "type" : "String/Date",
+ "desc" : "The date or valid date string",
"isOptional" : false
}
],
"desc" : "True if the value is valid, else false"
}
]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.form.Radio"
- ],
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.Column" : {
+ "Roo.form.DayPicker" : {
"props" : [
{
"name" : "actionMode",
{
"name" : "autoCreate",
"type" : "String/Object",
- "desc" : "A DomHelper element spec used to autocreate the column (defaults to {tag: 'div', cls: 'x-form-ct x-form-column'})",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "clear",
- "type" : "Boolean",
- "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
- "memberOf" : "Roo.form.Layout",
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "A CSS class to apply to the field's underlying element.",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "hideLabels",
+ "name" : "disabled",
"type" : "Boolean",
- "desc" : "True to suppress the display of field labels in this layout (defaults to false)",
- "memberOf" : "Roo.form.Layout",
+ "desc" : "True to disable the field (defaults to false).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldClass",
+ "type" : "String",
+ "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "String",
+ "desc" : "Label to use when rendering a form.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "height (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
"isOptional" : false,
"optvals" : []
},
]
},
{
- "name" : "labelAlign",
+ "name" : "inputType",
"type" : "String",
- "desc" : "t)\nValid values are \"left,\" \"top\" and \"right\" (defaults to \"left",
- "memberOf" : "Roo.form.Layout",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
- "optvals" : [
- "left",
- "top",
- "right"
- ]
+ "optvals" : []
},
{
- "name" : "labelSeparator",
+ "name" : "invalidClass",
"type" : "String",
- "desc" : "The separator to use after field labels (defaults to ':')",
- "memberOf" : "Roo.form.Layout",
+ "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
- "memberOf" : "Roo.form.Layout",
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "msgFx",
+ "type" : "String",
+ "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "msgTarget",
+ "type" : "String",
+ "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The field's HTML name attribute.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "qtip",
+ "type" : "String",
+ "desc" : "Mouse over tip",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "style",
- "type" : "String/Object/Function",
- "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
- "memberOf" : "Roo.form.Layout",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tabIndex",
+ "type" : "Number",
+ "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "A value to initialize this field with.",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
{
"name" : "width",
- "type" : "Number/String",
- "desc" : "The fixed width of the column in pixels or CSS value (defaults to \"auto\")",
- "memberOf" : "",
+ "type" : "Number",
+ "desc" : "width (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
"isOptional" : false,
"optvals" : []
}
],
"returns" : []
},
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "move",
+ "type" : "function",
+ "desc" : "Fires after the component is moved.",
+ "sig" : "function (_self, x, y)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "resize",
+ "type" : "function",
+ "desc" : "Fires after the component is resized.",
+ "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
"returns" : []
},
{
- "name" : "addxtype",
+ "name" : "applyTo",
"type" : "function",
- "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column",
- "sig" : "(config)",
+ "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "Roo.form.Layout",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "config",
- "type" : "Object",
- "desc" : "",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id of the node, a DOM node or an existing Element",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.form.Field",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "capture",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "fireEvent",
+ "type" : "function",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "getBox",
+ "type" : "function",
+ "desc" : "Gets the current box measurements of the component's underlying element.",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "The element"
+ }
+ ]
+ },
+ {
+ "name" : "getId",
+ "type" : "function",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name attribute of the field if available",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "name The field name"
+ }
+ ]
+ },
+ {
+ "name" : "getPosition",
+ "type" : "function",
+ "desc" : "Gets the current XY position of the component's underlying element.",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "The XY position of the element (e.g., [100, 200])"
+ }
+ ]
},
{
- "name" : "destroy",
+ "name" : "getRawValue",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
},
{
- "name" : "disable",
+ "name" : "getSize",
"type" : "function",
- "desc" : "Disable this component.",
+ "desc" : "Gets the current size of the component's underlying element.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Object",
+ "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
}
]
},
{
- "name" : "enable",
+ "name" : "getValue",
"type" : "function",
- "desc" : "Enable this component.",
+ "desc" : "Returns the checked state of the checkbox.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "True if checked, else false"
}
]
},
{
- "name" : "fireEvent",
+ "name" : "hasChanged",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "focus",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "getEl",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Hide this component.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component",
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getId",
+ "name" : "isDirty",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "isValid",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Returns whether or not the field value is currently valid",
+ "sig" : "(preventMark)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "True to disable marking the field invalid",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "desc" : "True if the value is valid, else false"
}
]
},
{
- "name" : "hide",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Hide this component.",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "isVisible",
+ "name" : "markInvalid",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
],
"returns" : []
},
+ {
+ "name" : "onPosition",
+ "type" : "function",
+ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
+ "sig" : "(x, y)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "onResize",
+ "type" : "function",
+ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
+ "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "purgeListeners",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "resetHasChanged",
+ "type" : "function",
+ "desc" : "stores the current value in loadedValue",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setPagePosition",
+ "type" : "function",
+ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
+ "sig" : "(x, y)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setPosition",
+ "type" : "function",
+ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
+ "sig" : "(left, top)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "left",
+ "type" : "Number",
+ "desc" : "The new left",
+ "isOptional" : false
+ },
+ {
+ "name" : "top",
+ "type" : "Number",
+ "desc" : "The new top",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setSize",
+ "type" : "function",
+ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
+ "sig" : "(width, height)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "width",
+ "type" : "Number/Object",
+ "desc" : "The new width to set, or a size object in the format {width, height}",
+ "isOptional" : false
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height to set (not required if a size object is passed as the first arg)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.BoxComponent",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.",
+ "sig" : "(value, suppressEvent)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Boolean/String",
+ "desc" : "- the value to set",
+ "isOptional" : false
+ },
+ {
+ "name" : "suppressEvent",
+ "type" : "Boolean/String",
+ "desc" : "- whether to suppress the checkchange event.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisible",
"type" : "function",
}
]
},
+ {
+ "name" : "syncSize",
+ "type" : "function",
+ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "un",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "updateBox",
+ "type" : "function",
+ "desc" : "Sets the current box measurements of the component's underlying element.",
+ "sig" : "(box)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "box",
+ "type" : "Object",
+ "desc" : "An object in the format {x, y, width, height}",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.form.Row",
- "Roo.form.Field",
- "Roo.form.Checkbox",
- "Roo.form.ComboBox",
- "Roo.form.ComboBoxArray",
- "Roo.form.ComboCheck",
- "Roo.form.ComboNested",
- "Roo.form.DateField",
- "Roo.form.DayPicker",
- "Roo.form.DisplayField",
- "Roo.form.FCKeditor",
- "Roo.form.GridField",
- "Roo.form.Hidden",
- "Roo.form.HtmlEditor",
- "Roo.form.MonthField",
- "Roo.form.NumberField",
- "Roo.form.Radio",
- "Roo.form.Select",
- "Roo.form.Signature",
- "Roo.form.TextArea",
- "Roo.form.TextField",
- "Roo.form.TriggerField",
- "Roo.Button",
- "Roo.SplitButton",
- "Roo.Toolbar.Button",
- "Roo.Toolbar.SplitButton",
- "Roo.form.TextItem",
- "Roo.form.FieldSet"
- ],
+ "tree_children" : [],
"tree_parent" : []
},
- "Roo.form.ComboBox" : {
+ "Roo.form.DisplayField" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "allQuery",
- "type" : "String",
- "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "allowLeadingSpace",
- "type" : "Boolean",
- "desc" : "True to prevent the stripping of leading white space",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "alwaysQuery",
- "type" : "Boolean",
- "desc" : "Disable caching of results, and always send query",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "autoCreate",
- "type" : "Boolean/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
+ "type" : "String/Object",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "blockFocus",
+ "name" : "closable",
"type" : "Boolean",
- "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
+ "desc" : "e) default fal",
"memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "cls",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "disableClear",
- "type" : "Boolean",
- "desc" : "Disable showing of clear button.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "disabled",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "displayField",
- "type" : "String",
- "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "editable",
- "type" : "Boolean",
- "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "emptyText",
- "type" : "String",
- "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "fieldClass",
"type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field",
+ "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
"name" : "focusClass",
"type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "forceSelection",
- "type" : "Boolean",
- "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "grow",
- "type" : "Boolean",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "growMax",
- "type" : "Number",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "growMin",
- "type" : "Number",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "handleHeight",
- "type" : "Number",
- "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
+ "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "hiddenName",
- "type" : "String",
- "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "hideMode",
"type" : "String",
"visibility"
]
},
- {
- "name" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "Roo.form.TriggerField",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "inputType",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "lazyRender",
- "type" : "Boolean",
- "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listAlign",
- "type" : "String",
- "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listClass",
- "type" : "String",
- "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listWidth",
- "type" : "Number",
- "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "loadingText",
- "type" : "String",
- "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxHeight",
- "type" : "Number",
- "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minChars",
- "type" : "Number",
- "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minListWidth",
- "type" : "Number",
- "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "mode",
- "type" : "String",
- "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "msgFx",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "pageSize",
- "type" : "Number",
- "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "qtip",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "queryDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "queryParam",
- "type" : "String",
- "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "readOnly",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "resizable",
- "type" : "Boolean",
- "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "selectedClass",
- "type" : "String",
- "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "shadow",
- "type" : "Boolean/String",
- "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to which this combo is bound (defaults to undefined)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "style",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "title",
- "type" : "String",
- "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "tpl",
- "type" : "String/Roo.Template",
- "desc" : "The template to use to render the output",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "transform",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "triggerAction",
- "type" : "String",
- "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "triggerClass",
- "type" : "String",
- "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "typeAhead",
- "type" : "Boolean",
- "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "typeAheadDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "validateOnBlur",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "value",
"type" : "Mixed",
"optvals" : []
},
{
- "name" : "valueField",
- "type" : "String",
- "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "valueNotFoundText",
- "type" : "String",
- "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
+ "name" : "valueRenderer",
+ "type" : "Function",
+ "desc" : "The renderer for the field (so you can reformat output). should return raw HTML",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "width",
"type" : "Number",
}
],
"events" : [
- {
- "name" : "add",
- "type" : "function",
- "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "autosize",
- "type" : "function",
- "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
- "sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : "Roo.form.TextField",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "This text field",
- "isOptional" : false
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The new field width",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "beforequery",
- "type" : "function",
- "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
- "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "query",
- "type" : "String",
- "desc" : "The query",
- "isOptional" : false
- },
- {
- "name" : "forceAll",
- "type" : "Boolean",
- "desc" : "true to force \"all\" query",
- "isOptional" : false
- },
- {
- "name" : "cancel",
- "type" : "Boolean",
- "desc" : "true to cancel the query",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Object",
- "desc" : "The query event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforerender",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "beforeselect",
- "type" : "function",
- "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
- "sig" : "function (combo, record, index)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The data record returned from the underlying store",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the selected item in the dropdown list",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforeshow",
"type" : "function",
"returns" : []
},
{
- "name" : "collapse",
+ "name" : "close",
"type" : "function",
- "desc" : "Fires when the dropdown list is collapsed",
- "sig" : "function (combo)\n{\n\n}",
+ "desc" : "Fires after the click the close btn",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
+ "name" : "this",
+ "type" : "Roo.form.DisplayField",
+ "desc" : "",
"isOptional" : false
}
],
],
"returns" : []
},
- {
- "name" : "edit",
- "type" : "function",
- "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo, record)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record|false",
- "desc" : "The data record returned from the underlying store (or false on nothing selected)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Fires when the dropdown list is expanded",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "focus",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when a list item is selected",
- "sig" : "function (combo, record, index)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The data record returned from the underlying store (or false on clear)",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the selected item in the dropdown list",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
}
]
},
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "clearValue",
- "type" : "function",
- "desc" : "Clears any text/value currently set in the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "doQuery",
- "type" : "function",
- "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
- "sig" : "(query, forceAll)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "query",
- "type" : "String",
- "desc" : "The SQL query to execute",
- "isOptional" : false
- },
- {
- "name" : "forceAll",
- "type" : "Boolean",
- "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
}
]
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "fireEvent",
"type" : "function",
{
"name" : "getValue",
"type" : "function",
- "desc" : "Returns the currently selected field value or empty string if no value is set.",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "value The selected value"
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
]
},
"params" : [],
"returns" : []
},
- {
- "name" : "isExpanded",
- "type" : "function",
- "desc" : "Returns true if the dropdown list is expanded, else false.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "isValid",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "onTriggerClick",
- "type" : "function",
- "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.form.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "purgeListeners",
"type" : "function",
{
"name" : "reset",
"type" : "function",
- "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(index, scrollIntoView)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The zero-based index of the list item to select",
- "isOptional" : false
- },
- {
- "name" : "scrollIntoView",
- "type" : "Boolean",
- "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "selectByValue",
- "type" : "function",
- "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(value, scrollIntoView)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "String",
- "desc" : "The data value of the item to select",
- "isOptional" : false
- },
- {
- "name" : "scrollIntoView",
- "type" : "Boolean",
- "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value matched an item in the list, else false"
- }
- ]
- },
- {
- "name" : "selectText",
- "type" : "function",
- "desc" : "Selects text in this field",
- "sig" : "(start, end)",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "start",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should start (defaults to 0)",
- "isOptional" : false
- },
- {
- "name" : "end",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should end (defaults to the text length)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setEditable",
- "type" : "function",
- "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Boolean",
- "desc" : "True to allow the user to directly edit the field text",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setFromData",
- "type" : "function",
- "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Object",
- "desc" : "the value to set as. or false on reset?",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setPagePosition",
"type" : "function",
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
- "sig" : "(value)",
+ "desc" : "Sets the checked state of the checkbox.",
+ "sig" : "(checked)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "String",
- "desc" : "The value to match",
+ "name" : "checked",
+ "type" : "Boolean/String",
+ "desc" : "True, 'true', '1', or 'on' to check the checkbox, any other value will uncheck it.",
"isOptional" : false
}
],
"desc" : "True if the value is valid, else false"
}
]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.form.ComboCheck",
- "Roo.form.ComboNested"
- ],
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.ComboBoxArray" : {
+ "Roo.form.FCKeditor" : {
"props" : [
{
"name" : "actionMode",
{
"name" : "autoCreate",
"type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
- "memberOf" : "Roo.form.Field",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"textarea\", style: \"width:300px;height:60px;\", autocomplete: \"off\"})",
+ "memberOf" : "Roo.form.TextArea",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "The combo box that is wrapped",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "disableClass",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "fck",
+ "type" : "Object",
+ "desc" : "BasePath",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "fieldClass",
"type" : "String",
{
"name" : "growMax",
"type" : "Number",
- "desc" : "The maximum width to allow when grow = true (defaults to 800)",
- "memberOf" : "Roo.form.TextField",
+ "desc" : "The maximum height to allow when grow = true (defaults to 1000)",
+ "memberOf" : "Roo.form.TextArea",
"isOptional" : false,
"optvals" : []
},
{
"name" : "growMin",
"type" : "Number",
- "desc" : "The minimum width to allow when grow = true (defaults to 30)",
- "memberOf" : "Roo.form.TextField",
+ "desc" : "The minimum height to allow when grow = true (defaults to 60)",
+ "memberOf" : "Roo.form.TextArea",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "hiddenName",
- "type" : "String",
- "desc" : "The hidden name of the field, often contains an comma seperated list of names",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "hideMode",
"type" : "String",
{
"name" : "name",
"type" : "String",
- "desc" : "The name of the visable items on this form (eg. titles not ids)",
- "memberOf" : "",
+ "desc" : "The field's HTML name attribute.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "preventScrollbars",
+ "type" : "Boolean",
+ "desc" : "True to prevent scrollbars from appearing regardless of how much text is\nin the field (equivalent to setting overflow: hidden, defaults to false)",
+ "memberOf" : "Roo.form.TextArea",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "seperator",
- "type" : "String",
- "desc" : "The value seperator normally ','",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "style",
"type" : "String",
{
"name" : "width",
"type" : "Number",
- "desc" : "The width of the box that displays the selected element",
- "memberOf" : "",
+ "desc" : "width (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
"isOptional" : false,
"optvals" : []
}
],
"returns" : []
},
- {
- "name" : "beforeremove",
- "type" : "function",
- "desc" : "Fires before remove the value from the list",
- "sig" : "function (_self, item)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "_self",
- "type" : "Roo.form.ComboBoxArray",
- "desc" : "This combo box array",
- "isOptional" : false
- },
- {
- "name" : "item",
- "type" : "Roo.form.ComboBoxArray.Item",
- "desc" : "removed item",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforerender",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "editorinit",
+ "type" : "function",
+ "desc" : "Fired when the editor is initialized - you can add extra handlers here..",
+ "sig" : "function (_self, the)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "FCKeditor",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "the",
+ "type" : "Object",
+ "desc" : "FCK object.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "enable",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "remove",
- "type" : "function",
- "desc" : "Fires when remove the value from the list",
- "sig" : "function (_self, item)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "_self",
- "type" : "Roo.form.ComboBoxArray",
- "desc" : "This combo box array",
- "isOptional" : false
- },
- {
- "name" : "item",
- "type" : "Roo.form.ComboBoxArray.Item",
- "desc" : "removed item",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
{
"name" : "autoSize",
"type" : "function",
- "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.",
+ "desc" : "Automatically grows the field to accomodate the height of the text up to the maximum field height allowed.\nThis only takes effect if grow = true, and fires the autosize event if the height changes.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "Roo.form.TextArea",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
"sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "validate",
"type" : "function",
- "desc" : "Validates the combox array value",
+ "desc" : "Validates the field value",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.ComboBoxArray.Item" : {
+ "Roo.form.Field" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "autoCreate",
+ "type" : "String/Object",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "A CSS class to apply to the field's underlying element.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "disableClass",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "True to disable the field (defaults to false).",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldClass",
+ "type" : "String",
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "String",
+ "desc" : "Label to use when rendering a form.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "height",
"type" : "Number",
"visibility"
]
},
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "msgFx",
+ "type" : "String",
+ "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "msgTarget",
+ "type" : "String",
+ "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The field's HTML name attribute.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "qtip",
+ "type" : "String",
+ "desc" : "Mouse over tip",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "style",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "tabIndex",
+ "type" : "Number",
+ "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "A value to initialize this field with.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "width",
"type" : "Number",
],
"returns" : []
},
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "move",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
],
"returns" : []
},
+ {
+ "name" : "applyTo",
+ "type" : "function",
+ "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
+ "sig" : "(el)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id of the node, a DOM node or an existing Element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.form.Field",
+ "desc" : "this"
+ }
+ ]
+ },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name attribute of the field if available",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "name The field name"
+ }
+ ]
+ },
{
"name" : "getPosition",
"type" : "function",
}
]
},
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
{
"name" : "getSize",
"type" : "function",
}
]
},
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "hasChanged",
+ "type" : "function",
+ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "hasListener",
"type" : "function",
}
]
},
+ {
+ "name" : "isDirty",
+ "type" : "function",
+ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isValid",
+ "type" : "function",
+ "desc" : "Returns whether or not the field value is currently valid",
+ "sig" : "(preventMark)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "True to disable marking the field invalid",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "resetHasChanged",
+ "type" : "function",
+ "desc" : "stores the current value in loadedValue",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setSize",
"type" : "function",
}
]
},
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisible",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
+ "implementations" : [
+ "Roo.form.Checkbox",
+ "Roo.form.ComboBox",
+ "Roo.form.ComboBoxArray",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.FCKeditor",
+ "Roo.form.GridField",
+ "Roo.form.Hidden",
+ "Roo.form.HtmlEditor",
+ "Roo.form.MonthField",
+ "Roo.form.NumberField",
+ "Roo.form.Radio",
+ "Roo.form.Select",
+ "Roo.form.Signature",
+ "Roo.form.TextArea",
+ "Roo.form.TextField",
+ "Roo.form.TriggerField"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.ComboCheck" : {
+ "Roo.form.FieldSet" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "allQuery",
- "type" : "String",
- "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "allowLeadingSpace",
- "type" : "Boolean",
- "desc" : "True to prevent the stripping of leading white space",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "alwaysQuery",
- "type" : "Boolean",
- "desc" : "Disable caching of results, and always send query",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "autoCreate",
- "type" : "Boolean/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.form.TextField",
+ "type" : "String/Object",
+ "desc" : "A DomHelper element spec used to autocreate the fieldset (defaults to {tag: 'fieldset', cn: {tag:'legend'}})",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "blockFocus",
+ "name" : "clear",
"type" : "Boolean",
- "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field",
+ "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
+ "memberOf" : "Roo.form.Layout",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "disableClear",
- "type" : "Boolean",
- "desc" : "Disable showing of clear button.",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "displayField",
- "type" : "String",
- "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "editable",
- "type" : "Boolean",
- "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "emptyText",
- "type" : "String",
- "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fieldClass",
- "type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fieldLabel",
- "type" : "String",
- "desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "forceSelection",
- "type" : "Boolean",
- "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "grow",
+ "name" : "hideLabels",
"type" : "Boolean",
- "desc" : "",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "growMax",
- "type" : "Number",
- "desc" : "",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "growMin",
- "type" : "Number",
- "desc" : "",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "handleHeight",
- "type" : "Number",
- "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hiddenName",
- "type" : "String",
- "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
- "memberOf" : "Roo.form.ComboBox",
+ "desc" : "True to suppress the display of field labels in this layout (defaults to false)",
+ "memberOf" : "Roo.form.Layout",
"isOptional" : false,
"optvals" : []
},
]
},
{
- "name" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "Roo.form.TriggerField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "inputType",
- "type" : "String",
- "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "invalidText",
+ "name" : "labelAlign",
"type" : "String",
- "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : "Roo.form.Field",
+ "desc" : "t)\nValid values are \"left,\" \"top\" and \"right\" (defaults to \"left",
+ "memberOf" : "Roo.form.Layout",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "left",
+ "top",
+ "right"
+ ]
},
{
"name" : "labelSeparator",
"type" : "String",
- "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "lazyRender",
- "type" : "Boolean",
- "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
- "memberOf" : "Roo.form.ComboBox",
+ "desc" : "The separator to use after field labels (defaults to ':')",
+ "memberOf" : "Roo.form.Layout",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "listAlign",
- "type" : "String",
- "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
- "memberOf" : "Roo.form.ComboBox",
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
+ "memberOf" : "Roo.form.Layout",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "listClass",
+ "name" : "legend",
"type" : "String",
- "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listWidth",
- "type" : "Number",
- "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
- "memberOf" : "Roo.form.ComboBox",
+ "desc" : "The text to display as the legend for the FieldSet (defaults to '')",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "loadingText",
- "type" : "String",
- "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxHeight",
- "type" : "Number",
- "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minChars",
- "type" : "Number",
- "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minListWidth",
- "type" : "Number",
- "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "mode",
- "type" : "String",
- "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "msgFx",
- "type" : "String",
- "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "msgTarget",
- "type" : "String",
- "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "name",
- "type" : "String",
- "desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "pageSize",
- "type" : "Number",
- "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "qtip",
- "type" : "String",
- "desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "queryDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "queryParam",
- "type" : "String",
- "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "resizable",
- "type" : "Boolean",
- "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "selectedClass",
- "type" : "String",
- "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "shadow",
- "type" : "Boolean/String",
- "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to which this combo is bound (defaults to undefined)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "style",
- "type" : "String",
- "desc" : "css styles to add to component\neg. text-align:right;",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "tabIndex",
- "type" : "Number",
- "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "title",
- "type" : "String",
- "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "tpl",
- "type" : "String/Roo.Template",
- "desc" : "The template to use to render the output",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "transform",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "triggerAction",
- "type" : "String",
- "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "triggerClass",
- "type" : "String",
- "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "typeAhead",
- "type" : "Boolean",
- "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "typeAheadDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "valueField",
- "type" : "String",
- "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "valueNotFoundText",
- "type" : "String",
- "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent",
+ "type" : "String/Object/Function",
+ "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
+ "memberOf" : "Roo.form.Layout",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
{
- "name" : "add",
+ "name" : "beforedestroy",
+ "type" : "function",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "autosize",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
- "sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : "Roo.form.TextField",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "This text field",
- "isOptional" : false
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The new field width",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforedestroy",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "beforehide",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "desc" : "Fires after the component is destroyed.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "beforequery",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
- "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "query",
- "type" : "String",
- "desc" : "The query",
- "isOptional" : false
- },
- {
- "name" : "forceAll",
- "type" : "Boolean",
- "desc" : "true to force \"all\" query",
- "isOptional" : false
- },
- {
- "name" : "cancel",
- "type" : "Boolean",
- "desc" : "true to cancel the query",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Object",
- "desc" : "The query event object",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "desc" : "Fires after the component is enabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "beforeselect",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
- "sig" : "function (combo, record, index)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The data record returned from the underlying store",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the selected item in the dropdown list",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "desc" : "Fires after the component is rendered.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "blur",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires when this field loses input focus.",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "change",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "collapse",
+ "name" : "addxtype",
"type" : "function",
- "desc" : "Fires when the dropdown list is collapsed",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox",
+ "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column",
+ "sig" : "(config)",
+ "static" : false,
+ "memberOf" : "Roo.form.Layout",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "capture",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "disable",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "this",
+ "name" : "",
"type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "edit",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo, record)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "fireEvent",
+ "type" : "function",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "record",
- "type" : "Roo.data.Record|false",
- "desc" : "The data record returned from the underlying store (or false on nothing selected)",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "enable",
+ "name" : "focus",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
"memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "expand",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Fires when the dropdown list is expanded",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "focus",
+ "name" : "getId",
"type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "hasListener",
+ "type" : "function",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
"name" : "hide",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Hide this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "this",
+ "name" : "",
"type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "desc" : "this"
}
- ],
+ ]
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "invalid",
+ "name" : "on",
"type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "keyup",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "move",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Fires after the component is moved.",
- "sig" : "function (_self, x, y)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
{
"name" : "render",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
+ "static" : false,
"memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resize",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Fires after the component is resized.",
- "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "disabled",
+ "type" : "Boolean",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [
+ "Roo.form.Column",
+ "Roo.form.Row",
+ "Roo.form.Field",
+ "Roo.form.Checkbox",
+ "Roo.form.ComboBox",
+ "Roo.form.ComboBoxArray",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.FCKeditor",
+ "Roo.form.GridField",
+ "Roo.form.Hidden",
+ "Roo.form.HtmlEditor",
+ "Roo.form.MonthField",
+ "Roo.form.NumberField",
+ "Roo.form.Radio",
+ "Roo.form.Select",
+ "Roo.form.Signature",
+ "Roo.form.TextArea",
+ "Roo.form.TextField",
+ "Roo.form.TriggerField",
+ "Roo.Button",
+ "Roo.SplitButton",
+ "Roo.Toolbar.Button",
+ "Roo.Toolbar.SplitButton",
+ "Roo.form.TextItem"
+ ],
+ "tree_parent" : []
+ },
+ "Roo.form.Form" : {
+ "props" : [
+ {
+ "name" : "baseParams",
+ "type" : "Object",
+ "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
+ "memberOf" : "Roo.form.BasicForm",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "select",
+ "name" : "buttonAlign",
+ "type" : "String",
+ "desc" : "t) Valid values are \"left,\" \"center\" and \"right\" (defaults to \"center",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ {
+ "name" : "buttons[]",
+ "type" : "Roo.Button",
+ "desc" : "buttons at bottom of form",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "errorMask",
+ "type" : "Boolean",
+ "desc" : "Should the form be masked (and the active element highlighted on error - default false",
+ "memberOf" : "Roo.form.BasicForm",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "errorReader",
+ "type" : "DataReader",
+ "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when reading validation errors on \"submit\" actions.\nThis is completely optional as there is built-in support for processing JSON.",
+ "memberOf" : "Roo.form.BasicForm",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fileUpload",
+ "type" : "Boolean",
+ "desc" : "Set to true if this form is a file upload.",
+ "memberOf" : "Roo.form.BasicForm",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "formData",
+ "type" : "boolean|FormData",
+ "desc" : "- true to use new 'FormData' post, or set to a new FormData({dom form}) Object, if\nsending a formdata with extra parameters - eg uploaded elements.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "itemCls",
+ "type" : "String",
+ "desc" : "A css class to apply to the x-form-item of fields. This property cascades to child containers.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "t) Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\").\nThis property cascades to child containers if not se",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "top",
+ "right"
+ ]
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "The width of labels. This property cascades to child containers.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maskOffset",
+ "type" : "Number",
+ "desc" : "space around form element to mask if there is an error Default 100",
+ "memberOf" : "Roo.form.BasicForm",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "method",
+ "type" : "String",
+ "desc" : "The request method to use (GET or POST) for form actions if one isn't supplied in the action options.",
+ "memberOf" : "Roo.form.BasicForm",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minButtonWidth",
+ "type" : "Number",
+ "desc" : "Minimum width of all buttons in pixels (defaults to 75)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "monitorPoll",
+ "type" : "Number",
+ "desc" : "The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "monitorValid",
+ "type" : "Boolean",
+ "desc" : "If true the form monitors its valid state <b>client-side</b> and\nfires a looping event with that state. This is required to bind buttons to the valid\nstate using the config value formBind:true on the button.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "progressUrl",
+ "type" : "String",
+ "desc" : "- Url to return progress data",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "reader",
+ "type" : "DataReader",
+ "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when executing \"load\" actions.\nThis is optional as there is built-in support for processing JSON.",
+ "memberOf" : "Roo.form.BasicForm",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "timeout",
+ "type" : "Number",
+ "desc" : "Timeout for form actions in seconds (default is 30 seconds).",
+ "memberOf" : "Roo.form.BasicForm",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "trackResetOnLoad",
+ "type" : "Boolean",
+ "desc" : "If set to true, form.reset() resets to the last loaded\nor setValues() data instead of when the form was first created.",
+ "memberOf" : "Roo.form.BasicForm",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "url",
+ "type" : "String",
+ "desc" : "The URL to use for form actions if one isn't supplied in the action options.",
+ "memberOf" : "Roo.form.BasicForm",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "actioncomplete",
"type" : "function",
- "desc" : "Fires when a list item is selected",
- "sig" : "function (combo, record, index)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox",
+ "desc" : "Fires when an action is completed.",
+ "sig" : "function (_self, action)\n{\n\n}",
+ "memberOf" : "Roo.form.BasicForm",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
+ "name" : "this",
+ "type" : "Form",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The data record returned from the underlying store (or false on clear)",
+ "name" : "action",
+ "type" : "Action",
+ "desc" : "The action that completed",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "actionfailed",
+ "type" : "function",
+ "desc" : "Fires when an action fails.",
+ "sig" : "function (_self, action)\n{\n\n}",
+ "memberOf" : "Roo.form.BasicForm",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Form",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the selected item in the dropdown list",
+ "name" : "action",
+ "type" : "Action",
+ "desc" : "The action that failed",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "beforeaction",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires before any action is performed. Return false to cancel the action.",
+ "sig" : "function (_self, action)\n{\n\n}",
+ "memberOf" : "Roo.form.BasicForm",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Form",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "action",
+ "type" : "Action",
+ "desc" : "The action to be performed",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "specialkey",
+ "name" : "clientvalidation",
"type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "If the monitorValid config option is true, this event fires repetitively to notify of valid state",
+ "sig" : "function (_self, valid)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Form",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
+ "name" : "valid",
+ "type" : "Boolean",
+ "desc" : "true if the form has passed client-side validation",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "valid",
+ "name" : "rendered",
"type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Fires when the form is rendered",
+ "sig" : "function (form)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
+ "name" : "form",
+ "type" : "Roo.form.Form",
"desc" : "",
"isOptional" : false
}
],
"methods" : [
{
- "name" : "addEvents",
+ "name" : "add",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Add Roo.form components to the current open container (e.g. column, fieldset, etc.). Fields added via this method\ncan also be passed with an additional property of fieldLabel, which if supplied, will provide the text to display\nas the label of the field.",
+ "sig" : "(field1, field2)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "field1",
+ "type" : "Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "field2",
+ "type" : "Field",
+ "desc" : "(optional)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Form",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "addListener",
+ "name" : "addButton",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Adds a button to the footer of the form - this <b>must</b> be called before the form is rendered.",
+ "sig" : "(config, handler, scope)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "config",
+ "type" : "String/Object",
+ "desc" : "A string becomes the button text, an object can either be a Button config\nobject or a valid Roo.DomHelper element config",
"isOptional" : false
},
{
"name" : "handler",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The function called when the button is clicked",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "desc" : "(optional) The scope of the handler function",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Button",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "applyTo",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
- "sig" : "(el)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id of the node, a DOM node or an existing Element",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.form.Field",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "autoSize",
+ "name" : "addForm",
"type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
+ "desc" : "Add a secondary form to this one, \nUsed to provide tabbed forms. One form is primary, with hidden values \nwhich mirror the elements from the other forms.",
+ "sig" : "(form)",
"static" : false,
- "memberOf" : "Roo.form.TriggerField",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "form",
+ "type" : "Roo.form.Form",
+ "desc" : "to add.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
"memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "fn",
+ "name" : "handler",
"type" : "Function",
- "desc" : "The function to call",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "clearValue",
- "type" : "function",
- "desc" : "Clears any text/value currently set in the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "collapse",
+ "name" : "addxtype",
"type" : "function",
- "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Adds a series of form elements (using the xtype property as the factory method.\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column, (and 'end' to close a block)",
+ "sig" : "(config)",
"static" : false,
- "memberOf" : "Roo.form.ComboBox",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "applyIfToFields",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Calls {@link Ext#applyIf} for all field in this form with the passed object.",
+ "sig" : "(values)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "disable",
+ "name" : "applyToFields",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Calls {@link Ext#apply} for all fields in this form with the passed object.",
+ "sig" : "(values)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
+ "type" : "BasicForm",
"desc" : "this"
}
]
},
{
- "name" : "doQuery",
+ "name" : "capture",
"type" : "function",
- "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
- "sig" : "(query, forceAll)",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "query",
- "type" : "String",
- "desc" : "The SQL query to execute",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "forceAll",
- "type" : "Boolean",
- "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enable",
+ "name" : "clearInvalid",
"type" : "function",
- "desc" : "Enable this component.",
+ "desc" : "Clears all invalid messages in this form.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
+ "type" : "BasicForm",
"desc" : "this"
}
]
},
{
- "name" : "expand",
- "type" : "function",
- "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "fireEvent",
+ "name" : "column",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Opens a new {@link Roo.form.Column} container in the layout stack. If fields are passed after the config, the\nfields are added and the column is closed. If no fields are passed the column remains open\nuntil end() is called.",
+ "sig" : "(config, field1, field2, etc)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config to pass to the column",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "field1",
+ "type" : "Field",
+ "desc" : "(optional)",
+ "isOptional" : false
+ },
+ {
+ "name" : "field2",
+ "type" : "Field",
+ "desc" : "(optional)",
+ "isOptional" : false
+ },
+ {
+ "name" : "etc",
+ "type" : "Field",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "",
+ "desc" : "Column The column container object"
}
]
},
{
- "name" : "focus",
+ "name" : "container",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Opens a new {@link Roo.form.Layout} container in the layout stack. If fields are passed after the config, the\nfields are added and the container is closed. If no fields are passed the container remains open\nuntil end() is called.",
+ "sig" : "(config, field1, field2, etc)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config to pass to the Layout",
+ "isOptional" : false
+ },
+ {
+ "name" : "field1",
+ "type" : "Field",
+ "desc" : "(optional)",
+ "isOptional" : false
+ },
+ {
+ "name" : "field2",
+ "type" : "Field",
+ "desc" : "(optional)",
+ "isOptional" : false
+ },
+ {
+ "name" : "etc",
+ "type" : "Field",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "",
+ "desc" : "Layout The container object"
}
]
},
{
- "name" : "getBox",
+ "name" : "doAction",
"type" : "function",
- "desc" : "Gets the current box measurements of the component's underlying element.",
- "sig" : "(local)",
+ "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.",
+ "sig" : "(actionName, options)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "name" : "actionName",
+ "type" : "String",
+ "desc" : "The name of the action type",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) The options to pass to the action. All of the config options listed\nbelow are supported by both the submit and load actions unless otherwise noted (custom actions could also\naccept other config options):\n<pre>\nProperty Type Description\n---------------- --------------- ----------------------------------------------------------------------------------\nurl String The url for the action (defaults to the form's url)\nmethod String The form method to use (defaults to the form's method, or POST if not defined)\nparams String/Object The params to pass (defaults to the form's baseParams, or none if not defined)\nclientValidation Boolean Applies to submit only. Pass true to call form.isValid() prior to posting to\n validate the form on the client (defaults to false)\n</pre>",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "getEl",
+ "name" : "end",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Closes the current open container",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "Form",
+ "desc" : "this"
}
]
},
{
- "name" : "getId",
+ "name" : "fieldset",
"type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Opens a new {@link Roo.form.FieldSet} container in the layout stack. If fields are passed after the config, the\nfields are added and the fieldset is closed. If no fields are passed the fieldset remains open\nuntil end() is called.",
+ "sig" : "(config, field1, field2, etc)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config to pass to the fieldset",
+ "isOptional" : false
+ },
+ {
+ "name" : "field1",
+ "type" : "Field",
+ "desc" : "(optional)",
+ "isOptional" : false
+ },
+ {
+ "name" : "field2",
+ "type" : "Field",
+ "desc" : "(optional)",
+ "isOptional" : false
+ },
+ {
+ "name" : "etc",
+ "type" : "Field",
+ "desc" : "(optional)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "",
+ "desc" : "FieldSet The fieldset container object"
}
]
},
{
- "name" : "getName",
+ "name" : "findField",
"type" : "function",
- "desc" : "Returns the name attribute of the field if available",
- "sig" : "()\n{\n\n}",
+ "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The value to search for",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "name The field name"
+ "type" : "",
+ "desc" : "Field"
}
]
},
{
- "name" : "getPosition",
+ "name" : "findbyId",
"type" : "function",
- "desc" : "Gets the current XY position of the component's underlying element.",
- "sig" : "(local)",
+ "desc" : "Find any element that has been added to a form, using it's ID or name\nThis can include framesets, columns etc. along with regular fields..",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "- id or name to find.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Array",
- "desc" : "The XY position of the element (e.g., [100, 200])"
+ "type" : "Element",
+ "desc" : "e - or false if nothing found."
}
]
},
{
- "name" : "getRawValue",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "getSize",
+ "name" : "getFieldValues",
"type" : "function",
- "desc" : "Gets the current size of the component's underlying element.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the fields in this form as an object with key/value pairs. \nThis differs from getValues as it calls getValue on each child item, rather than using dom data.\nNormally this will not return readOnly data",
+ "sig" : "(with_readonly)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "with_readonly",
+ "type" : "Boolean",
+ "desc" : "return readonly field data.",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
"type" : "Object",
- "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
+ "desc" : ""
}
]
},
{
- "name" : "getValue",
+ "name" : "getValues",
"type" : "function",
- "desc" : "Returns the currently selected field value or empty string if no value is set.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.",
+ "sig" : "(asString)",
"static" : false,
- "memberOf" : "Roo.form.ComboBox",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "asString",
+ "type" : "Boolean",
+ "desc" : "(def)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "value The selected value"
+ "type" : "Object",
+ "desc" : ""
}
]
},
{
"name" : "hasChanged",
"type" : "function",
- "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
+ "desc" : "Returns true if any fields in this form have changed since their original load. (New version)",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "",
+ "desc" : "Boolean"
+ }
+ ]
},
{
"name" : "hasListener",
]
},
{
- "name" : "hide",
+ "name" : "invalidFields",
"type" : "function",
- "desc" : "Hide this component.",
+ "desc" : "Returns array of invalid form fields.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "",
+ "desc" : "Array"
}
]
},
{
"name" : "isDirty",
"type" : "function",
- "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isExpanded",
- "type" : "function",
- "desc" : "Returns true if the dropdown list is expanded, else false.",
+ "desc" : "DEPRICATED Returns true if any fields in this form have changed since their original load.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.ComboBox",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
- },
- {
- "name" : "isValid",
- "type" : "function",
- "desc" : "Returns whether or not the field value is currently valid",
- "sig" : "(preventMark)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "True to disable marking the field invalid",
- "isOptional" : false
- }
- ],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "type" : "",
+ "desc" : "Boolean"
}
]
},
{
- "name" : "isVisible",
+ "name" : "isValid",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
+ "desc" : "Returns true if client-side validation on the form is successful.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
- },
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ "returns" : [
{
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
+ "name" : "",
+ "type" : "",
+ "desc" : "Boolean"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "on",
+ "name" : "load",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Shortcut to do a load action.",
+ "sig" : "(options)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
{
"name" : "options",
"type" : "Object",
- "desc" : "(optional)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "onPosition",
- "type" : "function",
- "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
- "sig" : "(x, y)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "onResize",
- "type" : "function",
- "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
- "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
- "isOptional" : false
- },
- {
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
- "isOptional" : false
- },
- {
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "onTriggerClick",
- "type" : "function",
- "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.form.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "desc" : "The options to pass to the action (see {@link #doAction} for details)",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "removeListener",
- "type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
+ "returns" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "render",
+ "name" : "loadRecord",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Loads an Roo.data.Record into this form.",
+ "sig" : "(record)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "record",
+ "type" : "Record",
+ "desc" : "The record to load",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "resetHasChanged",
- "type" : "function",
- "desc" : "stores the current value in loadedValue",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(index, scrollIntoView)",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The zero-based index of the list item to select",
- "isOptional" : false
- },
+ "returns" : [
{
- "name" : "scrollIntoView",
- "type" : "Boolean",
- "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
- "isOptional" : false
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "selectByValue",
+ "name" : "markInvalid",
"type" : "function",
- "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(value, scrollIntoView)",
+ "desc" : "Mark fields in this form invalid in bulk.",
+ "sig" : "(errors)",
"static" : false,
- "memberOf" : "Roo.form.ComboBox",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "String",
- "desc" : "The data value of the item to select",
- "isOptional" : false
- },
- {
- "name" : "scrollIntoView",
- "type" : "Boolean",
- "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
+ "name" : "errors",
+ "type" : "Array/Object",
+ "desc" : "Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the value matched an item in the list, else false"
+ "type" : "BasicForm",
+ "desc" : "this"
}
]
},
{
- "name" : "selectText",
- "type" : "function",
- "desc" : "Selects text in this field",
- "sig" : "(start, end)",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "start",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should start (defaults to 0)",
- "isOptional" : false
- },
- {
- "name" : "end",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should end (defaults to the text length)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setDisabled",
+ "name" : "on",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setEditable",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
- "sig" : "(value)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.ComboBox",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Boolean",
- "desc" : "True to allow the user to directly edit the field text",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setFromData",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Object",
- "desc" : "the value to set as. or false on reset?",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setPagePosition",
+ "name" : "remove",
"type" : "function",
- "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
- "sig" : "(x, y)",
+ "desc" : "Removes a field from the items collection (does NOT remove its markup).",
+ "sig" : "(field)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
+ "name" : "field",
+ "type" : "Field",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "setPosition",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
- "sig" : "(left, top)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "left",
- "type" : "Number",
- "desc" : "The new left",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "top",
- "type" : "Number",
- "desc" : "The new top",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setRawValue",
+ "name" : "render",
"type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
+ "desc" : "Render this form into the passed container. This should only be called once!",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The element this component should be rendered into",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Form",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "setSize",
+ "name" : "reset",
"type" : "function",
- "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
- "sig" : "(width, height)",
+ "desc" : "Resets this form.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "width",
- "type" : "Number/Object",
- "desc" : "The new width to set, or a size object in the format {width, height}",
- "isOptional" : false
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "The new height to set (not required if a size object is passed as the first arg)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.BoxComponent",
+ "type" : "BasicForm",
"desc" : "this"
}
]
},
{
- "name" : "setValue",
+ "name" : "resetHasChanged",
"type" : "function",
- "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
- "sig" : "(value)",
+ "desc" : "Resets all hasChanged to 'false' -\nThe old 'isDirty' used 'original value..' however this breaks reset() and a few other things.\nSo hasChanged storage is only to be used for this purpose",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.ComboBox",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "value",
- "type" : "String",
- "desc" : "The value to match",
- "isOptional" : false
+ "name" : "",
+ "type" : "",
+ "desc" : "Boolean"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setVisible",
+ "name" : "setValues",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Set values for fields in this form in bulk.",
+ "sig" : "(values)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "values",
+ "type" : "Array/Object",
+ "desc" : "Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
+ "type" : "BasicForm",
"desc" : "this"
}
]
},
{
- "name" : "show",
+ "name" : "start",
"type" : "function",
- "desc" : "Show this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Opens the passed container in the layout stack. The container can be any {@link Roo.form.Layout} or subclass.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "Object",
+ "desc" : "A Roo.form.Layout or subclass of Layout",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
+ "type" : "Form",
"desc" : "this"
}
]
},
{
- "name" : "syncSize",
+ "name" : "startMonitoring",
"type" : "function",
- "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
+ "desc" : "Starts monitoring of the valid state of this form. Usually this is done by passing the config\noption \"monitorValid\"",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "un",
+ "name" : "stopMonitoring",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Stops monitoring of the valid state of this form",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "updateBox",
+ "name" : "submit",
"type" : "function",
- "desc" : "Sets the current box measurements of the component's underlying element.",
- "sig" : "(box)",
+ "desc" : "Shortcut to do a submit action.",
+ "sig" : "(options)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "box",
+ "name" : "options",
"type" : "Object",
- "desc" : "An object in the format {x, y, width, height}",
+ "desc" : "The options to pass to the action (see {@link #doAction} for details)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "validate",
+ "name" : "un",
"type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "validateValue",
+ "name" : "updateRecord",
"type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
+ "desc" : "Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.",
+ "sig" : "(record)",
"static" : false,
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
+ "name" : "record",
+ "type" : "Record",
+ "desc" : "The record to edit",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "type" : "BasicForm",
+ "desc" : "this"
}
]
}
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [],
+ "tree_children" : [
+ "Roo.form.Column",
+ "Roo.form.FieldSet",
+ "Roo.form.Row",
+ "Roo.form.Field",
+ "Roo.form.Checkbox",
+ "Roo.form.ComboBox",
+ "Roo.form.ComboBoxArray",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.FCKeditor",
+ "Roo.form.GridField",
+ "Roo.form.Hidden",
+ "Roo.form.HtmlEditor",
+ "Roo.form.MonthField",
+ "Roo.form.NumberField",
+ "Roo.form.Radio",
+ "Roo.form.Select",
+ "Roo.form.Signature",
+ "Roo.form.TextArea",
+ "Roo.form.TextField",
+ "Roo.form.TriggerField",
+ "Roo.Button",
+ "Roo.SplitButton",
+ "Roo.Toolbar.Button",
+ "Roo.Toolbar.SplitButton",
+ "Roo.form.TextItem"
+ ],
"tree_parent" : []
},
- "Roo.form.ComboNested" : {
+ "Roo.form.GridField" : {
"props" : [
{
"name" : "actionMode",
"optvals" : []
},
{
- "name" : "allQuery",
+ "name" : "addTitle",
"type" : "String",
- "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.form.TextField",
+ "desc" : "Text to include for adding a title.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "allowLeadingSpace",
- "type" : "Boolean",
- "desc" : "True to prevent the stripping of leading white space",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "alwaysQuery",
- "type" : "Boolean",
- "desc" : "Disable caching of results, and always send query",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "autoCreate",
- "type" : "Boolean/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "blockFocus",
- "type" : "Boolean",
- "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
- "memberOf" : "Roo.form.ComboBox",
+ "type" : "String/Object",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "disableClear",
- "type" : "Boolean",
- "desc" : "Disable showing of clear button.",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "disabled",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "displayField",
- "type" : "String",
- "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "editable",
- "type" : "Boolean",
- "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "emptyText",
- "type" : "String",
- "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "fieldClass",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "forceSelection",
- "type" : "Boolean",
- "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "grow",
- "type" : "Boolean",
- "desc" : "",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "growMax",
- "type" : "Number",
- "desc" : "",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "growMin",
- "type" : "Number",
- "desc" : "",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "handleHeight",
- "type" : "Number",
- "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "height",
"type" : "Number",
- "desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hiddenName",
- "type" : "String",
- "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
- "memberOf" : "Roo.form.ComboBox",
+ "desc" : "- used to restrict height of grid..",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"visibility"
]
},
- {
- "name" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "Roo.form.TriggerField",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "inputType",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "lazyRender",
- "type" : "Boolean",
- "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listAlign",
- "type" : "String",
- "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listClass",
- "type" : "String",
- "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listWidth",
- "type" : "Number",
- "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "loadingText",
- "type" : "String",
- "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxHeight",
- "type" : "Number",
- "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minChars",
- "type" : "Number",
- "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minListWidth",
- "type" : "Number",
- "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "mode",
- "type" : "String",
- "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "msgFx",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "pageSize",
- "type" : "Number",
- "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "qtip",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "queryDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "queryParam",
- "type" : "String",
- "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "readOnly",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "resizable",
- "type" : "Boolean",
- "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "selectedClass",
- "type" : "String",
- "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "shadow",
- "type" : "Boolean/String",
- "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to which this combo is bound (defaults to undefined)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "style",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "title",
- "type" : "String",
- "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "tpl",
- "type" : "String/Roo.Template",
- "desc" : "The template to use to render the output",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "transform",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "triggerAction",
- "type" : "String",
- "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "triggerClass",
- "type" : "String",
- "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "typeAhead",
- "type" : "Boolean",
- "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "typeAheadDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "validateOnBlur",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "value",
"type" : "Mixed",
"optvals" : []
},
{
- "name" : "valueField",
- "type" : "String",
- "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "valueNotFoundText",
- "type" : "String",
- "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
- "memberOf" : "Roo.form.ComboBox",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.form.TextField",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "- used to restrict width of grid..",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent",
+ "name" : "xgrid",
+ "type" : "Object",
+ "desc" : "(xtype'd description of grid) { xtype : 'Grid', dataSource: .... }\n\n}",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
- {
- "name" : "add",
- "type" : "function",
- "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "autosize",
- "type" : "function",
- "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
- "sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : "Roo.form.TextField",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "This text field",
- "isOptional" : false
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The new field width",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "beforequery",
- "type" : "function",
- "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
- "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "query",
- "type" : "String",
- "desc" : "The query",
- "isOptional" : false
- },
- {
- "name" : "forceAll",
- "type" : "Boolean",
- "desc" : "true to force \"all\" query",
- "isOptional" : false
- },
- {
- "name" : "cancel",
- "type" : "Boolean",
- "desc" : "true to cancel the query",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Object",
- "desc" : "The query event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforerender",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "beforeselect",
- "type" : "function",
- "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
- "sig" : "function (combo, record, index)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The data record returned from the underlying store",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the selected item in the dropdown list",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforeshow",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Fires when the dropdown list is collapsed",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "edit",
- "type" : "function",
- "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo, record)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record|false",
- "desc" : "The data record returned from the underlying store (or false on nothing selected)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Fires when the dropdown list is expanded",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "focus",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when a list item is selected",
- "sig" : "function (combo, record, index)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The data record returned from the underlying store (or false on clear)",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the selected item in the dropdown list",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
}
]
},
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "clearValue",
- "type" : "function",
- "desc" : "Clears any text/value currently set in the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "doQuery",
- "type" : "function",
- "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
- "sig" : "(query, forceAll)",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "query",
- "type" : "String",
- "desc" : "The SQL query to execute",
- "isOptional" : false
- },
- {
- "name" : "forceAll",
- "type" : "Boolean",
- "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
}
]
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "fireEvent",
"type" : "function",
{
"name" : "getValue",
"type" : "function",
- "desc" : "Returns the currently selected field value or empty string if no value is set.",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.ComboBox",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "value The selected value"
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
]
},
"params" : [],
"returns" : []
},
- {
- "name" : "isExpanded",
- "type" : "function",
- "desc" : "Returns true if the dropdown list is expanded, else false.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "isValid",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "onTriggerClick",
- "type" : "function",
- "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.form.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "purgeListeners",
"type" : "function",
{
"name" : "reset",
"type" : "function",
- "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(index, scrollIntoView)",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The zero-based index of the list item to select",
- "isOptional" : false
- },
- {
- "name" : "scrollIntoView",
- "type" : "Boolean",
- "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "selectByValue",
- "type" : "function",
- "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(value, scrollIntoView)",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "String",
- "desc" : "The data value of the item to select",
- "isOptional" : false
- },
- {
- "name" : "scrollIntoView",
- "type" : "Boolean",
- "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value matched an item in the list, else false"
- }
- ]
- },
- {
- "name" : "selectText",
- "type" : "function",
- "desc" : "Selects text in this field",
- "sig" : "(start, end)",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "start",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should start (defaults to 0)",
- "isOptional" : false
- },
- {
- "name" : "end",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should end (defaults to the text length)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setEditable",
- "type" : "function",
- "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Boolean",
- "desc" : "True to allow the user to directly edit the field text",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setFromData",
- "type" : "function",
- "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Object",
- "desc" : "the value to set as. or false on reset?",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setPagePosition",
"type" : "function",
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
- "sig" : "(value)",
+ "desc" : "Sets the value of the item.",
+ "sig" : "(either)",
"static" : false,
- "memberOf" : "Roo.form.ComboBox",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
+ "name" : "either",
"type" : "String",
- "desc" : "The value to match",
+ "desc" : "an object or a string..",
"isOptional" : false
}
],
"desc" : "True if the value is valid, else false"
}
]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.DateField" : {
+ "Roo.form.Hidden" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "altFormats",
- "type" : "String",
- "desc" : "Multiple date formats separated by \"|\" to try when parsing a user input value and it doesn't match the defined\nformat (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d').",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "autoCreate",
"type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"10\", autocomplete: \"off\"})",
- "memberOf" : "",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "disabledDates",
- "type" : "Array",
- "desc" : "An array of \"dates\" to disable, as strings. These strings will be used to build a dynamic regular\nexpression so they are very powerful. Some examples:\n<ul>\n<li>[\"03/08/2003\", \"09/16/2003\"] would disable those exact dates</li>\n<li>[\"03/08\", \"09/16\"] would disable those days for every year</li>\n<li>[\"^03/08\"] would only match the beginning (useful if you are using short years)</li>\n<li>[\"03/../2006\"] would disable every day in March 2006</li>\n<li>[\"^03\"] would disable every day in every March</li>\n</ul>\nIn order to support regular expressions, if you are using a date format that has \".\" in it, you will have to\nescape the dot when restricting dates. For example: [\"03\\\\.08\\\\.03\"].",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabledDatesText",
- "type" : "String",
- "desc" : "The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabledDays",
- "type" : "Array",
- "desc" : "An array of days to disable, 0 based. For example, [0, 6] disables Sunday and Saturday (defaults to null).",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabledDaysText",
- "type" : "String",
- "desc" : "The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "emptyText",
"type" : "String",
"optvals" : []
},
{
- "name" : "format",
- "type" : "String",
- "desc" : "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').",
- "memberOf" : "",
+ "name" : "grow",
+ "type" : "Boolean",
+ "desc" : "True if this field should automatically grow and shrink to its content",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMax",
+ "type" : "Number",
+ "desc" : "The maximum width to allow when grow = true (defaults to 800)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "The minimum width to allow when grow = true (defaults to 30)",
+ "memberOf" : "Roo.form.TextField",
"isOptional" : false,
"optvals" : []
},
"visibility"
]
},
- {
- "name" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "Roo.form.TriggerField",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "inputType",
"type" : "String",
{
"name" : "invalidText",
"type" : "String",
- "desc" : "The error text to display when the date in the field is invalid (defaults to\n'{value} is not a valid date - it must be in the format {format}').",
- "memberOf" : "",
+ "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "maxText",
- "type" : "String",
- "desc" : "The error text to display when the date in the cell is after maxValue (defaults to\n'The date in this field must be before {maxValue}').",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxValue",
- "type" : "Date/String",
- "desc" : "The maximum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "minLength",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "minText",
- "type" : "String",
- "desc" : "The error text to display when the date in the cell is before minValue (defaults to\n'The date in this field must be after {minValue}').",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minValue",
- "type" : "Date/String",
- "desc" : "The minimum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "msgFx",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "triggerClass",
- "type" : "String",
- "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-date-trigger'\nwhich displays a calendar icon).",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "useIso",
- "type" : "Boolean",
- "desc" : "if enabled, then the date field will use a hidden field to store the \nreal value as iso formated date. default (false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "validateOnBlur",
"type" : "Boolean",
"memberOf" : "Roo.BoxComponent",
"isOptional" : false,
"optvals" : []
- },
- {
- "name" : "zeroValue",
- "type" : "Date/String",
- "desc" : "if the date is less that this number, then the field is rendered as empty\ndefault is 1800",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
}
],
"events" : [
],
"returns" : []
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when a date is selected",
- "sig" : "function (combo, date)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.DateField",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "date",
- "type" : "Date",
- "desc" : "The date selected",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
{
"name" : "autoSize",
"type" : "function",
- "desc" : "",
+ "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.TriggerField",
+ "memberOf" : "Roo.form.TextField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "getValue",
"type" : "function",
- "desc" : "Returns the current date value of the date field.",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Date",
- "desc" : "The date value"
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
]
},
],
"returns" : []
},
- {
- "name" : "onTriggerClick",
- "type" : "function",
- "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.form.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "purgeListeners",
"type" : "function",
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets the value of the date field. You can pass a date object or any string that can be parsed into a valid\ndate, using DateField.format as the date format, according to the same rules as {@link Date#parseDate}\n(the default format used is \"m/d/y\").\n<br />Usage:\n<pre><code>\n//All of these calls set the same date value (May 4, 2006)\n\n//Pass a date object:\nvar dt = new Date('5/4/06');\ndateField.setValue(dt);\n\n//Pass a date string (default format):\ndateField.setValue('5/4/06');\n\n//Pass a date string (custom format):\ndateField.format = 'Y-m-d';\ndateField.setValue('2006-5-4');\n</code></pre>",
- "sig" : "(date)",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "date",
- "type" : "String/Date",
- "desc" : "The date or valid date string",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
"isOptional" : false
}
],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.DayPicker" : {
+ "Roo.form.HtmlEditor" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "allowComments",
+ "type" : "boolean",
+ "desc" : "- default false - allow comments in HTML source - by default they are stripped - if you are editing email you may need this.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"optvals" : []
},
{
- "name" : "autoCreate",
- "type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
+ "name" : "autoClean",
+ "type" : "boolean",
+ "desc" : "- default true - loading and saving will remove quite a bit of formating,\n if you are doing an email editor, this probably needs disabling, it's designed",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "blacklist",
+ "type" : "Array",
+ "desc" : "of html tags - in addition to standard blacklist.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "bodyCls",
+ "type" : "string",
+ "desc" : "default '' default classes to add to body of editable area - usually undoreset is a good start..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "clearUp",
+ "type" : "Boolean",
+ "desc" : "",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"optvals" : []
},
{
- "name" : "fieldClass",
- "type" : "String",
- "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
+ "name" : "enableBlocks",
+ "type" : "boolean",
+ "desc" : "- default true - if the block editor (table and figure should be enabled)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "height",
"type" : "Number",
- "desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent",
+ "desc" : "(in pixels)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
]
},
{
- "name" : "inputType",
- "type" : "String",
- "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "invalidText",
+ "name" : "labelSeparator",
"type" : "String",
- "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
"memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "labelSeparator",
+ "name" : "language",
"type" : "String",
- "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
- "memberOf" : "Roo.form.Field",
+ "desc" : "default en - language of text (usefull for rtl languages)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "msgFx",
- "type" : "String",
- "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "msgTarget",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "resizable",
+ "type" : "String",
+ "desc" : "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "style",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "stylesheets",
+ "type" : "Array",
+ "desc" : "url of stylesheets. set to [] to disable stylesheets - this is usally a good idea rootURL + '/roojs1/css/undoreset.css', .",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tabIndex",
"type" : "Number",
"optvals" : []
},
{
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field",
+ "name" : "toolbars",
+ "type" : "Array",
+ "desc" : "Array of toolbars. - defaults to just the Standard one",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "whitelist",
+ "type" : "Array",
+ "desc" : "of html tags - in addition to statndard whitelist",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "width",
"type" : "Number",
- "desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent",
+ "desc" : "(in pixels)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
+ {
+ "name" : "activate",
+ "type" : "function",
+ "desc" : "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "autosave",
+ "type" : "function",
+ "desc" : "Auto save the htmlEditor value as a file into Events",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforedestroy",
"type" : "function",
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "beforepush",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push.",
+ "sig" : "function (_self, html)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "html",
+ "type" : "String",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "blur",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Fires when this field loses input focus.",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "change",
+ "name" : "beforesync",
"type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync.",
+ "sig" : "function (_self, html)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "HtmlEditor",
"desc" : "",
"isOptional" : false
},
{
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
+ "name" : "html",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "function ()\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "function ()\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "editmodechange",
+ "type" : "function",
+ "desc" : "Fires when the editor switches edit modes",
+ "sig" : "function (_self, sourceEdit)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "sourceEdit",
+ "type" : "Boolean",
+ "desc" : "True if source edit, false if standard editing.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "editorevent",
+ "type" : "function",
+ "desc" : "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "enable",
"type" : "function",
"returns" : []
},
{
- "name" : "focus",
+ "name" : "firstfocus",
"type" : "function",
- "desc" : "Fires when this field receives input focus.",
+ "desc" : "Fires when on first focus - needed by toolbars..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "HtmlEditor",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "function ()\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "initialize",
+ "type" : "function",
+ "desc" : "Fires when the editor is fully initialized (including the iframe)",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "invalid",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "paste",
+ "type" : "function",
+ "desc" : "Fires when press user pastes into the editor",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.HtmlEditorCore",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "push",
+ "type" : "function",
+ "desc" : "Fires when the iframe editor is updated with content from the textarea.",
+ "sig" : "function (_self, html)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "savedpreview",
+ "type" : "function",
+ "desc" : "preview the saved version of htmlEditor",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
{
"name" : "specialkey",
"type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "",
+ "sig" : "function ()\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "stylesheetsclick",
+ "type" : "function",
+ "desc" : "Fires when press the Sytlesheets button",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.HtmlEditorCore",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "sync",
+ "type" : "function",
+ "desc" : "Fires when the textarea is updated with content from the editor iframe.",
+ "sig" : "function (_self, html)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "HtmlEditor",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
+ "name" : "html",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
}
],
{
"name" : "clearInvalid",
"type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
+ "desc" : "Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
+ {
+ "name" : "createToolbar",
+ "type" : "function",
+ "desc" : "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons.",
+ "sig" : "(editor)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "editor",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "getSelectedNode",
+ "type" : "function",
+ "desc" : "get the Context selected node",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getSize",
"type" : "function",
{
"name" : "getValue",
"type" : "function",
- "desc" : "Returns the checked state of the checkbox.",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if checked, else false"
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
]
},
{
"name" : "markInvalid",
"type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
+ "desc" : "Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.",
- "sig" : "(value, suppressEvent)",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [
{
"name" : "value",
- "type" : "Boolean/String",
- "desc" : "- the value to set",
- "isOptional" : false
- },
- {
- "name" : "suppressEvent",
- "type" : "Boolean/String",
- "desc" : "- whether to suppress the checkchange event.",
+ "type" : "Mixed",
+ "desc" : "The value to set",
"isOptional" : false
}
],
"params" : [],
"returns" : []
},
+ {
+ "name" : "toggleSourceEdit",
+ "type" : "function",
+ "desc" : "Toggles the editor between standard and source edit mode.",
+ "sig" : "(sourceEdit)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "sourceEdit",
+ "type" : "Boolean",
+ "desc" : "(optional) True for source edit, false for standard",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "un",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "updateLanguage",
+ "type" : "function",
+ "desc" : "update the language in the body - really done by core",
+ "sig" : "(language)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "language",
+ "type" : "String",
+ "desc" : "- eg. en / ar / zh-CN etc..",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "validate",
"type" : "function",
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.DisplayField" : {
+ "Roo.form.HtmlEditor.ToolbarContext" : {
"props" : [
{
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoCreate",
- "type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "closable",
- "type" : "Boolean",
- "desc" : "e) default fal",
+ "name" : "disable",
+ "type" : "Object",
+ "desc" : "List of toolbar elements to disable",
"memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
"optvals" : []
},
{
- "name" : "fieldClass",
- "type" : "String",
- "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
+ "name" : "styles",
+ "type" : "Object",
+ "desc" : "List of styles \n eg. { '*' : [ 'headline' ] , 'TD' : [ 'underline', 'double-underline' ] } \n\nThese must be defined in the page, so they get rendered correctly..\n.headline { }\nTD.underline { }",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
- },
- {
- "name" : "fieldLabel",
- "type" : "String",
- "desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
+ }
+ ],
+ "events" : [],
+ "methods" : [
{
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
+ "name" : "updateToolbar",
+ "type" : "function",
+ "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.\n\nNote you can force an update by calling on('editorevent', scope, false)",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
- },
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.form.HtmlEditor.ToolbarStandard" : {
+ "props" : [
{
- "name" : "inputType",
- "type" : "String",
- "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field",
+ "name" : "btns[]",
+ "type" : "Roo.Toolbar.Item|Roo.Toolbar.Button|Roo.Toolbar.SplitButton|Roo.form.Field",
+ "desc" : "List of additional buttons.\n\n\nNEEDS Extra CSS? \n.x-html-editor-tb .x-edit-none .x-btn-text { background: none; }",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "invalidClass",
+ "name" : "createLinkText",
"type" : "String",
- "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field",
+ "desc" : "The default text for the create link prompt",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "invalidText",
+ "name" : "defaultFont",
"type" : "String",
- "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : "Roo.form.Field",
+ "desc" : "default font to use.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "labelSeparator",
+ "name" : "defaultLinkValue",
"type" : "String",
- "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
- "memberOf" : "Roo.form.Field",
+ "desc" : "The default value for the create link prompt (defaults to http:/ /)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "listeners",
+ "name" : "disable",
"type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
+ "desc" : "List of elements to disable..",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "msgFx",
- "type" : "String",
- "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf" : "Roo.form.Field",
+ "name" : "fontFamilies",
+ "type" : "Array",
+ "desc" : "An array of available font families",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
- },
+ }
+ ],
+ "events" : [],
+ "methods" : [
{
- "name" : "msgTarget",
+ "name" : "updateToolbar",
+ "type" : "function",
+ "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.form.Layout" : {
+ "props" : [
+ {
+ "name" : "actionMode",
"type" : "String",
- "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
- "memberOf" : "Roo.form.Field",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "name",
- "type" : "String",
- "desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field",
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "qtip",
- "type" : "String",
- "desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field",
+ "name" : "autoCreate",
+ "type" : "String/Object",
+ "desc" : "A DomHelper element spec used to autocreate the layout (defaults to {tag: 'div', cls: 'x-form-ct'})",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "readOnly",
+ "name" : "clear",
"type" : "Boolean",
- "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf" : "Roo.form.Field",
+ "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "style",
+ "name" : "disableClass",
"type" : "String",
- "desc" : "css styles to add to component\neg. text-align:right;",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tabIndex",
- "type" : "Number",
- "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : "Roo.form.Field",
+ "name" : "hideLabels",
+ "type" : "Boolean",
+ "desc" : "True to suppress the display of field labels in this layout (defaults to false)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field",
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.form.Field",
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)\nValid values are \"left,\" \"top\" and \"right\" (defaults to \"left",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "left",
+ "top",
+ "right"
+ ]
},
{
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.form.Field",
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "The separator to use after field labels (defaults to ':')",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field",
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "valueRenderer",
- "type" : "Function",
- "desc" : "The renderer for the field (so you can reformat output). should return raw HTML",
- "memberOf" : "",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent",
+ "name" : "style",
+ "type" : "String/Object/Function",
+ "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
}
],
"returns" : []
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "close",
- "type" : "function",
- "desc" : "Fires after the click the close btn",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.DisplayField",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "move",
- "type" : "function",
- "desc" : "Fires after the component is moved.",
- "sig" : "function (_self, x, y)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "resize",
- "type" : "function",
- "desc" : "Fires after the component is resized.",
- "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
- "isOptional" : false
- },
- {
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
- "isOptional" : false
- },
- {
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"methods" : [
"returns" : []
},
{
- "name" : "applyTo",
+ "name" : "addxtype",
"type" : "function",
- "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
- "sig" : "(el)",
+ "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column",
+ "sig" : "(config)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id of the node, a DOM node or an existing Element",
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.form.Field",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
"name" : "capture",
],
"returns" : []
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "getBox",
- "type" : "function",
- "desc" : "Gets the current box measurements of the component's underlying element.",
- "sig" : "(local)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "getEl",
"type" : "function",
}
]
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name attribute of the field if available",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "name The field name"
- }
- ]
- },
- {
- "name" : "getPosition",
- "type" : "function",
- "desc" : "Gets the current XY position of the component's underlying element.",
- "sig" : "(local)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Array",
- "desc" : "The XY position of the element (e.g., [100, 200])"
- }
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "getSize",
- "type" : "function",
- "desc" : "Gets the current size of the component's underlying element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
- }
- ]
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "hasChanged",
- "type" : "function",
- "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "hasListener",
"type" : "function",
}
]
},
- {
- "name" : "isDirty",
- "type" : "function",
- "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isValid",
- "type" : "function",
- "desc" : "Returns whether or not the field value is currently valid",
- "sig" : "(preventMark)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "True to disable marking the field invalid",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "onPosition",
- "type" : "function",
- "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
- "sig" : "(x, y)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "onResize",
- "type" : "function",
- "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
- "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
- "isOptional" : false
- },
- {
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
- "isOptional" : false
- },
- {
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "purgeListeners",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "resetHasChanged",
- "type" : "function",
- "desc" : "stores the current value in loadedValue",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setPagePosition",
- "type" : "function",
- "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
- "sig" : "(x, y)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setPosition",
- "type" : "function",
- "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
- "sig" : "(left, top)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "left",
- "type" : "Number",
- "desc" : "The new left",
- "isOptional" : false
- },
- {
- "name" : "top",
- "type" : "Number",
- "desc" : "The new top",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setSize",
- "type" : "function",
- "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
- "sig" : "(width, height)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "width",
- "type" : "Number/Object",
- "desc" : "The new width to set, or a size object in the format {width, height}",
- "isOptional" : false
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "The new height to set (not required if a size object is passed as the first arg)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.BoxComponent",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets the checked state of the checkbox.",
- "sig" : "(checked)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "checked",
- "type" : "Boolean/String",
- "desc" : "True, 'true', '1', or 'on' to check the checkbox, any other value will uncheck it.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisible",
"type" : "function",
}
]
},
- {
- "name" : "syncSize",
- "type" : "function",
- "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "un",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "updateBox",
- "type" : "function",
- "desc" : "Sets the current box measurements of the component's underlying element.",
- "sig" : "(box)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "box",
- "type" : "Object",
- "desc" : "An object in the format {x, y, width, height}",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
+ "implementations" : [
+ "Roo.form.Column",
+ "Roo.form.FieldSet",
+ "Roo.form.Row"
+ ],
+ "tree_children" : [
+ "Roo.form.Column",
+ "Roo.form.Row",
+ "Roo.form.Field",
+ "Roo.form.Checkbox",
+ "Roo.form.ComboBox",
+ "Roo.form.ComboBoxArray",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.FCKeditor",
+ "Roo.form.GridField",
+ "Roo.form.Hidden",
+ "Roo.form.HtmlEditor",
+ "Roo.form.MonthField",
+ "Roo.form.NumberField",
+ "Roo.form.Radio",
+ "Roo.form.Select",
+ "Roo.form.Signature",
+ "Roo.form.TextArea",
+ "Roo.form.TextField",
+ "Roo.form.TriggerField",
+ "Roo.Button",
+ "Roo.SplitButton",
+ "Roo.Toolbar.Button",
+ "Roo.Toolbar.SplitButton",
+ "Roo.form.TextItem",
+ "Roo.form.FieldSet"
+ ],
"tree_parent" : []
},
- "Roo.form.FCKeditor" : {
+ "Roo.form.MonthField" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "altFormats",
+ "type" : "String",
+ "desc" : "Multiple date formats separated by \"|\" to try when parsing a user input value and it doesn't match the defined\nformat (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d').",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "autoCreate",
"type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"textarea\", style: \"width:300px;height:60px;\", autocomplete: \"off\"})",
- "memberOf" : "Roo.form.TextArea",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"10\", autocomplete: \"off\"})",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "emptyText",
+ "name" : "disabledDates",
+ "type" : "Array",
+ "desc" : "An array of \"dates\" to disable, as strings. These strings will be used to build a dynamic regular\nexpression so they are very powerful. Some examples:\n<ul>\n<li>[\"03/08/2003\", \"09/16/2003\"] would disable those exact dates</li>\n<li>[\"03/08\", \"09/16\"] would disable those days for every year</li>\n<li>[\"^03/08\"] would only match the beginning (useful if you are using short years)</li>\n<li>[\"03/../2006\"] would disable every day in March 2006</li>\n<li>[\"^03\"] would disable every day in every March</li>\n</ul>\nIn order to support regular expressions, if you are using a date format that has \".\" in it, you will have to\nescape the dot when restricting dates. For example: [\"03\\\\.08\\\\.03\"].",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabledDatesText",
"type" : "String",
- "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField",
+ "desc" : "The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled')",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "fck",
- "type" : "Object",
- "desc" : "BasePath",
+ "name" : "disabledDays",
+ "type" : "Array",
+ "desc" : "An array of days to disable, 0 based. For example, [0, 6] disables Sunday and Saturday (defaults to null).",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "fieldClass",
+ "name" : "disabledDaysText",
"type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field",
+ "desc" : "The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "fieldLabel",
+ "name" : "emptyText",
"type" : "String",
- "desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field",
+ "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf" : "Roo.form.TextField",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "focusClass",
+ "name" : "fieldClass",
"type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
"memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "grow",
- "type" : "Boolean",
- "desc" : "True if this field should automatically grow and shrink to its content",
- "memberOf" : "Roo.form.TextField",
+ "name" : "fieldLabel",
+ "type" : "String",
+ "desc" : "Label to use when rendering a form.",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "growMax",
- "type" : "Number",
- "desc" : "The maximum height to allow when grow = true (defaults to 1000)",
- "memberOf" : "Roo.form.TextArea",
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "growMin",
- "type" : "Number",
- "desc" : "The minimum height to allow when grow = true (defaults to 60)",
- "memberOf" : "Roo.form.TextArea",
+ "name" : "format",
+ "type" : "String",
+ "desc" : "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"visibility"
]
},
+ {
+ "name" : "hideTrigger",
+ "type" : "Boolean",
+ "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf" : "Roo.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "inputType",
"type" : "String",
{
"name" : "invalidText",
"type" : "String",
- "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : "Roo.form.Field",
+ "desc" : "The error text to display when the date in the field is invalid (defaults to\n'{value} is not a valid date - it must be in the format {format}').",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "maxTextf",
+ "type" : "String",
+ "desc" : "The error text to display when the date in the cell is after maxValue (defaults to\n'The date in this field must be before {maxValue}').",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxValue",
+ "type" : "Date/String",
+ "desc" : "The maximum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "minLength",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "minText",
+ "type" : "String",
+ "desc" : "The error text to display when the date in the cell is before minValue (defaults to\n'The date in this field must be after {minValue}').",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minValue",
+ "type" : "Date/String",
+ "desc" : "The minimum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "msgFx",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "preventScrollbars",
- "type" : "Boolean",
- "desc" : "True to prevent scrollbars from appearing regardless of how much text is\nin the field (equivalent to setting overflow: hidden, defaults to false)",
- "memberOf" : "Roo.form.TextArea",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "qtip",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "triggerClass",
+ "type" : "String",
+ "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-date-trigger'\nwhich displays a calendar icon).",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "useIso",
+ "type" : "Boolean",
+ "desc" : "if enabled, then the date field will use a hidden field to store the \nreal value as iso formated date. default (true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "validateOnBlur",
"type" : "Boolean",
],
"returns" : []
},
- {
- "name" : "editorinit",
- "type" : "function",
- "desc" : "Fired when the editor is initialized - you can add extra handlers here..",
- "sig" : "function (_self, the)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "FCKeditor",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "the",
- "type" : "Object",
- "desc" : "FCK object.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "Fires when a date is selected",
+ "sig" : "function (combo, date)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.form.MonthFieeld",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "date",
+ "type" : "Date",
+ "desc" : "The date selected",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
{
"name" : "autoSize",
"type" : "function",
- "desc" : "Automatically grows the field to accomodate the height of the text up to the maximum field height allowed.\nThis only takes effect if grow = true, and fires the autosize event if the height changes.",
+ "desc" : "",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.TextArea",
+ "memberOf" : "Roo.form.TriggerField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "getValue",
"type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "desc" : "Returns the current date value of the date field.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "Date",
+ "desc" : "The date value"
}
]
},
],
"returns" : []
},
+ {
+ "name" : "onTriggerClick",
+ "type" : "function",
+ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.form.TriggerField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "purgeListeners",
"type" : "function",
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
+ "desc" : "Sets the value of the date field. You can pass a date object or any string that can be parsed into a valid\ndate, using MonthField.format as the date format, according to the same rules as {@link Date#parseDate}\n(the default format used is \"m/d/y\").\n<br />Usage:\n<pre><code>\n//All of these calls set the same date value (May 4, 2006)\n\n//Pass a date object:\nvar dt = new Date('5/4/06');\nmonthField.setValue(dt);\n\n//Pass a date string (default format):\nmonthField.setValue('5/4/06');\n\n//Pass a date string (custom format):\nmonthField.format = 'Y-m-d';\nmonthField.setValue('2006-5-4');\n</code></pre>",
+ "sig" : "(date)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "date",
+ "type" : "String/Date",
+ "desc" : "The date or valid date string",
"isOptional" : false
}
],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.Field" : {
+ "Roo.form.NumberField" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowDecimals",
+ "type" : "Boolean",
+ "desc" : "False to disallow decimal values (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowNegative",
+ "type" : "Boolean",
+ "desc" : "False to prevent entering a negative sign (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "autoCreate",
"type" : "String/Object",
"desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.form.TextField",
"isOptional" : false,
"optvals" : []
},
"name" : "cls",
"type" : "String",
"desc" : "A CSS class to apply to the field's underlying element.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "decimalPrecision",
+ "type" : "Number",
+ "desc" : "The maximum precision to display after the decimal separator (defaults to 2)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "decimalSeparator",
+ "type" : "String",
+ "desc" : "Character(s) to allow as the decimal separator (defaults to '.')",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to disable the field (defaults to false).",
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "emptyText",
+ "type" : "String",
+ "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf" : "Roo.form.TextField",
"isOptional" : false,
"optvals" : []
},
{
"name" : "fieldClass",
"type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field x-form-num-field\")",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"name" : "fieldLabel",
"type" : "String",
"desc" : "Label to use when rendering a form.",
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
"name" : "focusClass",
"type" : "String",
"desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "grow",
+ "type" : "Boolean",
+ "desc" : "True if this field should automatically grow and shrink to its content",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMax",
+ "type" : "Number",
+ "desc" : "The maximum width to allow when grow = true (defaults to 800)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "The minimum width to allow when grow = true (defaults to 30)",
+ "memberOf" : "Roo.form.TextField",
"isOptional" : false,
"optvals" : []
},
"name" : "inputType",
"type" : "String",
"desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
"name" : "invalidClass",
"type" : "String",
"desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
"name" : "invalidText",
"type" : "String",
"desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
"name" : "labelSeparator",
"type" : "String",
"desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxValue",
+ "type" : "Number",
+ "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minValue",
+ "type" : "Number",
+ "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "msgFx",
"type" : "String",
"desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
"name" : "msgTarget",
"type" : "String",
"desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
"name" : "name",
"type" : "String",
"desc" : "The field's HTML name attribute.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "nanText",
+ "type" : "String",
+ "desc" : "Error text to display if the value is not a valid number. For example, this can happen\nif a valid character like '.' or '-' is left in the field with no number (defaults to \"{value} is not a valid number\")",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"name" : "qtip",
"type" : "String",
"desc" : "Mouse over tip",
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
"name" : "readOnly",
"type" : "Boolean",
"desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.form.TextField",
"isOptional" : false,
"optvals" : []
},
"name" : "tabIndex",
"type" : "Number",
"desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
"name" : "validationDelay",
"type" : "Number",
"desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
"name" : "validationEvent",
"type" : "String/Boolean",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.form.TextField",
"isOptional" : false,
"optvals" : []
},
"name" : "value",
"type" : "Mixed",
"desc" : "A value to initialize this field with.",
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.form.TextField",
"isOptional" : false,
"optvals" : []
},
}
],
"events" : [
+ {
+ "name" : "autosize",
+ "type" : "function",
+ "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
+ "sig" : "function (_self, width)\n{\n\n}",
+ "memberOf" : "Roo.form.TextField",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "This text field",
+ "isOptional" : false
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The new field width",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforedestroy",
"type" : "function",
"type" : "function",
"desc" : "Fires when this field loses input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires just before the field blurs if the field value has changed.",
"sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when this field receives input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the field has been marked as invalid.",
"sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the key up",
"sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
"sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the field has been validated with no errors.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"exceptions" : "",
"requires" : "",
"params" : [
- {
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "addListener",
- "type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "applyTo",
- "type" : "function",
- "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
- "sig" : "(el)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id of the node, a DOM node or an existing Element",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.form.Field",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "capture",
- "type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "fireEvent",
- "type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "getBox",
- "type" : "function",
- "desc" : "Gets the current box measurements of the component's underlying element.",
- "sig" : "(local)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
- }
- ]
- },
- {
- "name" : "getId",
- "type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name attribute of the field if available",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "name The field name"
- }
- ]
- },
- {
- "name" : "getPosition",
- "type" : "function",
- "desc" : "Gets the current XY position of the component's underlying element.",
- "sig" : "(local)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Array",
- "desc" : "The XY position of the element (e.g., [100, 200])"
- }
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "getSize",
- "type" : "function",
- "desc" : "Gets the current size of the component's underlying element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
- }
- ]
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "hasChanged",
- "type" : "function",
- "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "hasListener",
- "type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "isDirty",
- "type" : "function",
- "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isValid",
- "type" : "function",
- "desc" : "Returns whether or not the field value is currently valid",
- "sig" : "(preventMark)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "True to disable marking the field invalid",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
+ {
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "on",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "desc" : "Appends an event handler to this component",
"sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
{
"name" : "options",
"type" : "Object",
- "desc" : "(optional)",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onPosition",
+ "name" : "applyTo",
"type" : "function",
- "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
- "sig" : "(x, y)",
+ "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id of the node, a DOM node or an existing Element",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "onResize",
- "type" : "function",
- "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
- "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
- "isOptional" : false
- },
- {
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
- "isOptional" : false
- },
+ "returns" : [
{
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.form.Field",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "purgeListeners",
+ "name" : "autoSize",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.form.TextField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "capture",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
"static" : true,
"memberOf" : "Roo.util.Observable",
"isStatic" : true,
{
"name" : "o",
"type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "removeListener",
- "type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "handler",
+ "name" : "fn",
"type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "The function to call",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "reset",
+ "name" : "clearInvalid",
"type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "desc" : "Clear any invalid styles/messages for this field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "resetHasChanged",
+ "name" : "destroy",
"type" : "function",
- "desc" : "stores the current value in loadedValue",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "disable",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setPagePosition",
+ "name" : "enable",
"type" : "function",
- "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
- "sig" : "(x, y)",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setPosition",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
- "sig" : "(left, top)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "left",
- "type" : "Number",
- "desc" : "The new left",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "top",
- "type" : "Number",
- "desc" : "The new top",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ "returns" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setSize",
+ "name" : "focus",
"type" : "function",
- "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
- "sig" : "(width, height)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "width",
- "type" : "Number/Object",
- "desc" : "The new width to set, or a size object in the format {width, height}",
- "isOptional" : false
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "The new height to set (not required if a size object is passed as the first arg)",
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.BoxComponent",
+ "type" : "Roo.Component",
"desc" : "this"
}
]
},
{
- "name" : "setValue",
+ "name" : "getBox",
"type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
+ "desc" : "Gets the current box measurements of the component's underlying element.",
+ "sig" : "(local)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "show",
+ "name" : "getId",
"type" : "function",
- "desc" : "Show this component.",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component",
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "syncSize",
+ "name" : "getName",
"type" : "function",
- "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
+ "desc" : "Returns the name attribute of the field if available",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "name The field name"
+ }
+ ]
},
{
- "name" : "un",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Gets the current XY position of the component's underlying element.",
+ "sig" : "(local)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "The XY position of the element (e.g., [100, 200])"
+ }
+ ]
},
{
- "name" : "updateBox",
+ "name" : "getRawValue",
"type" : "function",
- "desc" : "Sets the current box measurements of the component's underlying element.",
- "sig" : "(box)",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "box",
- "type" : "Object",
- "desc" : "An object in the format {x, y, width, height}",
- "isOptional" : false
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "validate",
+ "name" : "getSize",
"type" : "function",
- "desc" : "Validates the field value",
+ "desc" : "Gets the current size of the component's underlying element.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "type" : "Object",
+ "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
}
]
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.form.Checkbox",
- "Roo.form.ComboBox",
- "Roo.form.ComboBoxArray",
- "Roo.form.ComboCheck",
- "Roo.form.ComboNested",
- "Roo.form.DateField",
- "Roo.form.DayPicker",
- "Roo.form.DisplayField",
- "Roo.form.FCKeditor",
- "Roo.form.GridField",
- "Roo.form.Hidden",
- "Roo.form.HtmlEditor",
- "Roo.form.MonthField",
- "Roo.form.NumberField",
- "Roo.form.Radio",
- "Roo.form.Select",
- "Roo.form.Signature",
- "Roo.form.TextArea",
- "Roo.form.TextField",
- "Roo.form.TriggerField"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.form.FieldSet" : {
- "props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoCreate",
- "type" : "String/Object",
- "desc" : "A DomHelper element spec used to autocreate the fieldset (defaults to {tag: 'fieldset', cn: {tag:'legend'}})",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "clear",
- "type" : "Boolean",
- "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
- "memberOf" : "Roo.form.Layout",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideLabels",
- "type" : "Boolean",
- "desc" : "True to suppress the display of field labels in this layout (defaults to false)",
- "memberOf" : "Roo.form.Layout",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
- },
- {
- "name" : "labelAlign",
- "type" : "String",
- "desc" : "t)\nValid values are \"left,\" \"top\" and \"right\" (defaults to \"left",
- "memberOf" : "Roo.form.Layout",
- "isOptional" : false,
- "optvals" : [
- "left",
- "top",
- "right"
- ]
- },
- {
- "name" : "labelSeparator",
- "type" : "String",
- "desc" : "The separator to use after field labels (defaults to ':')",
- "memberOf" : "Roo.form.Layout",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
- "memberOf" : "Roo.form.Layout",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "legend",
- "type" : "String",
- "desc" : "The text to display as the legend for the FieldSet (defaults to '')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
},
{
- "name" : "style",
- "type" : "String/Object/Function",
- "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
- "memberOf" : "Roo.form.Layout",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "beforedestroy",
+ "name" : "getValue",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "beforehide",
+ "name" : "hasChanged",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "destroy",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Hide this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "this",
+ "name" : "",
"type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "disable",
+ "name" : "isDirty",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "enable",
+ "name" : "isValid",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Returns whether or not the field value is currently valid",
+ "sig" : "(preventMark)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "True to disable marking the field invalid",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "render",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "methods" : [
- {
- "name" : "addEvents",
+ "name" : "markInvalid",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "on",
"type" : "function",
- "desc" : "Appends an event handler to this component",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
"sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
{
"name" : "options",
"type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addxtype",
+ "name" : "onPosition",
"type" : "function",
- "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column",
- "sig" : "(config)",
+ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
+ "sig" : "(x, y)",
"static" : false,
- "memberOf" : "Roo.form.Layout",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "config",
- "type" : "Object",
- "desc" : "",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "onResize",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
+ "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
"isOptional" : false
},
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "enable",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "focus",
+ "name" : "render",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
"memberOf" : "Roo.Component",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "getEl",
+ "name" : "reset",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.TextField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
- }
- ]
+ "returns" : []
},
{
- "name" : "getId",
+ "name" : "resetHasChanged",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "stores the current value in loadedValue",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "selectText",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Selects text in this field",
+ "sig" : "(start, end)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.form.TextField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "start",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should start (defaults to 0)",
"isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "end",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should end (defaults to the text length)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "isVisible",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
"memberOf" : "Roo.Component",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "on",
+ "name" : "setPagePosition",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
+ "sig" : "(x, y)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "setPosition",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
+ "sig" : "(left, top)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "left",
+ "type" : "Number",
+ "desc" : "The new left",
+ "isOptional" : false
+ },
+ {
+ "name" : "top",
+ "type" : "Number",
+ "desc" : "The new top",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "setRawValue",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "setSize",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
+ "sig" : "(width, height)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "width",
+ "type" : "Number/Object",
+ "desc" : "The new width to set, or a size object in the format {width, height}",
+ "isOptional" : false
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height to set (not required if a size object is passed as the first arg)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.BoxComponent",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "setDisabled",
+ "name" : "setValue",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
"isOptional" : false
}
],
}
]
},
+ {
+ "name" : "syncSize",
+ "type" : "function",
+ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "un",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "updateBox",
+ "type" : "function",
+ "desc" : "Sets the current box measurements of the component's underlying element.",
+ "sig" : "(box)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "box",
+ "type" : "Object",
+ "desc" : "An object in the format {x, y, width, height}",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.form.Column",
- "Roo.form.Row",
- "Roo.form.Field",
- "Roo.form.Checkbox",
- "Roo.form.ComboBox",
- "Roo.form.ComboBoxArray",
- "Roo.form.ComboCheck",
- "Roo.form.ComboNested",
- "Roo.form.DateField",
- "Roo.form.DayPicker",
- "Roo.form.DisplayField",
- "Roo.form.FCKeditor",
- "Roo.form.GridField",
- "Roo.form.Hidden",
- "Roo.form.HtmlEditor",
- "Roo.form.MonthField",
- "Roo.form.NumberField",
- "Roo.form.Radio",
- "Roo.form.Select",
- "Roo.form.Signature",
- "Roo.form.TextArea",
- "Roo.form.TextField",
- "Roo.form.TriggerField",
- "Roo.Button",
- "Roo.SplitButton",
- "Roo.Toolbar.Button",
- "Roo.Toolbar.SplitButton",
- "Roo.form.TextItem"
- ],
+ "tree_children" : [],
"tree_parent" : []
},
- "Roo.form.Form" : {
+ "Roo.form.Radio" : {
"props" : [
{
- "name" : "baseParams",
- "type" : "Object",
- "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
- "memberOf" : "Roo.form.BasicForm",
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "buttonAlign",
- "type" : "String",
- "desc" : "t) Valid values are \"left,\" \"center\" and \"right\" (defaults to \"center",
- "memberOf" : "",
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
- "optvals" : [
- "left",
- "center",
- "right"
- ]
+ "optvals" : []
},
{
- "name" : "buttons[]",
- "type" : "Roo.Button",
- "desc" : "buttons at bottom of form",
- "memberOf" : "",
+ "name" : "autoCreate",
+ "type" : "String/Object",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
+ "memberOf" : "Roo.form.Checkbox",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "errorMask",
+ "name" : "boxLabel",
+ "type" : "String",
+ "desc" : "The text that appears beside the checkbox",
+ "memberOf" : "Roo.form.Checkbox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "checked",
"type" : "Boolean",
- "desc" : "Should the form be masked (and the active element highlighted on error - default false",
- "memberOf" : "Roo.form.BasicForm",
+ "desc" : "True if the the checkbox should render already checked (defaults to false)",
+ "memberOf" : "Roo.form.Checkbox",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "errorReader",
- "type" : "DataReader",
- "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when reading validation errors on \"submit\" actions.\nThis is completely optional as there is built-in support for processing JSON.",
- "memberOf" : "Roo.form.BasicForm",
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "A CSS class to apply to the field's underlying element.",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "fileUpload",
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabled",
"type" : "Boolean",
- "desc" : "Set to true if this form is a file upload.",
- "memberOf" : "Roo.form.BasicForm",
+ "desc" : "True to disable the field (defaults to false).",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "formData",
- "type" : "boolean|FormData",
- "desc" : "- true to use new 'FormData' post, or set to a new FormData({dom form}) Object, if\nsending a formdata with extra parameters - eg uploaded elements.",
- "memberOf" : "",
+ "name" : "fieldClass",
+ "type" : "String",
+ "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
+ "memberOf" : "Roo.form.Checkbox",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "itemCls",
+ "name" : "fieldLabel",
"type" : "String",
- "desc" : "A css class to apply to the x-form-item of fields. This property cascades to child containers.",
- "memberOf" : "",
+ "desc" : "Label to use when rendering a form.",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "labelAlign",
+ "name" : "focusClass",
"type" : "String",
- "desc" : "t) Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\").\nThis property cascades to child containers if not se",
- "memberOf" : "",
+ "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
+ "memberOf" : "Roo.form.Checkbox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "height (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : [
- "left",
- "top",
- "right"
+ "display",
+ "visibility"
]
},
{
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "The width of labels. This property cascades to child containers.",
- "memberOf" : "",
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "inputValue",
+ "type" : "String",
+ "desc" : "The value that should go into the generated input element's value attribute",
+ "memberOf" : "Roo.form.Checkbox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "maskOffset",
- "type" : "Number",
- "desc" : "space around form element to mask if there is an error Default 100",
- "memberOf" : "Roo.form.BasicForm",
+ "name" : "msgFx",
+ "type" : "String",
+ "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "method",
+ "name" : "msgTarget",
"type" : "String",
- "desc" : "The request method to use (GET or POST) for form actions if one isn't supplied in the action options.",
- "memberOf" : "Roo.form.BasicForm",
+ "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "minButtonWidth",
- "type" : "Number",
- "desc" : "Minimum width of all buttons in pixels (defaults to 75)",
- "memberOf" : "",
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The field's HTML name attribute.",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "monitorPoll",
- "type" : "Number",
- "desc" : "The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)",
- "memberOf" : "",
+ "name" : "qtip",
+ "type" : "String",
+ "desc" : "Mouse over tip",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "monitorValid",
+ "name" : "readOnly",
"type" : "Boolean",
- "desc" : "If true the form monitors its valid state <b>client-side</b> and\nfires a looping event with that state. This is required to bind buttons to the valid\nstate using the config value formBind:true on the button.",
- "memberOf" : "",
+ "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "progressUrl",
+ "name" : "style",
"type" : "String",
- "desc" : "- Url to return progress data",
- "memberOf" : "",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "reader",
- "type" : "DataReader",
- "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when executing \"load\" actions.\nThis is optional as there is built-in support for processing JSON.",
- "memberOf" : "Roo.form.BasicForm",
+ "name" : "tabIndex",
+ "type" : "Number",
+ "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "timeout",
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationDelay",
"type" : "Number",
- "desc" : "Timeout for form actions in seconds (default is 30 seconds).",
- "memberOf" : "Roo.form.BasicForm",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "trackResetOnLoad",
- "type" : "Boolean",
- "desc" : "If set to true, form.reset() resets to the last loaded\nor setValues() data instead of when the form was first created.",
- "memberOf" : "Roo.form.BasicForm",
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "url",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "A value to initialize this field with.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "valueOff",
"type" : "String",
- "desc" : "The URL to use for form actions if one isn't supplied in the action options.",
- "memberOf" : "Roo.form.BasicForm",
+ "desc" : "The value that should go into the generated input element's value when unchecked.",
+ "memberOf" : "Roo.form.Checkbox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "width (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
{
- "name" : "actioncomplete",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fires when an action is completed.",
- "sig" : "function (_self, action)\n{\n\n}",
- "memberOf" : "Roo.form.BasicForm",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Form",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforehide",
+ "type" : "function",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "action",
- "type" : "Action",
- "desc" : "The action that completed",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "actionfailed",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires when an action fails.",
- "sig" : "function (_self, action)\n{\n\n}",
- "memberOf" : "Roo.form.BasicForm",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Form",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "action",
- "type" : "Action",
- "desc" : "The action that failed",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeaction",
+ "name" : "blur",
"type" : "function",
- "desc" : "Fires before any action is performed. Return false to cancel the action.",
- "sig" : "function (_self, action)\n{\n\n}",
- "memberOf" : "Roo.form.BasicForm",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Form",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
},
{
- "name" : "action",
- "type" : "Action",
- "desc" : "The action to be performed",
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "clientvalidation",
+ "name" : "check",
"type" : "function",
- "desc" : "If the monitorValid config option is true, this event fires repetitively to notify of valid state",
- "sig" : "function (_self, valid)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when the checkbox is checked or unchecked.",
+ "sig" : "function (_self, checked)\n{\n\n}",
+ "memberOf" : "Roo.form.Checkbox",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Form",
- "desc" : "",
+ "type" : "Roo.form.Checkbox",
+ "desc" : "This checkbox",
"isOptional" : false
},
{
- "name" : "valid",
+ "name" : "checked",
"type" : "Boolean",
- "desc" : "true if the form has passed client-side validation",
+ "desc" : "The new checked value",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "rendered",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires when the form is rendered",
- "sig" : "function (form)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "form",
- "type" : "Roo.form.Form",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "add",
+ "name" : "disable",
"type" : "function",
- "desc" : "Add Roo.form components to the current open container (e.g. column, fieldset, etc.). Fields added via this method\ncan also be passed with an additional property of fieldLabel, which if supplied, will provide the text to display\nas the label of the field.",
- "sig" : "(field1, field2)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "field1",
- "type" : "Field",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "field2",
- "type" : "Field",
- "desc" : "(optional)",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Form",
- "desc" : "this"
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "addButton",
+ "name" : "hide",
"type" : "function",
- "desc" : "Adds a button to the footer of the form - this <b>must</b> be called before the form is rendered.",
- "sig" : "(config, handler, scope)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "config",
- "type" : "String/Object",
- "desc" : "A string becomes the button text, an object can either be a Button config\nobject or a valid Roo.DomHelper element config",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The function called when the button is clicked",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the handler function",
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Button",
- "desc" : ""
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "addEvents",
+ "name" : "move",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is moved.",
+ "sig" : "function (_self, x, y)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addForm",
+ "name" : "render",
"type" : "function",
- "desc" : "Add a secondary form to this one, \nUsed to provide tabbed forms. One form is primary, with hidden values \nwhich mirror the elements from the other forms.",
- "sig" : "(form)",
- "static" : false,
- "memberOf" : "Roo.form.BasicForm",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "form",
- "type" : "Roo.form.Form",
- "desc" : "to add.",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "resize",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is resized.",
+ "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addxtype",
+ "name" : "show",
"type" : "function",
- "desc" : "Adds a series of form elements (using the xtype property as the factory method.\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column, (and 'end' to close a block)",
- "sig" : "(config)",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "config",
+ "name" : "object",
"type" : "Object",
- "desc" : "",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "applyIfToFields",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Calls {@link Ext#applyIf} for all field in this form with the passed object.",
- "sig" : "(values)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "values",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
"type" : "Object",
- "desc" : "",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "applyToFields",
+ "name" : "applyTo",
"type" : "function",
- "desc" : "Calls {@link Ext#apply} for all fields in this form with the passed object.",
- "sig" : "(values)",
+ "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "values",
- "type" : "Object",
- "desc" : "",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id of the node, a DOM node or an existing Element",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "BasicForm",
+ "type" : "Roo.form.Field",
"desc" : "this"
}
]
{
"name" : "clearInvalid",
"type" : "function",
- "desc" : "Clears all invalid messages in this form.",
+ "desc" : "Clear any invalid styles/messages for this field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "BasicForm",
+ "type" : "Roo.Component",
"desc" : "this"
}
]
},
{
- "name" : "column",
+ "name" : "enable",
"type" : "function",
- "desc" : "Opens a new {@link Roo.form.Column} container in the layout stack. If fields are passed after the config, the\nfields are added and the column is closed. If no fields are passed the column remains open\nuntil end() is called.",
- "sig" : "(config, field1, field2, etc)",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "config",
- "type" : "Object",
- "desc" : "The config to pass to the column",
- "isOptional" : false
- },
- {
- "name" : "field1",
- "type" : "Field",
- "desc" : "(optional)",
- "isOptional" : false
- },
- {
- "name" : "field2",
- "type" : "Field",
- "desc" : "(optional)",
- "isOptional" : false
- },
- {
- "name" : "etc",
- "type" : "Field",
- "desc" : "(optional)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "",
- "desc" : "Column The column container object"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "container",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Opens a new {@link Roo.form.Layout} container in the layout stack. If fields are passed after the config, the\nfields are added and the container is closed. If no fields are passed the container remains open\nuntil end() is called.",
- "sig" : "(config, field1, field2, etc)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "config",
- "type" : "Object",
- "desc" : "The config to pass to the Layout",
- "isOptional" : false
- },
- {
- "name" : "field1",
- "type" : "Field",
- "desc" : "(optional)",
- "isOptional" : false
- },
- {
- "name" : "field2",
- "type" : "Field",
- "desc" : "(optional)",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "etc",
- "type" : "Field",
- "desc" : "(optional)",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "",
- "desc" : "Layout The container object"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "doAction",
+ "name" : "focus",
"type" : "function",
- "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.",
- "sig" : "(actionName, options)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "actionName",
- "type" : "String",
- "desc" : "The name of the action type",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) The options to pass to the action. All of the config options listed\nbelow are supported by both the submit and load actions unless otherwise noted (custom actions could also\naccept other config options):\n<pre>\nProperty Type Description\n---------------- --------------- ----------------------------------------------------------------------------------\nurl String The url for the action (defaults to the form's url)\nmethod String The form method to use (defaults to the form's method, or POST if not defined)\nparams String/Object The params to pass (defaults to the form's baseParams, or none if not defined)\nclientValidation Boolean Applies to submit only. Pass true to call form.isValid() prior to posting to\n validate the form on the client (defaults to false)\n</pre>",
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "BasicForm",
+ "type" : "Roo.Component",
"desc" : "this"
}
]
},
{
- "name" : "end",
+ "name" : "getBox",
"type" : "function",
- "desc" : "Closes the current open container",
+ "desc" : "Gets the current box measurements of the component's underlying element.",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Form",
- "desc" : "this"
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "fieldset",
+ "name" : "getGroupValue",
"type" : "function",
- "desc" : "Opens a new {@link Roo.form.FieldSet} container in the layout stack. If fields are passed after the config, the\nfields are added and the fieldset is closed. If no fields are passed the fieldset remains open\nuntil end() is called.",
- "sig" : "(config, field1, field2, etc)",
+ "desc" : "If this radio is part of a group, it will return the selected value",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "config",
- "type" : "Object",
- "desc" : "The config to pass to the fieldset",
- "isOptional" : false
- },
- {
- "name" : "field1",
- "type" : "Field",
- "desc" : "(optional)",
- "isOptional" : false
- },
- {
- "name" : "field2",
- "type" : "Field",
- "desc" : "(optional)",
- "isOptional" : false
- },
- {
- "name" : "etc",
- "type" : "Field",
- "desc" : "(optional)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "",
- "desc" : "FieldSet The fieldset container object"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "findField",
+ "name" : "getId",
"type" : "function",
- "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName",
- "sig" : "(id)",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The value to search for",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "",
- "desc" : "Field"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "findbyId",
+ "name" : "getName",
"type" : "function",
- "desc" : "Find any element that has been added to a form, using it's ID or name\nThis can include framesets, columns etc. along with regular fields..",
- "sig" : "(id)",
+ "desc" : "Returns the name attribute of the field if available",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String",
- "desc" : "- id or name to find.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Element",
- "desc" : "e - or false if nothing found."
+ "type" : "String",
+ "desc" : "name The field name"
}
]
},
{
- "name" : "fireEvent",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Gets the current XY position of the component's underlying element.",
+ "sig" : "(local)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "Array",
+ "desc" : "The XY position of the element (e.g., [100, 200])"
}
]
},
{
- "name" : "getFieldValues",
+ "name" : "getRawValue",
"type" : "function",
- "desc" : "Returns the fields in this form as an object with key/value pairs. \nThis differs from getValues as it calls getValue on each child item, rather than using dom data.\nNormally this will not return readOnly data",
- "sig" : "(with_readonly)",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "with_readonly",
- "type" : "Boolean",
- "desc" : "return readonly field data.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : ""
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
]
},
{
- "name" : "getValues",
+ "name" : "getSize",
"type" : "function",
- "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.",
- "sig" : "(asString)",
+ "desc" : "Gets the current size of the component's underlying element.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "asString",
- "type" : "Boolean",
- "desc" : "(def)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
"type" : "Object",
- "desc" : ""
+ "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
}
]
},
{
- "name" : "hasChanged",
+ "name" : "getValue",
"type" : "function",
- "desc" : "Returns true if any fields in this form have changed since their original load. (New version)",
+ "desc" : "Returns the checked state of the checkbox.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.form.Checkbox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "",
- "desc" : "Boolean"
+ "type" : "Boolean",
+ "desc" : "True if checked, else false"
}
]
},
+ {
+ "name" : "hasChanged",
+ "type" : "function",
+ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "hasListener",
"type" : "function",
]
},
{
- "name" : "invalidFields",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns array of invalid form fields.",
+ "desc" : "Hide this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "",
- "desc" : "Array"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
"name" : "isDirty",
"type" : "function",
- "desc" : "DEPRICATED Returns true if any fields in this form have changed since their original load.",
+ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "",
- "desc" : "Boolean"
- }
- ]
+ "returns" : []
},
{
"name" : "isValid",
"type" : "function",
- "desc" : "Returns true if client-side validation on the form is successful.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.BasicForm",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "",
- "desc" : "Boolean"
- }
- ]
- },
- {
- "name" : "load",
- "type" : "function",
- "desc" : "Shortcut to do a load action.",
- "sig" : "(options)",
+ "desc" : "Returns whether or not the field value is currently valid",
+ "sig" : "(preventMark)",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "The options to pass to the action (see {@link #doAction} for details)",
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "True to disable marking the field invalid",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "BasicForm",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
}
]
},
{
- "name" : "loadRecord",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Loads an Roo.data.Record into this form.",
- "sig" : "(record)",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "record",
- "type" : "Record",
- "desc" : "The record to load",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
"name" : "markInvalid",
"type" : "function",
- "desc" : "Mark fields in this form invalid in bulk.",
- "sig" : "(errors)",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "errors",
- "type" : "Array/Object",
- "desc" : "Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}",
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
"name" : "on",
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "onPosition",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
+ "sig" : "(x, y)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "onResize",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
+ "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Removes a field from the items collection (does NOT remove its markup).",
- "sig" : "(field)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "field",
- "type" : "Field",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
"name" : "removeListener",
{
"name" : "render",
"type" : "function",
- "desc" : "Render this form into the passed container. This should only be called once!",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
"sig" : "(container)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "container",
"type" : "String/HTMLElement/Element",
- "desc" : "The element this component should be rendered into",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Form",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
"name" : "reset",
"type" : "function",
- "desc" : "Resets this form.",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
"name" : "resetHasChanged",
"type" : "function",
- "desc" : "Resets all hasChanged to 'false' -\nThe old 'isDirty' used 'original value..' however this breaks reset() and a few other things.\nSo hasChanged storage is only to be used for this purpose",
+ "desc" : "stores the current value in loadedValue",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "",
- "desc" : "Boolean"
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "setValues",
+ "name" : "setPagePosition",
"type" : "function",
- "desc" : "Set values for fields in this form in bulk.",
- "sig" : "(values)",
+ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
+ "sig" : "(x, y)",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "values",
- "type" : "Array/Object",
- "desc" : "Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "setPosition",
+ "type" : "function",
+ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
+ "sig" : "(left, top)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
+ "name" : "left",
+ "type" : "Number",
+ "desc" : "The new left",
+ "isOptional" : false
+ },
+ {
+ "name" : "top",
+ "type" : "Number",
+ "desc" : "The new top",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "start",
+ "name" : "setRawValue",
"type" : "function",
- "desc" : "Opens the passed container in the layout stack. The container can be any {@link Roo.form.Layout} or subclass.",
- "sig" : "(container)",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "Object",
- "desc" : "A Roo.form.Layout or subclass of Layout",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setSize",
+ "type" : "function",
+ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
+ "sig" : "(width, height)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "width",
+ "type" : "Number/Object",
+ "desc" : "The new width to set, or a size object in the format {width, height}",
+ "isOptional" : false
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height to set (not required if a size object is passed as the first arg)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Form",
+ "type" : "Roo.BoxComponent",
"desc" : "this"
}
]
},
{
- "name" : "startMonitoring",
+ "name" : "setValue",
"type" : "function",
- "desc" : "Starts monitoring of the valid state of this form. Usually this is done by passing the config\noption \"monitorValid\"",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.",
+ "sig" : "(value, suppressEvent)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Boolean/String",
+ "desc" : "- the value to set",
+ "isOptional" : false
+ },
+ {
+ "name" : "suppressEvent",
+ "type" : "Boolean/String",
+ "desc" : "- whether to suppress the checkchange event.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "stopMonitoring",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Stops monitoring of the valid state of this form",
- "sig" : "()\n{\n\n}",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "submit",
+ "name" : "show",
"type" : "function",
- "desc" : "Shortcut to do a submit action.",
- "sig" : "(options)",
+ "desc" : "Show this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "The options to pass to the action (see {@link #doAction} for details)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "BasicForm",
+ "type" : "Roo.Component",
"desc" : "this"
}
]
},
+ {
+ "name" : "syncSize",
+ "type" : "function",
+ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "un",
"type" : "function",
"returns" : []
},
{
- "name" : "updateRecord",
+ "name" : "updateBox",
"type" : "function",
- "desc" : "Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.",
- "sig" : "(record)",
+ "desc" : "Sets the current box measurements of the component's underlying element.",
+ "sig" : "(box)",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "record",
- "type" : "Record",
- "desc" : "The record to edit",
+ "name" : "box",
+ "type" : "Object",
+ "desc" : "An object in the format {x, y, width, height}",
"isOptional" : false
}
],
+ "returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "BasicForm",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
}
]
}
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.form.Column",
- "Roo.form.FieldSet",
- "Roo.form.Row",
- "Roo.form.Field",
- "Roo.form.Checkbox",
- "Roo.form.ComboBox",
- "Roo.form.ComboBoxArray",
- "Roo.form.ComboCheck",
- "Roo.form.ComboNested",
- "Roo.form.DateField",
- "Roo.form.DayPicker",
- "Roo.form.DisplayField",
- "Roo.form.FCKeditor",
- "Roo.form.GridField",
- "Roo.form.Hidden",
- "Roo.form.HtmlEditor",
- "Roo.form.MonthField",
- "Roo.form.NumberField",
- "Roo.form.Radio",
- "Roo.form.Select",
- "Roo.form.Signature",
- "Roo.form.TextArea",
- "Roo.form.TextField",
- "Roo.form.TriggerField",
- "Roo.Button",
- "Roo.SplitButton",
- "Roo.Toolbar.Button",
- "Roo.Toolbar.SplitButton",
- "Roo.form.TextItem"
- ],
+ "tree_children" : [],
"tree_parent" : []
},
- "Roo.form.GridField" : {
+ "Roo.form.Row" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "addTitle",
- "type" : "String",
- "desc" : "Text to include for adding a title.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoCreate",
- "type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fieldClass",
- "type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fieldLabel",
- "type" : "String",
- "desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "- used to restrict height of grid..",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
- },
- {
- "name" : "inputType",
- "type" : "String",
- "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelSeparator",
- "type" : "String",
- "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "msgFx",
- "type" : "String",
- "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf" : "Roo.form.Field",
+ "name" : "autoCreate",
+ "type" : "String/Object",
+ "desc" : "A DomHelper element spec used to autocreate the layout (defaults to {tag: 'div', cls: 'x-form-ct'})",
+ "memberOf" : "Roo.form.Layout",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "msgTarget",
- "type" : "String",
- "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
- "memberOf" : "Roo.form.Field",
+ "name" : "clear",
+ "type" : "Boolean",
+ "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
+ "memberOf" : "Roo.form.Layout",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "name",
+ "name" : "disableClass",
"type" : "String",
- "desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "qtip",
- "type" : "String",
- "desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field",
+ "name" : "height",
+ "type" : "Number/String",
+ "desc" : "The fixed height of the column in pixels or CSS value (defaults to \"auto\")",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "readOnly",
+ "name" : "hideLabels",
"type" : "Boolean",
- "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf" : "Roo.form.Field",
+ "desc" : "True to suppress the display of field labels in this layout (defaults to false)",
+ "memberOf" : "Roo.form.Layout",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "style",
+ "name" : "hideMode",
"type" : "String",
- "desc" : "css styles to add to component\neg. text-align:right;",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
"memberOf" : "Roo.Component",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "tabIndex",
- "type" : "Number",
- "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : "Roo.form.Field",
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)\nValid values are \"left,\" \"top\" and \"right\" (defaults to \"left",
+ "memberOf" : "Roo.form.Layout",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "left",
+ "top",
+ "right"
+ ]
},
{
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field",
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "The separator to use after field labels (defaults to ':')",
+ "memberOf" : "Roo.form.Layout",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "validationDelay",
+ "name" : "labelWidth",
"type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
+ "memberOf" : "Roo.form.Layout",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.form.Field",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field",
+ "name" : "style",
+ "type" : "String/Object/Function",
+ "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
+ "memberOf" : "Roo.form.Layout",
"isOptional" : false,
"optvals" : []
},
{
"name" : "width",
- "type" : "Number",
- "desc" : "- used to restrict width of grid..",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "xgrid",
- "type" : "Object",
- "desc" : "(xtype'd description of grid) { xtype : 'Grid', dataSource: .... }\n\n}",
+ "type" : "Number/String",
+ "desc" : "The fixed width of the column in pixels or CSS value (defaults to \"auto\")",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
],
"returns" : []
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "move",
- "type" : "function",
- "desc" : "Fires after the component is moved.",
- "sig" : "function (_self, x, y)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "resize",
- "type" : "function",
- "desc" : "Fires after the component is resized.",
- "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
- "isOptional" : false
- },
- {
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
- "isOptional" : false
- },
- {
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"methods" : [
"returns" : []
},
{
- "name" : "applyTo",
+ "name" : "addxtype",
"type" : "function",
- "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
- "sig" : "(el)",
+ "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column",
+ "sig" : "(config)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.form.Layout",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id of the node, a DOM node or an existing Element",
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.form.Field",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
"name" : "capture",
],
"returns" : []
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "getBox",
- "type" : "function",
- "desc" : "Gets the current box measurements of the component's underlying element.",
- "sig" : "(local)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "getEl",
"type" : "function",
}
]
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name attribute of the field if available",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "name The field name"
- }
- ]
- },
- {
- "name" : "getPosition",
- "type" : "function",
- "desc" : "Gets the current XY position of the component's underlying element.",
- "sig" : "(local)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Array",
- "desc" : "The XY position of the element (e.g., [100, 200])"
- }
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "getSize",
- "type" : "function",
- "desc" : "Gets the current size of the component's underlying element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
- }
- ]
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "hasChanged",
- "type" : "function",
- "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "hasListener",
"type" : "function",
}
]
},
- {
- "name" : "isDirty",
- "type" : "function",
- "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isValid",
- "type" : "function",
- "desc" : "Returns whether or not the field value is currently valid",
- "sig" : "(preventMark)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "True to disable marking the field invalid",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "onPosition",
- "type" : "function",
- "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
- "sig" : "(x, y)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "onResize",
- "type" : "function",
- "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
- "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
- "isOptional" : false
- },
- {
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
- "isOptional" : false
- },
- {
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "purgeListeners",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "resetHasChanged",
- "type" : "function",
- "desc" : "stores the current value in loadedValue",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setPagePosition",
- "type" : "function",
- "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
- "sig" : "(x, y)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setPosition",
- "type" : "function",
- "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
- "sig" : "(left, top)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "left",
- "type" : "Number",
- "desc" : "The new left",
- "isOptional" : false
- },
- {
- "name" : "top",
- "type" : "Number",
- "desc" : "The new top",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setSize",
- "type" : "function",
- "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
- "sig" : "(width, height)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "width",
- "type" : "Number/Object",
- "desc" : "The new width to set, or a size object in the format {width, height}",
- "isOptional" : false
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "The new height to set (not required if a size object is passed as the first arg)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.BoxComponent",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets the value of the item.",
- "sig" : "(either)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "either",
- "type" : "String",
- "desc" : "an object or a string..",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisible",
"type" : "function",
}
]
},
- {
- "name" : "syncSize",
- "type" : "function",
- "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "un",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "updateBox",
- "type" : "function",
- "desc" : "Sets the current box measurements of the component's underlying element.",
- "sig" : "(box)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "box",
- "type" : "Object",
- "desc" : "An object in the format {x, y, width, height}",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [],
+ "tree_children" : [
+ "Roo.form.Column",
+ "Roo.form.Row",
+ "Roo.form.Field",
+ "Roo.form.Checkbox",
+ "Roo.form.ComboBox",
+ "Roo.form.ComboBoxArray",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.FCKeditor",
+ "Roo.form.GridField",
+ "Roo.form.Hidden",
+ "Roo.form.HtmlEditor",
+ "Roo.form.MonthField",
+ "Roo.form.NumberField",
+ "Roo.form.Radio",
+ "Roo.form.Select",
+ "Roo.form.Signature",
+ "Roo.form.TextArea",
+ "Roo.form.TextField",
+ "Roo.form.TriggerField",
+ "Roo.Button",
+ "Roo.SplitButton",
+ "Roo.Toolbar.Button",
+ "Roo.Toolbar.SplitButton",
+ "Roo.form.TextItem",
+ "Roo.form.FieldSet"
+ ],
"tree_parent" : []
},
- "Roo.form.Hidden" : {
+ "Roo.form.Select" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "allQuery",
+ "type" : "String",
+ "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "allowBlank",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "alwaysQuery",
+ "type" : "Boolean",
+ "desc" : "Disable caching of results, and always send query",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "autoCreate",
- "type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
- "memberOf" : "Roo.form.Field",
+ "type" : "Boolean/Object",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "blockFocus",
+ "type" : "Boolean",
+ "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "cls",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "defaultValue",
+ "type" : "String",
+ "desc" : "The value displayed after loading the store.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "disableClass",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "disableClear",
+ "type" : "Boolean",
+ "desc" : "Disable showing of clear button.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "disableKeyFilter",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "displayField",
+ "type" : "String",
+ "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "editable",
+ "type" : "Boolean",
+ "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "emptyText",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "forceSelection",
+ "type" : "Boolean",
+ "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "grow",
"type" : "Boolean",
- "desc" : "True if this field should automatically grow and shrink to its content",
- "memberOf" : "Roo.form.TextField",
+ "desc" : "",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
"name" : "growMax",
"type" : "Number",
- "desc" : "The maximum width to allow when grow = true (defaults to 800)",
- "memberOf" : "Roo.form.TextField",
+ "desc" : "",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
"name" : "growMin",
"type" : "Number",
- "desc" : "The minimum width to allow when grow = true (defaults to 30)",
- "memberOf" : "Roo.form.TextField",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "handleHeight",
+ "type" : "Number",
+ "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "hiddenName",
+ "type" : "String",
+ "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "hideMode",
"type" : "String",
"visibility"
]
},
+ {
+ "name" : "hideTrigger",
+ "type" : "Boolean",
+ "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf" : "Roo.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "inputType",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "lazyRender",
+ "type" : "Boolean",
+ "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listAlign",
+ "type" : "String",
+ "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listWidth",
+ "type" : "Number",
+ "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "loadingText",
+ "type" : "String",
+ "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "maskRe",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "maxHeight",
+ "type" : "Number",
+ "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "maxLength",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "minChars",
+ "type" : "Number",
+ "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "minLength",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "minListWidth",
+ "type" : "Number",
+ "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "mode",
+ "type" : "String",
+ "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "msgFx",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "pageSize",
+ "type" : "Number",
+ "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "qtip",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "queryDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "queryParam",
+ "type" : "String",
+ "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "readOnly",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "resizable",
+ "type" : "Boolean",
+ "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "selectOnFocus",
"type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.form.TextField",
+ "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "selectedClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "shadow",
+ "type" : "Boolean/String",
+ "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to which this combo is bound (defaults to undefined)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tpl",
+ "type" : "String/Roo.Template",
+ "desc" : "The template to use to render the output",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "transform",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "triggerAction",
+ "type" : "String",
+ "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "triggerClass",
+ "type" : "String",
+ "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "typeAhead",
+ "type" : "Boolean",
+ "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "typeAheadDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "validateOnBlur",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "valueField",
+ "type" : "String",
+ "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "valueNotFoundText",
+ "type" : "String",
+ "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "vtype",
"type" : "String",
{
"name" : "autoSize",
"type" : "function",
- "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.",
+ "desc" : "",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "Roo.form.TriggerField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
+ {
+ "name" : "clearValue",
+ "type" : "function",
+ "desc" : "Clears any text/value currently set in the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "doQuery",
+ "type" : "function",
+ "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
+ "sig" : "(query, forceAll)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "query",
+ "type" : "String",
+ "desc" : "The SQL query to execute",
+ "isOptional" : false
+ },
+ {
+ "name" : "forceAll",
+ "type" : "Boolean",
+ "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "enable",
"type" : "function",
}
]
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
{
"name" : "getValue",
"type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "desc" : "Returns the currently selected field value or empty string if no value is set.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "String",
+ "desc" : "value The selected value"
}
]
},
"params" : [],
"returns" : []
},
+ {
+ "name" : "isExpanded",
+ "type" : "function",
+ "desc" : "Returns true if the dropdown list is expanded, else false.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "isValid",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "onTriggerClick",
+ "type" : "function",
+ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.form.TriggerField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "purgeListeners",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(index, scrollIntoView)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The zero-based index of the list item to select",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollIntoView",
+ "type" : "Boolean",
+ "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "selectByValue",
+ "type" : "function",
+ "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(value, scrollIntoView)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The data value of the item to select",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollIntoView",
+ "type" : "Boolean",
+ "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value matched an item in the list, else false"
+ }
+ ]
+ },
{
"name" : "selectText",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setEditable",
+ "type" : "function",
+ "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Boolean",
+ "desc" : "True to allow the user to directly edit the field text",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setFromData",
+ "type" : "function",
+ "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Object",
+ "desc" : "the value to set as. or false on reset?",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setPagePosition",
"type" : "function",
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
"sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [
{
"name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "type" : "String",
+ "desc" : "The value to match",
"isOptional" : false
}
],
}
]
},
+ {
+ "name" : "setWidth",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.HtmlEditor" : {
+ "Roo.form.Signature" : {
"props" : [
{
"name" : "actionMode",
"optvals" : []
},
{
- "name" : "allowComments",
- "type" : "boolean",
- "desc" : "- default false - allow comments in HTML source - by default they are stripped - if you are editing email you may need this.",
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to false)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"optvals" : []
},
{
- "name" : "autoClean",
- "type" : "boolean",
- "desc" : "- default true - loading and saving will remove quite a bit of formating,\n if you are doing an email editor, this probably needs disabling, it's designed",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "blacklist",
- "type" : "Array",
- "desc" : "of html tags - in addition to standard blacklist.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "bodyCls",
- "type" : "string",
- "desc" : "default '' default classes to add to body of editable area - usually undoreset is a good start..",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "clearUp",
- "type" : "Boolean",
- "desc" : "",
- "memberOf" : "",
+ "name" : "autoCreate",
+ "type" : "String/Object",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "enableBlocks",
- "type" : "boolean",
- "desc" : "- default true - if the block editor (table and figure should be enabled)",
- "memberOf" : "",
+ "name" : "fieldClass",
+ "type" : "String",
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "height",
"type" : "Number",
- "desc" : "(in pixels)",
+ "desc" : "The signature panel height (defaults to 100)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"visibility"
]
},
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "labelSeparator",
"type" : "String",
"optvals" : []
},
{
- "name" : "language",
- "type" : "String",
- "desc" : "default en - language of text (usefull for rtl languages)",
+ "name" : "labels",
+ "type" : "Object",
+ "desc" : "Label to use when rendering a form.\ndefaults to \nlabels : { \n clear : \"Clear\",\n confirm : \"Confirm\"\n }",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "msgFx",
+ "type" : "String",
+ "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "msgTarget",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "resizable",
- "type" : "String",
- "desc" : "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "style",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "stylesheets",
- "type" : "Array",
- "desc" : "url of stylesheets. set to [] to disable stylesheets - this is usally a good idea rootURL + '/roojs1/css/undoreset.css', .",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "tabIndex",
"type" : "Number",
"optvals" : []
},
{
- "name" : "toolbars",
- "type" : "Array",
- "desc" : "Array of toolbars. - defaults to just the Standard one",
- "memberOf" : "",
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "whitelist",
- "type" : "Array",
- "desc" : "of html tags - in addition to statndard whitelist",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "width",
"type" : "Number",
- "desc" : "(in pixels)",
+ "desc" : "The signature panel width (defaults to 300)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
- {
- "name" : "activate",
- "type" : "function",
- "desc" : "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "HtmlEditor",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "autosave",
- "type" : "function",
- "desc" : "Auto save the htmlEditor value as a file into Events",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "HtmlEditor",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforedestroy",
"type" : "function",
"returns" : []
},
{
- "name" : "beforepush",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push.",
- "sig" : "function (_self, html)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "html",
- "type" : "String",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "blur",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "desc" : "Fires when this field loses input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforesync",
+ "name" : "change",
"type" : "function",
- "desc" : "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync.",
- "sig" : "function (_self, html)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
},
{
- "name" : "html",
- "type" : "String",
- "desc" : "",
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "blur",
- "type" : "function",
- "desc" : "",
- "sig" : "function ()\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "change",
+ "name" : "confirm",
"type" : "function",
- "desc" : "",
- "sig" : "function ()\n{\n\n}",
+ "desc" : "Fires when the 'confirm' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.form.Signature",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
],
"returns" : []
},
- {
- "name" : "editmodechange",
- "type" : "function",
- "desc" : "Fires when the editor switches edit modes",
- "sig" : "function (_self, sourceEdit)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "HtmlEditor",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "sourceEdit",
- "type" : "Boolean",
- "desc" : "True if source edit, false if standard editing.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "editorevent",
- "type" : "function",
- "desc" : "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "HtmlEditor",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
"returns" : []
},
{
- "name" : "firstfocus",
+ "name" : "focus",
"type" : "function",
- "desc" : "Fires when on first focus - needed by toolbars..",
+ "desc" : "Fires when this field receives input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "",
- "sig" : "function ()\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "initialize",
- "type" : "function",
- "desc" : "Fires when the editor is fully initialized (including the iframe)",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "HtmlEditor",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "invalid",
"type" : "function",
"returns" : []
},
{
- "name" : "paste",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires when press user pastes into the editor",
+ "desc" : "Fires after the component is rendered.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.HtmlEditorCore",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "push",
+ "name" : "reset",
"type" : "function",
- "desc" : "Fires when the iframe editor is updated with content from the textarea.",
- "sig" : "function (_self, html)\n{\n\n}",
+ "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo, record)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "HtmlEditor",
- "desc" : "",
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
},
{
- "name" : "html",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "record",
+ "type" : "Roo.data.Record|false",
+ "desc" : "The data record returned from the underlying store (or false on nothing selected)",
"isOptional" : false
}
],
],
"returns" : []
},
- {
- "name" : "savedpreview",
- "type" : "function",
- "desc" : "preview the saved version of htmlEditor",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "HtmlEditor",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
{
"name" : "specialkey",
"type" : "function",
- "desc" : "",
- "sig" : "function ()\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "stylesheetsclick",
- "type" : "function",
- "desc" : "Fires when press the Sytlesheets button",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.HtmlEditorCore",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "sync",
- "type" : "function",
- "desc" : "Fires when the textarea is updated with content from the editor iframe.",
- "sig" : "function (_self, html)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
},
{
- "name" : "html",
- "type" : "String",
- "desc" : "",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
"isOptional" : false
}
],
{
"name" : "clearInvalid",
"type" : "function",
- "desc" : "Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide",
+ "desc" : "Clear any invalid styles/messages for this field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
},
+ {
+ "name" : "getConfirmed",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "this.isConfirmed"
+ }
+ ]
+ },
{
"name" : "getEl",
"type" : "function",
}
]
},
+ {
+ "name" : "getHeight",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "this.height"
+ }
+ ]
+ },
{
"name" : "getId",
"type" : "function",
}
]
},
+ {
+ "name" : "getImageDataURI",
+ "type" : "function",
+ "desc" : "when user is clicked confirm then show this image.....",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "Image Data URI"
+ }
+ ]
+ },
{
"name" : "getName",
"type" : "function",
]
},
{
- "name" : "getSelectedNode",
+ "name" : "getSize",
"type" : "function",
- "desc" : "get the Context selected node",
+ "desc" : "Gets the current size of the component's underlying element.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
+ }
+ ]
},
{
- "name" : "getSize",
+ "name" : "getValue",
"type" : "function",
- "desc" : "Gets the current size of the component's underlying element.",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
]
},
{
- "name" : "getValue",
+ "name" : "getWidth",
"type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "desc" : "",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "Number",
+ "desc" : "this.width"
}
]
},
{
"name" : "markInvalid",
"type" : "function",
- "desc" : "Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide",
- "sig" : "()\n{\n\n}",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
"params" : [],
"returns" : []
},
- {
- "name" : "toggleSourceEdit",
- "type" : "function",
- "desc" : "Toggles the editor between standard and source edit mode.",
- "sig" : "(sourceEdit)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "sourceEdit",
- "type" : "Boolean",
- "desc" : "(optional) True for source edit, false for standard",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "un",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "updateLanguage",
- "type" : "function",
- "desc" : "update the language in the body - really done by core",
- "sig" : "(language)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "language",
- "type" : "String",
- "desc" : "- eg. en / ar / zh-CN etc..",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "validate",
"type" : "function",
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.HtmlEditor.ToolbarContext" : {
+ "Roo.form.TextArea" : {
"props" : [
{
- "name" : "disable",
- "type" : "Object",
- "desc" : "List of toolbar elements to disable",
- "memberOf" : "",
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "styles",
- "type" : "Object",
- "desc" : "List of styles \n eg. { '*' : [ 'headline' ] , 'TD' : [ 'underline', 'double-underline' ] } \n\nThese must be defined in the page, so they get rendered correctly..\n.headline { }\nTD.underline { }",
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoCreate",
+ "type" : "String/Object",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"textarea\", style: \"width:300px;height:60px;\", autocomplete: \"off\"})",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "updateToolbar",
- "type" : "function",
- "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.\n\nNote you can force an update by calling on('editorevent', scope, false)",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "A CSS class to apply to the field's underlying element.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "True to disable the field (defaults to false).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "emptyText",
+ "type" : "String",
+ "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldClass",
+ "type" : "String",
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "String",
+ "desc" : "Label to use when rendering a form.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "grow",
+ "type" : "Boolean",
+ "desc" : "True if this field should automatically grow and shrink to its content",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMax",
+ "type" : "Number",
+ "desc" : "The maximum height to allow when grow = true (defaults to 1000)",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.form.HtmlEditor.ToolbarStandard" : {
- "props" : [
+ "isOptional" : false,
+ "optvals" : []
+ },
{
- "name" : "btns[]",
- "type" : "Roo.Toolbar.Item|Roo.Toolbar.Button|Roo.Toolbar.SplitButton|Roo.form.Field",
- "desc" : "List of additional buttons.\n\n\nNEEDS Extra CSS? \n.x-html-editor-tb .x-edit-none .x-btn-text { background: none; }",
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "The minimum height to allow when grow = true (defaults to 60)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "createLinkText",
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "height (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
"type" : "String",
- "desc" : "The default text for the create link prompt",
- "memberOf" : "",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "defaultFont",
+ "name" : "invalidClass",
"type" : "String",
- "desc" : "default font to use.",
- "memberOf" : "",
+ "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "defaultLinkValue",
+ "name" : "invalidText",
"type" : "String",
- "desc" : "The default value for the create link prompt (defaults to http:/ /)",
- "memberOf" : "",
+ "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disable",
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listeners",
"type" : "Object",
- "desc" : "List of elements to disable..",
- "memberOf" : "",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "fontFamilies",
- "type" : "Array",
- "desc" : "An array of available font families",
- "memberOf" : "",
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.form.TextField",
"isOptional" : false,
"optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "updateToolbar",
- "type" : "function",
- "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.form.Layout" : {
- "props" : [
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
- "name" : "actionMode",
+ "name" : "maxLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "msgFx",
+ "type" : "String",
+ "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "msgTarget",
+ "type" : "String",
+ "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "name",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
+ "desc" : "The field's HTML name attribute.",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "allowDomMove",
+ "name" : "preventScrollbars",
"type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
+ "desc" : "True to prevent scrollbars from appearing regardless of how much text is\nin the field (equivalent to setting overflow: hidden, defaults to false)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "autoCreate",
- "type" : "String/Object",
- "desc" : "A DomHelper element spec used to autocreate the layout (defaults to {tag: 'div', cls: 'x-form-ct'})",
- "memberOf" : "",
+ "name" : "qtip",
+ "type" : "String",
+ "desc" : "Mouse over tip",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "clear",
+ "name" : "readOnly",
"type" : "Boolean",
- "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
- "memberOf" : "",
+ "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disableClass",
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regexText",
"type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
+ "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.form.TextField",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hideLabels",
+ "name" : "selectOnFocus",
"type" : "Boolean",
- "desc" : "True to suppress the display of field labels in this layout (defaults to false)",
- "memberOf" : "",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.form.TextField",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hideMode",
+ "name" : "style",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "desc" : "css styles to add to component\neg. text-align:right;",
"memberOf" : "Roo.Component",
"isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
+ "optvals" : []
},
{
- "name" : "labelAlign",
- "type" : "String",
- "desc" : "t)\nValid values are \"left,\" \"top\" and \"right\" (defaults to \"left",
- "memberOf" : "",
+ "name" : "tabIndex",
+ "type" : "Number",
+ "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
- "optvals" : [
- "left",
- "top",
- "right"
- ]
+ "optvals" : []
},
{
- "name" : "labelSeparator",
- "type" : "String",
- "desc" : "The separator to use after field labels (defaults to ':')",
- "memberOf" : "",
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "labelWidth",
+ "name" : "validationDelay",
"type" : "Number",
- "desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
- "memberOf" : "",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "style",
- "type" : "String/Object/Function",
- "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
- "memberOf" : "",
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "A value to initialize this field with.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "width (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
+ {
+ "name" : "autosize",
+ "type" : "function",
+ "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
+ "sig" : "function (_self, width)\n{\n\n}",
+ "memberOf" : "Roo.form.TextField",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "This text field",
+ "isOptional" : false
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The new field width",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "move",
+ "type" : "function",
+ "desc" : "Fires after the component is moved.",
+ "sig" : "function (_self, x, y)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "resize",
+ "type" : "function",
+ "desc" : "Fires after the component is resized.",
+ "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
"returns" : []
},
{
- "name" : "addxtype",
+ "name" : "applyTo",
"type" : "function",
- "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column",
- "sig" : "(config)",
+ "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "config",
- "type" : "Object",
- "desc" : "",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id of the node, a DOM node or an existing Element",
"isOptional" : false
}
],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.form.Field",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "Automatically grows the field to accomodate the height of the text up to the maximum field height allowed.\nThis only takes effect if grow = true, and fires the autosize event if the height changes.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "getBox",
+ "type" : "function",
+ "desc" : "Gets the current box measurements of the component's underlying element.",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "getEl",
"type" : "function",
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name attribute of the field if available",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "name The field name"
+ }
+ ]
+ },
+ {
+ "name" : "getPosition",
+ "type" : "function",
+ "desc" : "Gets the current XY position of the component's underlying element.",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "The XY position of the element (e.g., [100, 200])"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getSize",
+ "type" : "function",
+ "desc" : "Gets the current size of the component's underlying element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "hasChanged",
+ "type" : "function",
+ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "hasListener",
"type" : "function",
}
]
},
+ {
+ "name" : "isDirty",
+ "type" : "function",
+ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isValid",
+ "type" : "function",
+ "desc" : "Returns whether or not the field value is currently valid",
+ "sig" : "(preventMark)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "True to disable marking the field invalid",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "onPosition",
+ "type" : "function",
+ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
+ "sig" : "(x, y)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "onResize",
+ "type" : "function",
+ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
+ "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "purgeListeners",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "resetHasChanged",
+ "type" : "function",
+ "desc" : "stores the current value in loadedValue",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "selectText",
+ "type" : "function",
+ "desc" : "Selects text in this field",
+ "sig" : "(start, end)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "start",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should start (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "end",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should end (defaults to the text length)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setPagePosition",
+ "type" : "function",
+ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
+ "sig" : "(x, y)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setPosition",
+ "type" : "function",
+ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
+ "sig" : "(left, top)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "left",
+ "type" : "Number",
+ "desc" : "The new left",
+ "isOptional" : false
+ },
+ {
+ "name" : "top",
+ "type" : "Number",
+ "desc" : "The new top",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setSize",
+ "type" : "function",
+ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
+ "sig" : "(width, height)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "width",
+ "type" : "Number/Object",
+ "desc" : "The new width to set, or a size object in the format {width, height}",
+ "isOptional" : false
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height to set (not required if a size object is passed as the first arg)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.BoxComponent",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisible",
"type" : "function",
}
]
},
+ {
+ "name" : "syncSize",
+ "type" : "function",
+ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "un",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "updateBox",
+ "type" : "function",
+ "desc" : "Sets the current box measurements of the component's underlying element.",
+ "sig" : "(box)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "box",
+ "type" : "Object",
+ "desc" : "An object in the format {x, y, width, height}",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [
- "Roo.form.Column",
- "Roo.form.FieldSet",
- "Roo.form.Row"
- ],
- "tree_children" : [
- "Roo.form.Column",
- "Roo.form.Row",
- "Roo.form.Field",
- "Roo.form.Checkbox",
- "Roo.form.ComboBox",
- "Roo.form.ComboBoxArray",
- "Roo.form.ComboCheck",
- "Roo.form.ComboNested",
- "Roo.form.DateField",
- "Roo.form.DayPicker",
- "Roo.form.DisplayField",
- "Roo.form.FCKeditor",
- "Roo.form.GridField",
- "Roo.form.Hidden",
- "Roo.form.HtmlEditor",
- "Roo.form.MonthField",
- "Roo.form.NumberField",
- "Roo.form.Radio",
- "Roo.form.Select",
- "Roo.form.Signature",
- "Roo.form.TextArea",
- "Roo.form.TextField",
- "Roo.form.TriggerField",
- "Roo.Button",
- "Roo.SplitButton",
- "Roo.Toolbar.Button",
- "Roo.Toolbar.SplitButton",
- "Roo.form.TextItem",
- "Roo.form.FieldSet"
+ "Roo.form.FCKeditor"
],
+ "tree_children" : [],
"tree_parent" : []
},
- "Roo.form.MonthField" : {
+ "Roo.form.TextField" : {
"props" : [
{
"name" : "actionMode",
"name" : "allowBlank",
"type" : "Boolean",
"desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"name" : "allowLeadingSpace",
"type" : "Boolean",
"desc" : "True to prevent the stripping of leading white space",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "altFormats",
- "type" : "String",
- "desc" : "Multiple date formats separated by \"|\" to try when parsing a user input value and it doesn't match the defined\nformat (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d').",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
{
"name" : "autoCreate",
"type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"10\", autocomplete: \"off\"})",
- "memberOf" : "",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
"name" : "blankText",
"type" : "String",
"desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"name" : "disableKeyFilter",
"type" : "Boolean",
"desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "disabledDates",
- "type" : "Array",
- "desc" : "An array of \"dates\" to disable, as strings. These strings will be used to build a dynamic regular\nexpression so they are very powerful. Some examples:\n<ul>\n<li>[\"03/08/2003\", \"09/16/2003\"] would disable those exact dates</li>\n<li>[\"03/08\", \"09/16\"] would disable those days for every year</li>\n<li>[\"^03/08\"] would only match the beginning (useful if you are using short years)</li>\n<li>[\"03/../2006\"] would disable every day in March 2006</li>\n<li>[\"^03\"] would disable every day in every March</li>\n</ul>\nIn order to support regular expressions, if you are using a date format that has \".\" in it, you will have to\nescape the dot when restricting dates. For example: [\"03\\\\.08\\\\.03\"].",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabledDatesText",
- "type" : "String",
- "desc" : "The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabledDays",
- "type" : "Array",
- "desc" : "An array of days to disable, 0 based. For example, [0, 6] disables Sunday and Saturday (defaults to null).",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabledDaysText",
- "type" : "String",
- "desc" : "The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "emptyText",
"type" : "String",
"desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "format",
- "type" : "String",
- "desc" : "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').",
+ "name" : "grow",
+ "type" : "Boolean",
+ "desc" : "True if this field should automatically grow and shrink to its content",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMax",
+ "type" : "Number",
+ "desc" : "The maximum width to allow when grow = true (defaults to 800)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "The minimum width to allow when grow = true (defaults to 30)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"visibility"
]
},
- {
- "name" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "Roo.form.TriggerField",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "inputType",
"type" : "String",
{
"name" : "invalidText",
"type" : "String",
- "desc" : "The error text to display when the date in the field is invalid (defaults to\n'{value} is not a valid date - it must be in the format {format}').",
- "memberOf" : "",
+ "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
"name" : "maskRe",
"type" : "String",
"desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"name" : "maxLength",
"type" : "Number",
"desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"name" : "maxLengthText",
"type" : "String",
"desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxTextf",
- "type" : "String",
- "desc" : "The error text to display when the date in the cell is after maxValue (defaults to\n'The date in this field must be before {maxValue}').",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxValue",
- "type" : "Date/String",
- "desc" : "The maximum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"name" : "minLength",
"type" : "Number",
"desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"name" : "minLengthText",
"type" : "String",
"desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minText",
- "type" : "String",
- "desc" : "The error text to display when the date in the cell is before minValue (defaults to\n'The date in this field must be after {minValue}').",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minValue",
- "type" : "Date/String",
- "desc" : "The minimum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"name" : "regex",
"type" : "RegExp",
"desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"name" : "regexText",
"type" : "String",
"desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"name" : "selectOnFocus",
"type" : "Boolean",
"desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "triggerClass",
- "type" : "String",
- "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-date-trigger'\nwhich displays a calendar icon).",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "useIso",
- "type" : "Boolean",
- "desc" : "if enabled, then the date field will use a hidden field to store the \nreal value as iso formated date. default (true)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "validateOnBlur",
"type" : "Boolean",
"name" : "validator",
"type" : "Function",
"desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"name" : "vtype",
"type" : "String",
"desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"type" : "function",
"desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
"sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
],
"returns" : []
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when a date is selected",
- "sig" : "function (combo, date)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.MonthFieeld",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "date",
- "type" : "Date",
- "desc" : "The date selected",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
{
"name" : "autoSize",
"type" : "function",
- "desc" : "",
+ "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.TriggerField",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "getValue",
"type" : "function",
- "desc" : "Returns the current date value of the date field.",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Date",
- "desc" : "The date value"
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
]
},
],
"returns" : []
},
- {
- "name" : "onTriggerClick",
- "type" : "function",
- "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.form.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "purgeListeners",
"type" : "function",
"desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Selects text in this field",
"sig" : "(start, end)",
"static" : false,
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets the value of the date field. You can pass a date object or any string that can be parsed into a valid\ndate, using MonthField.format as the date format, according to the same rules as {@link Date#parseDate}\n(the default format used is \"m/d/y\").\n<br />Usage:\n<pre><code>\n//All of these calls set the same date value (May 4, 2006)\n\n//Pass a date object:\nvar dt = new Date('5/4/06');\nmonthField.setValue(dt);\n\n//Pass a date string (default format):\nmonthField.setValue('5/4/06');\n\n//Pass a date string (custom format):\nmonthField.format = 'Y-m-d';\nmonthField.setValue('2006-5-4');\n</code></pre>",
- "sig" : "(date)",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "date",
- "type" : "String/Date",
- "desc" : "The date or valid date string",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
"isOptional" : false
}
],
"desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
"sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
+ "implementations" : [
+ "Roo.form.ComboBox",
+ "Roo.form.ComboBoxArray",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.FCKeditor",
+ "Roo.form.Hidden",
+ "Roo.form.MonthField",
+ "Roo.form.NumberField",
+ "Roo.form.Select",
+ "Roo.form.TextArea",
+ "Roo.form.TriggerField"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.NumberField" : {
+ "Roo.form.TextItem" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowDecimals",
- "type" : "Boolean",
- "desc" : "False to disallow decimal values (defaults to true)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "allowLeadingSpace",
- "type" : "Boolean",
- "desc" : "True to prevent the stripping of leading white space",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowNegative",
- "type" : "Boolean",
- "desc" : "False to prevent entering a negative sign (defaults to true)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoCreate",
- "type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "decimalPrecision",
- "type" : "Number",
- "desc" : "The maximum precision to display after the decimal separator (defaults to 2)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "decimalSeparator",
- "type" : "String",
- "desc" : "Character(s) to allow as the decimal separator (defaults to '.')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "disableClass",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "emptyText",
- "type" : "String",
- "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fieldClass",
- "type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field x-form-num-field\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fieldLabel",
- "type" : "String",
- "desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "grow",
- "type" : "Boolean",
- "desc" : "True if this field should automatically grow and shrink to its content",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "growMax",
- "type" : "Number",
- "desc" : "The maximum width to allow when grow = true (defaults to 800)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "growMin",
- "type" : "Number",
- "desc" : "The minimum width to allow when grow = true (defaults to 30)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "height",
"type" : "Number",
]
},
{
- "name" : "inputType",
- "type" : "String",
- "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelSeparator",
+ "name" : "html",
"type" : "String",
- "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
- "memberOf" : "Roo.form.Field",
+ "desc" : "the content for this item",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxText",
- "type" : "String",
- "desc" : "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxValue",
- "type" : "Number",
- "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minText",
- "type" : "String",
- "desc" : "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minValue",
- "type" : "Number",
- "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "msgFx",
- "type" : "String",
- "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "msgTarget",
- "type" : "String",
- "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "name",
- "type" : "String",
- "desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "nanText",
- "type" : "String",
- "desc" : "Error text to display if the value is not a valid number. For example, this can happen\nif a valid character like '.' or '-' is left in the field with no number (defaults to \"{value} is not a valid number\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "qtip",
- "type" : "String",
- "desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "style",
"type" : "String",
"optvals" : []
},
{
- "name" : "tabIndex",
- "type" : "Number",
- "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "vtype",
+ "name" : "tag",
"type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.form.TextField",
+ "desc" : "the tag for this item (default div)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
}
],
"events" : [
- {
- "name" : "autosize",
- "type" : "function",
- "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
- "sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : "Roo.form.TextField",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "This text field",
- "isOptional" : false
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The new field width",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "move",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"methods" : [
],
"returns" : []
},
- {
- "name" : "applyTo",
- "type" : "function",
- "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
- "sig" : "(el)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id of the node, a DOM node or an existing Element",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.form.Field",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name attribute of the field if available",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "name The field name"
- }
- ]
- },
{
"name" : "getPosition",
"type" : "function",
}
]
},
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
{
"name" : "getSize",
"type" : "function",
}
]
},
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "hasChanged",
- "type" : "function",
- "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "hasListener",
"type" : "function",
}
]
},
- {
- "name" : "isDirty",
- "type" : "function",
- "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isValid",
- "type" : "function",
- "desc" : "Returns whether or not the field value is currently valid",
- "sig" : "(preventMark)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "True to disable marking the field invalid",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "resetHasChanged",
- "type" : "function",
- "desc" : "stores the current value in loadedValue",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "selectText",
- "type" : "function",
- "desc" : "Selects text in this field",
- "sig" : "(start, end)",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "start",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should start (defaults to 0)",
- "isOptional" : false
- },
- {
- "name" : "end",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should end (defaults to the text length)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setSize",
"type" : "function",
}
]
},
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisible",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.Radio" : {
+ "Roo.form.TriggerField" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"optvals" : []
},
{
- "name" : "autoCreate",
- "type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
- "memberOf" : "Roo.form.Checkbox",
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "boxLabel",
- "type" : "String",
- "desc" : "The text that appears beside the checkbox",
- "memberOf" : "Roo.form.Checkbox",
+ "name" : "autoCreate",
+ "type" : "String/Object",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"16\", autocomplete: \"off\"})",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "checked",
- "type" : "Boolean",
- "desc" : "True if the the checkbox should render already checked (defaults to false)",
- "memberOf" : "Roo.form.Checkbox",
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.form.TextField",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "disabled",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "emptyText",
+ "type" : "String",
+ "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "fieldClass",
"type" : "String",
- "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Checkbox",
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
{
"name" : "focusClass",
"type" : "String",
- "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
- "memberOf" : "Roo.form.Checkbox",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
]
},
{
- "name" : "inputType",
- "type" : "String",
- "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field",
+ "name" : "hideTrigger",
+ "type" : "Boolean",
+ "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "inputValue",
+ "name" : "inputType",
"type" : "String",
- "desc" : "The value that should go into the generated input element's value attribute",
- "memberOf" : "Roo.form.Checkbox",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "Roo.form.Field",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "msgFx",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "style",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "triggerClass",
+ "type" : "String",
+ "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "validateOnBlur",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "value",
"type" : "Mixed",
"optvals" : []
},
{
- "name" : "valueOff",
+ "name" : "vtype",
"type" : "String",
- "desc" : "The value that should go into the generated input element's value when unchecked.",
- "memberOf" : "Roo.form.Checkbox",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.form.TextField",
"isOptional" : false,
"optvals" : []
},
}
],
"events" : [
+ {
+ "name" : "autosize",
+ "type" : "function",
+ "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
+ "sig" : "function (_self, width)\n{\n\n}",
+ "memberOf" : "Roo.form.TextField",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "This text field",
+ "isOptional" : false
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The new field width",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "check",
- "type" : "function",
- "desc" : "Fires when the checkbox is checked or unchecked.",
- "sig" : "function (_self, checked)\n{\n\n}",
- "memberOf" : "Roo.form.Checkbox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Checkbox",
- "desc" : "This checkbox",
- "isOptional" : false
- },
- {
- "name" : "checked",
- "type" : "Boolean",
- "desc" : "The new checked value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
}
]
},
- {
- "name" : "getGroupValue",
- "type" : "function",
- "desc" : "If this radio is part of a group, it will return the selected value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
- },
{
"name" : "getId",
"type" : "function",
{
"name" : "getValue",
"type" : "function",
- "desc" : "Returns the checked state of the checkbox.",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Checkbox",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if checked, else false"
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
]
},
],
"returns" : []
},
+ {
+ "name" : "onTriggerClick",
+ "type" : "function",
+ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "purgeListeners",
"type" : "function",
{
"name" : "reset",
"type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.form.TextField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
+ {
+ "name" : "selectText",
+ "type" : "function",
+ "desc" : "Selects text in this field",
+ "sig" : "(start, end)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "start",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should start (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "end",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should end (defaults to the text length)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.",
- "sig" : "(value, suppressEvent)",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [
{
"name" : "value",
- "type" : "Boolean/String",
- "desc" : "- the value to set",
- "isOptional" : false
- },
- {
- "name" : "suppressEvent",
- "type" : "Boolean/String",
- "desc" : "- whether to suppress the checkchange event.",
+ "type" : "Mixed",
+ "desc" : "The value to set",
"isOptional" : false
}
],
"desc" : "True if the value is valid, else false"
}
]
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.form.Row" : {
- "props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoCreate",
- "type" : "String/Object",
- "desc" : "A DomHelper element spec used to autocreate the layout (defaults to {tag: 'div', cls: 'x-form-ct'})",
- "memberOf" : "Roo.form.Layout",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "clear",
- "type" : "Boolean",
- "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
- "memberOf" : "Roo.form.Layout",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "height",
- "type" : "Number/String",
- "desc" : "The fixed height of the column in pixels or CSS value (defaults to \"auto\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideLabels",
- "type" : "Boolean",
- "desc" : "True to suppress the display of field labels in this layout (defaults to false)",
- "memberOf" : "Roo.form.Layout",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
},
{
- "name" : "labelAlign",
- "type" : "String",
- "desc" : "t)\nValid values are \"left,\" \"top\" and \"right\" (defaults to \"left",
- "memberOf" : "Roo.form.Layout",
- "isOptional" : false,
- "optvals" : [
- "left",
- "top",
- "right"
- ]
- },
- {
- "name" : "labelSeparator",
- "type" : "String",
- "desc" : "The separator to use after field labels (defaults to ':')",
- "memberOf" : "Roo.form.Layout",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
- "memberOf" : "Roo.form.Layout",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "style",
- "type" : "String/Object/Function",
- "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
- "memberOf" : "Roo.form.Layout",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "width",
- "type" : "Number/String",
- "desc" : "The fixed width of the column in pixels or CSS value (defaults to \"auto\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "beforedestroy",
+ "name" : "validateValue",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
"isOptional" : false
}
],
- "returns" : []
- },
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.form.ComboBox",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.MonthField",
+ "Roo.form.Select"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.form.VTypes" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "beforehide",
+ "name" : "alpha",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "The function used to validate alpha values",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The value",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "alphanum",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "The function used to validate alphanumeric values",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The value",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "email",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "The function used to validate email addresses",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The email address",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "url",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "The function used to validate URLs",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The URL",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "urlWeb",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "The funciton used to validate URLs (only allow schemes 'https' and 'http')",
+ "sig" : "(v)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "v",
+ "type" : "String",
+ "desc" : "The URL",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.grid" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.grid.AbstractGridView" : {
+ "props" : [
{
- "name" : "enable",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "hide",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "capture",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "eventName",
+ "type" : "String",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
}
],
- "returns" : []
- }
- ],
- "methods" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
+ },
{
- "name" : "addEvents",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "addListener",
+ "name" : "on",
"type" : "function",
- "desc" : "Appends an event handler to this component",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
"sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
{
"name" : "options",
"type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addxtype",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column",
- "sig" : "(config)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Layout",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "config",
- "type" : "Object",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
"memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "fn",
+ "name" : "handler",
"type" : "Function",
- "desc" : "The function to call",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "setCSSStyle",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Set a css style for a column dynamically.",
+ "sig" : "(colIndex, name, value)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "colIndex",
+ "type" : "Number",
+ "desc" : "The index of the column",
+ "isOptional" : false
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The css property name",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The css value",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "un",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
- },
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : true,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.grid.AbstractSelectionModel" : {
+ "props" : [
{
- "name" : "enable",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "focus",
+ "name" : "capture",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getEl",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "getId",
- "type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ ],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
]
},
{
- "name" : "hide",
+ "name" : "isLocked",
"type" : "function",
- "desc" : "Hide this component.",
+ "desc" : "Returns true if the selections are locked.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : ""
}
]
},
{
- "name" : "isVisible",
+ "name" : "lock",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
+ "desc" : "Locks the selections.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "The Observable to release",
"isOptional" : false
}
- ],
- "returns" : []
- },
- {
- "name" : "removeListener",
- "type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setDisabled",
- "type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ ],
+ "returns" : []
},
{
- "name" : "show",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Show this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
"name" : "un",
}
],
"returns" : []
+ },
+ {
+ "name" : "unlock",
+ "type" : "function",
+ "desc" : "Unlocks the selections.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
}
],
- "isAbstract" : false,
+ "isAbstract" : true,
"isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [
- "Roo.form.Column",
- "Roo.form.Row",
- "Roo.form.Field",
- "Roo.form.Checkbox",
- "Roo.form.ComboBox",
- "Roo.form.ComboBoxArray",
- "Roo.form.ComboCheck",
- "Roo.form.ComboNested",
- "Roo.form.DateField",
- "Roo.form.DayPicker",
- "Roo.form.DisplayField",
- "Roo.form.FCKeditor",
- "Roo.form.GridField",
- "Roo.form.Hidden",
- "Roo.form.HtmlEditor",
- "Roo.form.MonthField",
- "Roo.form.NumberField",
- "Roo.form.Radio",
- "Roo.form.Select",
- "Roo.form.Signature",
- "Roo.form.TextArea",
- "Roo.form.TextField",
- "Roo.form.TriggerField",
- "Roo.Button",
- "Roo.SplitButton",
- "Roo.Toolbar.Button",
- "Roo.Toolbar.SplitButton",
- "Roo.form.TextItem",
- "Roo.form.FieldSet"
+ "implementations" : [
+ "Roo.grid.CellSelectionModel",
+ "Roo.grid.RowSelectionModel"
],
+ "tree_children" : [],
"tree_parent" : []
},
- "Roo.form.Select" : {
+ "Roo.grid.Calendar" : {
"props" : [
{
- "name" : "actionMode",
+ "name" : "autoExpandColumn",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
+ "desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "allQuery",
- "type" : "String",
- "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
- "memberOf" : "",
+ "name" : "autoExpandMax",
+ "type" : "Number",
+ "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.form.TextField",
+ "name" : "autoExpandMin",
+ "type" : "Number",
+ "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "allowDomMove",
+ "name" : "autoHeight",
"type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
+ "desc" : "True to fit the height of the grid container to the height of the data. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "allowLeadingSpace",
+ "name" : "autoSizeColumns",
"type" : "Boolean",
- "desc" : "True to prevent the stripping of leading white space",
- "memberOf" : "Roo.form.TextField",
+ "desc" : "True to automatically resize the columns to fit their content\n<b>on initial render.</b> It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "alwaysQuery",
+ "name" : "autoSizeHeaders",
"type" : "Boolean",
- "desc" : "Disable caching of results, and always send query",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoCreate",
- "type" : "Boolean/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
- "memberOf" : "",
+ "desc" : "True to measure headers with column data when auto sizing columns. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.form.TextField",
+ "name" : "autoWidth",
+ "type" : "Boolean",
+ "desc" : "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "blockFocus",
- "type" : "Boolean",
- "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
- "memberOf" : "",
+ "name" : "cm[]",
+ "type" : "Roo.grid.ColumnModel",
+ "desc" : "The columns of the grid",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "cls",
+ "name" : "ddGroup",
"type" : "String",
- "desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field",
+ "desc" : "- drag drop group.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "defaultValue",
+ "name" : "ddText",
"type" : "String",
- "desc" : "The value displayed after loading the store.",
- "memberOf" : "",
+ "desc" : "Configures the text is the drag proxy (defaults to \"%0 selected row(s)\").\n%0 is replaced with the number of selected rows.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disableClass",
+ "name" : "dragGroup",
"type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
+ "desc" : "- drag group (?? not sure if needed.)",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disableClear",
- "type" : "Boolean",
- "desc" : "Disable showing of clear button.",
- "memberOf" : "",
+ "name" : "dropTarget",
+ "type" : "Roo.dd.DropTarget",
+ "desc" : "An {@link Roo.dd.DropTarget} config",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.form.TextField",
+ "name" : "ds",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store for the grid",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disabled",
+ "name" : "enableColumnHide",
"type" : "Boolean",
- "desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "displayField",
- "type" : "String",
- "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
- "memberOf" : "",
+ "desc" : "True to enable hiding of columns with the header context menu. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "editable",
+ "name" : "enableColumnMove",
"type" : "Boolean",
- "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "emptyText",
- "type" : "String",
- "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField",
+ "desc" : "True to enable drag and drop reorder of columns. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "fieldClass",
- "type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field",
+ "name" : "enableDrag",
+ "type" : "Boolean",
+ "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "fieldLabel",
- "type" : "String",
- "desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field",
+ "name" : "enableDragDrop",
+ "type" : "Boolean",
+ "desc" : "True to enable drag and drop of rows. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field",
+ "name" : "enableDrop",
+ "type" : "Boolean",
+ "desc" : "True to enable drop of elements. Default is false. (double check if this is needed?)",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "forceSelection",
+ "name" : "enableRowHeightSync",
"type" : "Boolean",
- "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
- "memberOf" : "",
+ "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "grow",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "eventStore",
+ "type" : "Store",
+ "desc" : "The store that loads events.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "growMax",
- "type" : "Number",
- "desc" : "",
- "memberOf" : "",
+ "name" : "footer",
+ "type" : "Roo.PagingToolbar",
+ "desc" : "the paging toolbar",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "growMin",
- "type" : "Number",
- "desc" : "",
- "memberOf" : "",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "handleHeight",
- "type" : "Number",
- "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
- "memberOf" : "",
+ "name" : "loadMask",
+ "type" : "Object",
+ "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "height",
+ "name" : "maxHeight",
"type" : "Number",
- "desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent",
+ "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hiddenName",
- "type" : "String",
- "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
- "memberOf" : "",
+ "name" : "maxRowsToMeasure",
+ "type" : "Boolean",
+ "desc" : "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
+ "name" : "minColumnWidth",
+ "type" : "Number",
+ "desc" : "The minimum width a column can be resized to. Default is 25.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
+ "optvals" : []
},
{
- "name" : "hideTrigger",
+ "name" : "monitorWindowResize",
"type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "Roo.form.TriggerField",
+ "desc" : "True to autoSize the grid when the window resizes. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "inputType",
- "type" : "String",
- "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field",
+ "name" : "sm",
+ "type" : "Roo.grid.AbstractSelectionModel",
+ "desc" : "The selection Model (default = Roo.grid.RowSelectionModel)",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field",
+ "name" : "sortColMenu",
+ "type" : "boolean",
+ "desc" : "Sort the column order menu when it shows (usefull for long lists..) default false",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : "Roo.form.Field",
+ "name" : "stripeRows",
+ "type" : "Boolean",
+ "desc" : "True to stripe the rows. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "labelSeparator",
- "type" : "String",
- "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
- "memberOf" : "Roo.form.Field",
+ "name" : "toolbar",
+ "type" : "Roo.Toolbar",
+ "desc" : "a toolbar for buttons etc.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "lazyRender",
+ "name" : "trackMouseOver",
"type" : "Boolean",
- "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
- "memberOf" : "",
+ "desc" : "True to highlight rows when the mouse is over. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "listAlign",
- "type" : "String",
- "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
- "memberOf" : "",
+ "name" : "view",
+ "type" : "Roo.grid.GridView",
+ "desc" : "The view that renders the grid (default = Roo.grid.GridView)",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
- },
+ }
+ ],
+ "events" : [
{
- "name" : "listClass",
- "type" : "String",
- "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
+ "name" : "bodyscroll",
+ "type" : "function",
+ "desc" : "Fires when the body element is scrolled",
+ "sig" : "function (scrollLeft, scrollTop)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "scrollLeft",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollTop",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "listWidth",
- "type" : "Number",
- "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
+ "name" : "cellclick",
+ "type" : "function",
+ "desc" : "Fires when a cell is clicked",
+ "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "loadingText",
- "type" : "String",
- "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
+ "name" : "cellcontextmenu",
+ "type" : "function",
+ "desc" : "Fires when a cell is right clicked",
+ "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "cellIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "maxHeight",
- "type" : "Number",
- "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
+ "name" : "celldblclick",
+ "type" : "function",
+ "desc" : "Fires when a cell is double clicked",
+ "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "minChars",
- "type" : "Number",
- "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
+ "name" : "click",
+ "type" : "function",
+ "desc" : "The raw click event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "minListWidth",
- "type" : "Number",
- "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
+ "name" : "columnmove",
+ "type" : "function",
+ "desc" : "Fires when the user moves a column",
+ "sig" : "function (oldIndex, newIndex)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "oldIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "mode",
- "type" : "String",
- "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
+ "name" : "columnresize",
+ "type" : "function",
+ "desc" : "Fires when the user resizes a column",
+ "sig" : "function (columnIndex, newSize)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "msgFx",
- "type" : "String",
- "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "msgTarget",
- "type" : "String",
- "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "name",
- "type" : "String",
- "desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "pageSize",
- "type" : "Number",
- "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
+ "name" : "contextmenu",
+ "type" : "function",
+ "desc" : "The raw contextmenu event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "qtip",
- "type" : "String",
- "desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "queryDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
+ "name" : "dblclick",
+ "type" : "function",
+ "desc" : "The raw dblclick event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "queryParam",
- "type" : "String",
- "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
+ "name" : "dragdrop",
+ "type" : "function",
+ "desc" : "Fires when dragged row(s) are dropped on a valid DD target",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "resizable",
- "type" : "Boolean",
- "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
+ "name" : "dragenter",
+ "type" : "function",
+ "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
+ "name" : "dragout",
+ "type" : "function",
+ "desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "selectedClass",
- "type" : "String",
- "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
+ "name" : "dragover",
+ "type" : "function",
+ "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "shadow",
- "type" : "Boolean/String",
- "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
+ "name" : "enddrag",
+ "type" : "function",
+ "desc" : "Fires when a drag operation is complete",
+ "sig" : "function (_self, dd, e)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to which this combo is bound (defaults to undefined)",
+ "name" : "eventclick",
+ "type" : "function",
+ "desc" : "Fires when the mouse click an",
+ "sig" : "function (_self, )\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "css styles to add to component\neg. text-align:right;",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Calendar",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "",
+ "type" : "event",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "tabIndex",
- "type" : "Number",
- "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
+ "name" : "evententer",
+ "type" : "function",
+ "desc" : "Fires when mouse over an event",
+ "sig" : "function (_self, Event)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Calendar",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "Event",
+ "type" : "event",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "title",
- "type" : "String",
- "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
+ "name" : "eventleave",
+ "type" : "function",
+ "desc" : "Fires when the mouse leaves an",
+ "sig" : "function (_self, )\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Calendar",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "",
+ "type" : "event",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "tpl",
- "type" : "String/Roo.Template",
- "desc" : "The template to use to render the output",
+ "name" : "eventrender",
+ "type" : "function",
+ "desc" : "Fires before each cell is rendered, so you can modify the contents, like cls / title / qtip",
+ "sig" : "function (_self, data)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Calendar",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "data",
+ "desc" : "to be modified",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "transform",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox",
+ "name" : "headerclick",
+ "type" : "function",
+ "desc" : "Fires when a header is clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "triggerAction",
- "type" : "String",
- "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
+ "name" : "headercontextmenu",
+ "type" : "function",
+ "desc" : "Fires when a header is right clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "triggerClass",
- "type" : "String",
- "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).",
+ "name" : "headerdblclick",
+ "type" : "function",
+ "desc" : "Fires when a header cell is double clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "typeAhead",
- "type" : "Boolean",
- "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
+ "name" : "keydown",
+ "type" : "function",
+ "desc" : "The raw keydown event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "typeAheadDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
+ "name" : "keypress",
+ "type" : "function",
+ "desc" : "The raw keypress event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
+ "name" : "monthchange",
+ "type" : "function",
+ "desc" : "Fires when the displayed month changes",
+ "sig" : "function (_self, date)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "DatePicker",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "date",
+ "type" : "Date",
+ "desc" : "The selected month",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
+ "name" : "mousedown",
+ "type" : "function",
+ "desc" : "The raw mousedown event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
+ "name" : "mouseout",
+ "type" : "function",
+ "desc" : "The raw mouseout event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
+ "name" : "mouseover",
+ "type" : "function",
+ "desc" : "The raw mouseover event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "valueField",
- "type" : "String",
- "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
+ "name" : "mouseup",
+ "type" : "function",
+ "desc" : "The raw mouseup event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "valueNotFoundText",
- "type" : "String",
- "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires when the grid is rendered",
+ "sig" : "function (grid)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "grid",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
+ "name" : "rowclass",
+ "type" : "function",
+ "desc" : "Fires when a row is rendered, so you can change add a style to it.",
+ "sig" : "function (gridview, rowcfg)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "gridview",
+ "type" : "GridView",
+ "desc" : "The grid view",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowcfg",
+ "type" : "Object",
+ "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "autosize",
+ "name" : "rowclick",
"type" : "function",
- "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
- "sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : "Roo.form.TextField",
+ "desc" : "Fires when a row is clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "This text field",
+ "type" : "Grid",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "width",
+ "name" : "rowIndex",
"type" : "Number",
- "desc" : "The new field width",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforedestroy",
+ "name" : "rowcontextmenu",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a row is right clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforehide",
+ "name" : "rowdblclick",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a row is double clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "select",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a date is selected",
+ "sig" : "function (_self, date)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "DatePicker",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "date",
+ "type" : "Date",
+ "desc" : "The selected date",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "startdrag",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when row(s) start being dragged",
+ "sig" : "function (_self, dd, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addColumns",
+ "type" : "function",
+ "desc" : "addColumns\nAdd's a column, default at the end..",
+ "sig" : "(position, of)",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "position",
+ "type" : "int",
+ "desc" : "to add (default end)",
+ "isOptional" : false
+ },
+ {
+ "name" : "of",
+ "type" : "Array",
+ "desc" : "objects of column configuration see {@link Roo.grid.ColumnModel}",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "blur",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "change",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "autoSize",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "capture",
+ "type" : "function",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Destroy this grid.",
+ "sig" : "(removeEl)",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "removeEl",
+ "type" : "Boolean",
+ "desc" : "True to remove the element",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enable",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "eventName",
+ "type" : "String",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "focus",
+ "name" : "getColumnModel",
"type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Returns the grid's ColumnModel.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "ColumnModel",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getDataSource",
+ "type" : "function",
+ "desc" : "Returns the grid's DataSource.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "DataSource",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getDragDropText",
+ "type" : "function",
+ "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.\nOverride this to put something different in the dragged text.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getGridEl",
+ "type" : "function",
+ "desc" : "Returns the grid's underlying element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Element",
+ "desc" : "The element"
+ }
+ ]
+ },
+ {
+ "name" : "getSelectionModel",
+ "type" : "function",
+ "desc" : "Returns the grid's SelectionModel.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "SelectionModel",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getView",
+ "type" : "function",
+ "desc" : "Returns the grid's GridView object.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "GridView",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "hasListener",
+ "type" : "function",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "hide",
+ "name" : "on",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "invalid",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "reconfigure",
+ "type" : "function",
+ "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.",
+ "sig" : "(dataSource, The)",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "dataSource",
+ "type" : "Roo.data.Store",
+ "desc" : "The new {@link Roo.data.Store} object",
"isOptional" : false
},
{
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
+ "name" : "The",
+ "type" : "Roo.grid.ColumnModel",
+ "desc" : "new {@link Roo.grid.ColumnModel} object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "keyup",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "move",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires after the component is moved.",
- "sig" : "function (_self, x, y)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
+ "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.grid.Grid",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.grid.CellSelectionModel" : {
+ "props" : [
+ {
+ "name" : "enter_is_tab",
+ "type" : "Boolean",
+ "desc" : "Enter behaves the same as tab. (eg. goes to next cell) default: false",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "render",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforeeditnext",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires before the next editable sell is made active\nYou can use this to skip to another cell or fire the tabend\n if you set cell to false",
+ "sig" : "function (eventdata)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "eventdata",
+ "type" : "Object",
+ "desc" : "object : { cell : [ row, col ] }",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resize",
+ "name" : "beforerowselect",
"type" : "function",
- "desc" : "Fires after the component is resized.",
- "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
+ "desc" : "Fires before a cell is selected.",
+ "sig" : "function (_self, rowIndex, colIndex)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "SelectionModel",
"desc" : "",
"isOptional" : false
},
{
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
- "isOptional" : false
- },
- {
- "name" : "rawWidth",
+ "name" : "rowIndex",
"type" : "Number",
- "desc" : "The width that was originally specified",
+ "desc" : "The selected row index",
"isOptional" : false
},
{
- "name" : "rawHeight",
+ "name" : "colIndex",
"type" : "Number",
- "desc" : "The height that was originally specified",
+ "desc" : "The selected cell index",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "cellselect",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a cell is selected.",
+ "sig" : "function (_self, rowIndex, colIndex)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "SelectionModel",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "The selected row index",
+ "isOptional" : false
+ },
+ {
+ "name" : "colIndex",
+ "type" : "Number",
+ "desc" : "The selected cell index",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "specialkey",
+ "name" : "selectionchange",
"type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Fires when the active selection changes.",
+ "sig" : "function (_self, selection)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "SelectionModel",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
+ "name" : "selection",
+ "type" : "Object",
+ "desc" : "null for no selection or an object (o) with two properties\n\t <ul>\n\t <li>o.record: the record object for the row the selection is in</li>\n\t <li>o.cell: An array of [rowIndex, columnIndex]</li>\n\t </ul>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "valid",
+ "name" : "tabend",
"type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
+ "desc" : "Fires when the tab (or enter) was pressed on the last editable cell\nYou can use this to trigger add new row.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "SelectionModel",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "applyTo",
+ "name" : "capture",
"type" : "function",
- "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
- "sig" : "(el)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id of the node, a DOM node or an existing Element",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.form.Field",
- "desc" : "this"
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "autoSize",
+ "name" : "clearSelections",
"type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
+ "desc" : "Clears all selections.",
+ "sig" : "(true)",
"static" : false,
- "memberOf" : "Roo.form.TriggerField",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "true",
+ "type" : "Boolean",
+ "desc" : "to prevent the gridview from being notified about the change.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
"memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "clearInvalid",
+ "name" : "getSelectedCell",
"type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
+ "desc" : "Returns the currently selected cell,.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "The selected cell (row, column) or null if none selected."
+ }
+ ]
},
{
- "name" : "clearValue",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Clears any text/value currently set in the field",
- "sig" : "()\n{\n\n}",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "collapse",
+ "name" : "hasSelection",
"type" : "function",
- "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
+ "desc" : "Returns true if there is a selection.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "destroy",
+ "name" : "isLocked",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "desc" : "Returns true if the selections are locked.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.grid.AbstractSelectionModel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "disable",
+ "name" : "lock",
"type" : "function",
- "desc" : "Disable this component.",
+ "desc" : "Locks the selections.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.grid.AbstractSelectionModel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "doQuery",
+ "name" : "on",
"type" : "function",
- "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
- "sig" : "(query, forceAll)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "query",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The SQL query to execute",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "forceAll",
- "type" : "Boolean",
- "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enable",
+ "name" : "onEditorKey",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Selects a cell.",
+ "sig" : "(field, e)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "field",
+ "type" : "Number",
+ "desc" : "(not used) - as it's normally used as a listener",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Number",
+ "desc" : "- event - fake it by using\n\nvar e = Roo.EventObjectImpl.prototype;\ne.keyCode = e.TAB",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "expand",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "focus",
+ "name" : "select",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Selects a cell.",
+ "sig" : "(rowIndex, collIndex)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "collIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getBox",
+ "name" : "un",
"type" : "function",
- "desc" : "Gets the current box measurements of the component's underlying element.",
- "sig" : "(local)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "getEl",
+ "name" : "unlock",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Unlocks the selections.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.grid.AbstractSelectionModel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.grid.ColumnModel" : {
+ "props" : [
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Set the CSS text-align property of the column. Defaults to undefined (left",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
+ },
+ {
+ "name" : "cursor",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "auto",
+ "default",
+ "none",
+ "context-menu",
+ "help",
+ "pointer",
+ "progress",
+ "wait",
+ "cell",
+ "crosshair",
+ "text",
+ "vertical-text",
+ "alias",
+ "copy",
+ "move",
+ "no-drop",
+ "not-allowed",
+ "e-resize",
+ "n-resize",
+ "ne-resize",
+ "nw-resize",
+ "s-resize",
+ "se-resize",
+ "sw-resize",
+ "w-resize",
+ "ew-resize",
+ "ns-resize",
+ "nesw-resize",
+ "nwse-resize",
+ "col-resize",
+ "row-resize",
+ "all-scroll",
+ "zoom-in",
+ "zoom-out",
+ "grab",
+ "grabbing"
+ ]
+ },
+ {
+ "name" : "dataIndex",
+ "type" : "String",
+ "desc" : "The name of the field in the grid's {@link Roo.data.Store}'s\n{@link Roo.data.Record} definition from which to draw the column's value. If not\nspecified, the column's index is used as an index into the Record's data Array.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "editor",
+ "type" : "Roo.grid.GridEditor",
+ "desc" : "For grid editors - returns the grid editor",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fixed",
+ "type" : "Boolean",
+ "desc" : "True if the column width cannot be changed. Defaults to false.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "header",
+ "type" : "String",
+ "desc" : "The header text to display in the Grid view.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "True to hide the column. Defaults to false.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "can be '0' for hidden at this size (number less than 12)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "lgHeader",
+ "type" : "String",
+ "desc" : "Header at Bootsrap Large width",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "locked",
+ "type" : "Boolean",
+ "desc" : "True to lock the column in place while scrolling the Grid. Defaults to false.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "can be '0' for hidden at this size (number less than 12)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "mdHeader",
+ "type" : "String",
+ "desc" : "Header at Bootsrap Medium width",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "renderer",
+ "type" : "Function",
+ "desc" : "A function used to generate HTML markup for a cell\ngiven the cell's data value. See {@link #setRenderer}. If not specified, the\ndefault renderer returns the escaped data value. If an object is returned (bootstrap only)\nthen it is treated as a Roo Component object instance, and it is rendered after the initial row is rendered",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "resizable",
+ "type" : "Boolean",
+ "desc" : "False to disable column resizing. Defaults to true.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "can be '0' for hidden at this size (number less than 12)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "smHeader",
+ "type" : "String",
+ "desc" : "Header at Bootsrap Small width",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sortable",
+ "type" : "Boolean",
+ "desc" : "True if sorting is to be allowed on this column.\nDefaults to the value of the {@link #defaultSortable} property.\nWhether local/remote sorting is used is specified in {@link Roo.data.Store#remoteSort}.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tooltip",
+ "type" : "String",
+ "desc" : "mouse over tooltip text",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "valign",
+ "type" : "String",
+ "desc" : "e) Set the CSS vertical-align property of the column (eg. middle, top, bottom etc). Defaults to undefined (middl",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "bottom",
+ "middle"
+ ]
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The initial width in pixels of the column. Using this\ninstead of {@link Roo.grid.Grid#autoSizeColumns} is more efficient.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "xl",
+ "type" : "Number",
+ "desc" : "can be '0' for hidden at this size (number less than 12)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "xlHeader",
+ "type" : "String",
+ "desc" : "Header at Bootsrap extra Large width",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "can be '0' for hidden at this size (number less than 12)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "xsHeader",
+ "type" : "String",
+ "desc" : "Header at Bootsrap Extra Small width (default for all)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "columlockchange",
+ "type" : "function",
+ "desc" : "Fires when a column's locked state is changed",
+ "sig" : "function (_self, colIndex, locked)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "name" : "this",
+ "type" : "ColumnModel",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "colIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "locked",
+ "type" : "Boolean",
+ "desc" : "true if locked",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getId",
+ "name" : "columnmoved",
"type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires when a column is moved.",
+ "sig" : "function (_self, oldIndex, newIndex)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "ColumnModel",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "headerchange",
+ "type" : "function",
+ "desc" : "Fires when the text of a header changes.",
+ "sig" : "function (_self, columnIndex, newText)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "ColumnModel",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ },
+ {
+ "name" : "newText",
+ "type" : "Number",
+ "desc" : "The new header text",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hiddenchange",
+ "type" : "function",
+ "desc" : "Fires when a column is hidden or \"unhidden\".",
+ "sig" : "function (_self, columnIndex, hidden)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "ColumnModel",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ },
+ {
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "true if hidden, false otherwise",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "widthchange",
+ "type" : "function",
+ "desc" : "Fires when the width of a column changes.",
+ "sig" : "function (_self, columnIndex, newWidth)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "ColumnModel",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ },
+ {
+ "name" : "newWidth",
+ "type" : "Number",
+ "desc" : "The new width",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addColumn",
+ "type" : "function",
+ "desc" : "Add a column (experimental...) - defaults to adding to the end..",
+ "sig" : "(config)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : ""
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getName",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Returns the name attribute of the field if available",
- "sig" : "()\n{\n\n}",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : "name The field name"
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getPosition",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Gets the current XY position of the component's underlying element.",
- "sig" : "(local)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Array",
- "desc" : "The XY position of the element (e.g., [100, 200])"
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getRawValue",
+ "name" : "capture",
"type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getSize",
+ "name" : "findColumnIndex",
"type" : "function",
- "desc" : "Gets the current size of the component's underlying element.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the index for a specified column dataIndex.",
+ "sig" : "(dataIndex)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "dataIndex",
+ "type" : "String",
+ "desc" : "The column dataIndex",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
+ "type" : "Number",
+ "desc" : "the index, or -1 if not found"
}
]
},
{
- "name" : "getValue",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Returns the currently selected field value or empty string if no value is set.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "value The selected value"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "hasChanged",
+ "name" : "getCellEditor",
"type" : "function",
- "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the editor defined for the cell/column.\nreturn false or null to disable editing.",
+ "sig" : "(colIndex, rowIndex)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "colIndex",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "The row index",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "hasListener",
+ "name" : "getColumnByDataIndex",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Returns the column Object for a specified dataIndex.",
+ "sig" : "(dataIndex)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "dataIndex",
"type" : "String",
- "desc" : "The name of the event to check for",
+ "desc" : "The column dataIndex",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "Object|Boolean",
+ "desc" : "the column or false if not found"
}
]
},
{
- "name" : "hide",
+ "name" : "getColumnById",
"type" : "function",
- "desc" : "Hide this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the column for a specified id.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The column id",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Object",
+ "desc" : "the column"
}
]
},
{
- "name" : "isDirty",
+ "name" : "getColumnCount",
"type" : "function",
- "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
+ "desc" : "Returns the number of columns.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "isExpanded",
+ "name" : "getColumnHeader",
"type" : "function",
- "desc" : "Returns true if the dropdown list is expanded, else false.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the header for the specified column.",
+ "sig" : "(col)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "isValid",
+ "name" : "getColumnId",
"type" : "function",
- "desc" : "Returns whether or not the field value is currently valid",
- "sig" : "(preventMark)",
+ "desc" : "Returns the id of the column at the specified index.",
+ "sig" : "(index)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "True to disable marking the field invalid",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The column index",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "type" : "String",
+ "desc" : "the id"
}
]
},
{
- "name" : "isVisible",
+ "name" : "getColumnTooltip",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the tooltip for the specified column.",
+ "sig" : "(col)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "markInvalid",
+ "name" : "getColumnWidth",
"type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
+ "desc" : "Returns the width for the specified column.",
+ "sig" : "(col, (optional))",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ },
+ {
+ "name" : "(optional)",
+ "type" : "",
+ "desc" : "{String} gridSize bootstrap width size.",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "on",
+ "name" : "getColumnsBy",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Returns the column configs that return true by the passed function that is called with (columnConfig, index)",
+ "sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
+ "name" : "fn",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
"desc" : "(optional)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "result"
+ }
+ ]
},
{
- "name" : "onPosition",
+ "name" : "getDataIndex",
"type" : "function",
- "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
- "sig" : "(x, y)",
+ "desc" : "Returns the dataIndex for the specified column.",
+ "sig" : "(col)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "x",
+ "name" : "col",
"type" : "Number",
- "desc" : "The new x position",
+ "desc" : "The column index",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
- "name" : "y",
+ "name" : "",
"type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "onResize",
+ "name" : "getIndexById",
"type" : "function",
- "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
- "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
+ "desc" : "Returns the index for a specified column id.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
- "isOptional" : false
- },
- {
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The column id",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
- "name" : "rawHeight",
+ "name" : "",
"type" : "Number",
- "desc" : "The height that was originally specified",
- "isOptional" : false
+ "desc" : "the index, or -1 if not found"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "onTriggerClick",
+ "name" : "getRenderer",
"type" : "function",
- "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
- "sig" : "(e)",
+ "desc" : "Returns the rendering (formatting) function defined for the column.",
+ "sig" : "(col)",
"static" : false,
- "memberOf" : "Roo.form.TriggerField",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "EventObject",
- "desc" : "",
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index.",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Function",
+ "desc" : "The function used to render the cell. See {@link #setRenderer}."
+ }
+ ]
},
{
- "name" : "purgeListeners",
+ "name" : "getTotalWidth",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the total width of all columns.",
+ "sig" : "(includeHidden)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "includeHidden",
+ "type" : "Boolean",
+ "desc" : "True to include hidden column widths",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "removeListener",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "render",
+ "name" : "isCellEditable",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Returns true if the cell is editable.",
+ "sig" : "(colIndex, rowIndex)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "colIndex",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "The row index - this is nto actually used..?",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "reset",
+ "name" : "isFixed",
"type" : "function",
- "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
+ "desc" : "Returns true if the column width cannot be changed",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "resetHasChanged",
+ "name" : "isHidden",
"type" : "function",
- "desc" : "stores the current value in loadedValue",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns true if the column is hidden.",
+ "sig" : "(colIndex)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "colIndex",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "select",
+ "name" : "isResizable",
"type" : "function",
- "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(index, scrollIntoView)",
+ "desc" : "Returns true if the column can be resized",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The zero-based index of the list item to select",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "scrollIntoView",
+ "name" : "",
"type" : "Boolean",
- "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
- "isOptional" : false
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "selectByValue",
+ "name" : "isSortable",
"type" : "function",
- "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(value, scrollIntoView)",
+ "desc" : "Returns true if the specified column is sortable.",
+ "sig" : "(col)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "String",
- "desc" : "The data value of the item to select",
- "isOptional" : false
- },
- {
- "name" : "scrollIntoView",
- "type" : "Boolean",
- "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Boolean",
- "desc" : "True if the value matched an item in the list, else false"
+ "desc" : ""
}
]
},
{
- "name" : "selectText",
+ "name" : "on",
"type" : "function",
- "desc" : "Selects text in this field",
- "sig" : "(start, end)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "start",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should start (defaults to 0)",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "end",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should end (defaults to the text length)",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setEditable",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Boolean",
- "desc" : "True to allow the user to directly edit the field text",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setFromData",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
- "sig" : "(value)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
"type" : "Object",
- "desc" : "the value to set as. or false on reset?",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setPagePosition",
+ "name" : "setColumnHeader",
"type" : "function",
- "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
- "sig" : "(x, y)",
+ "desc" : "Sets the header for a column.",
+ "sig" : "(col, header)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "x",
+ "name" : "col",
"type" : "Number",
- "desc" : "The new x position",
+ "desc" : "The column index",
"isOptional" : false
},
{
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
+ "name" : "header",
+ "type" : "String",
+ "desc" : "The new header",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setPosition",
+ "name" : "setColumnTooltip",
"type" : "function",
- "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
- "sig" : "(left, top)",
+ "desc" : "Sets the tooltip for a column.",
+ "sig" : "(col, tooltip)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "left",
+ "name" : "col",
"type" : "Number",
- "desc" : "The new left",
+ "desc" : "The column index",
"isOptional" : false
},
{
- "name" : "top",
- "type" : "Number",
- "desc" : "The new top",
+ "name" : "tooltip",
+ "type" : "String",
+ "desc" : "The new tooltip",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setRawValue",
+ "name" : "setColumnWidth",
"type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
+ "desc" : "Sets the width for a column.",
+ "sig" : "(col, width)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The new width",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setSize",
+ "name" : "setDataIndex",
"type" : "function",
- "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
- "sig" : "(width, height)",
+ "desc" : "Sets the dataIndex for a column.",
+ "sig" : "(col, dataIndex)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "width",
- "type" : "Number/Object",
- "desc" : "The new width to set, or a size object in the format {width, height}",
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
"isOptional" : false
},
{
- "name" : "height",
+ "name" : "dataIndex",
"type" : "Number",
- "desc" : "The new height to set (not required if a size object is passed as the first arg)",
+ "desc" : "The new dataIndex",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.BoxComponent",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "setValue",
+ "name" : "setEditable",
"type" : "function",
- "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
- "sig" : "(value)",
+ "desc" : "Sets if a column is editable.",
+ "sig" : "(col, editable)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "String",
- "desc" : "The value to match",
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ },
+ {
+ "name" : "editable",
+ "type" : "Boolean",
+ "desc" : "True if the column is editable",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "setEditor",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Sets the editor for a column.",
+ "sig" : "(col, editor)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "editor",
+ "type" : "Object",
+ "desc" : "The editor object",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "setWidth",
+ "name" : "setHidden",
"type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets if a column is hidden.",
+ "sig" : "(colIndex, hidden)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "colIndex",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ },
+ {
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "True if the column is hidden",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "show",
+ "name" : "setRenderer",
"type" : "function",
- "desc" : "Show this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the rendering (formatting) function for a column.",
+ "sig" : "(col, fn)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to use to process the cell's raw data\nto return HTML markup for the grid view. The render function is called with\nthe following parameters:<ul>\n<li>Data value.</li>\n<li>Cell metadata. An object in which you may set the following attributes:<ul>\n<li>css A CSS style string to apply to the table cell.</li>\n<li>attr An HTML attribute definition string to apply to the data container element <i>within</i> the table cell.</li></ul>\n<li>The {@link Roo.data.Record} from which the data was extracted.</li>\n<li>Row index</li>\n<li>Column index</li>\n<li>The {@link Roo.data.Store} object from which the Record was extracted</li></ul>",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "syncSize",
- "type" : "function",
- "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ ],
"returns" : []
},
{
}
],
"returns" : []
- },
- {
- "name" : "updateBox",
- "type" : "function",
- "desc" : "Sets the current box measurements of the component's underlying element.",
- "sig" : "(box)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "box",
- "type" : "Object",
- "desc" : "An object in the format {x, y, width, height}",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.Signature" : {
+ "Roo.grid.EditorGrid" : {
"props" : [
{
- "name" : "actionMode",
+ "name" : "autoExpandColumn",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
+ "desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "allowBlank",
+ "name" : "autoExpandMax",
+ "type" : "Number",
+ "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoExpandMin",
+ "type" : "Number",
+ "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoHeight",
"type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to false)",
- "memberOf" : "",
+ "desc" : "True to fit the height of the grid container to the height of the data. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "allowDomMove",
+ "name" : "autoSizeColumns",
"type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
+ "desc" : "True to automatically resize the columns to fit their content\n<b>on initial render.</b> It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "autoCreate",
- "type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
- "memberOf" : "Roo.form.Field",
+ "name" : "autoSizeHeaders",
+ "type" : "Boolean",
+ "desc" : "True to measure headers with column data when auto sizing columns. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "cls",
- "type" : "String",
- "desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field",
+ "name" : "autoWidth",
+ "type" : "Boolean",
+ "desc" : "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
+ "name" : "clicksToEdit",
+ "type" : "Number",
+ "desc" : "The number of clicks on a cell required to display the cell's editor (defaults to 2)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field",
+ "name" : "cm[]",
+ "type" : "Roo.grid.ColumnModel",
+ "desc" : "The columns of the grid",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "fieldClass",
+ "name" : "ddGroup",
"type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field",
+ "desc" : "- drag drop group.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "fieldLabel",
+ "name" : "ddText",
"type" : "String",
- "desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Configures the text is the drag proxy (defaults to \"%0 selected row(s)\").\n%0 is replaced with the number of selected rows.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "focusClass",
+ "name" : "dragGroup",
"type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field",
+ "desc" : "- drag group (?? not sure if needed.)",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "The signature panel height (defaults to 100)",
- "memberOf" : "",
+ "name" : "dropTarget",
+ "type" : "Roo.dd.DropTarget",
+ "desc" : "An {@link Roo.dd.DropTarget} config",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
+ "name" : "ds",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store for the grid",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
+ "optvals" : []
},
{
- "name" : "inputType",
- "type" : "String",
- "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field",
+ "name" : "enableColumnHide",
+ "type" : "Boolean",
+ "desc" : "True to enable hiding of columns with the header context menu. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field",
+ "name" : "enableColumnMove",
+ "type" : "Boolean",
+ "desc" : "True to enable drag and drop reorder of columns. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : "Roo.form.Field",
+ "name" : "enableDrag",
+ "type" : "Boolean",
+ "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableDragDrop",
+ "type" : "Boolean",
+ "desc" : "True to enable drag and drop of rows. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableDrop",
+ "type" : "Boolean",
+ "desc" : "True to enable drop of elements. Default is false. (double check if this is needed?)",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "labelSeparator",
- "type" : "String",
- "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
- "memberOf" : "Roo.form.Field",
+ "name" : "enableRowHeightSync",
+ "type" : "Boolean",
+ "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "labels",
- "type" : "Object",
- "desc" : "Label to use when rendering a form.\ndefaults to \nlabels : { \n clear : \"Clear\",\n confirm : \"Confirm\"\n }",
- "memberOf" : "",
+ "name" : "footer",
+ "type" : "Roo.PagingToolbar",
+ "desc" : "the paging toolbar",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "msgFx",
- "type" : "String",
- "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf" : "Roo.form.Field",
+ "name" : "loadMask",
+ "type" : "Object",
+ "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "msgTarget",
- "type" : "String",
- "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
- "memberOf" : "Roo.form.Field",
+ "name" : "maxHeight",
+ "type" : "Number",
+ "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "name",
- "type" : "String",
- "desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field",
+ "name" : "maxRowsToMeasure",
+ "type" : "Boolean",
+ "desc" : "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "qtip",
- "type" : "String",
- "desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field",
+ "name" : "minColumnWidth",
+ "type" : "Number",
+ "desc" : "The minimum width a column can be resized to. Default is 25.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "readOnly",
+ "name" : "monitorWindowResize",
"type" : "Boolean",
- "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf" : "Roo.form.Field",
+ "desc" : "True to autoSize the grid when the window resizes. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "css styles to add to component\neg. text-align:right;",
- "memberOf" : "Roo.Component",
+ "name" : "sm",
+ "type" : "Roo.grid.AbstractSelectionModel",
+ "desc" : "The selection Model (default = Roo.grid.RowSelectionModel)",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tabIndex",
- "type" : "Number",
- "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : "Roo.form.Field",
+ "name" : "sortColMenu",
+ "type" : "boolean",
+ "desc" : "Sort the column order menu when it shows (usefull for long lists..) default false",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "validateOnBlur",
+ "name" : "stripeRows",
"type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.form.Field",
+ "desc" : "True to stripe the rows. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.form.Field",
+ "name" : "toolbar",
+ "type" : "Roo.Toolbar",
+ "desc" : "a toolbar for buttons etc.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field",
+ "name" : "trackMouseOver",
+ "type" : "Boolean",
+ "desc" : "True to highlight rows when the mouse is over. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "The signature panel width (defaults to 300)",
- "memberOf" : "",
+ "name" : "view",
+ "type" : "Roo.grid.GridView",
+ "desc" : "The view that renders the grid (default = Roo.grid.GridView)",
+ "memberOf" : "Roo.grid.Grid",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
{
- "name" : "beforedestroy",
+ "name" : "afteredit",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires after a cell is edited. <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n</ul>",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "An edit event (see above for description)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforehide",
+ "name" : "beforeedit",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires before cell editing is triggered. The edit event object has the following properties <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value for the field being edited.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "An edit event (see above for description)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "bodyscroll",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when the body element is scrolled",
+ "sig" : "function (scrollLeft, scrollTop)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "scrollLeft",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollTop",
+ "type" : "Number",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "cellclick",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a cell is clicked",
+ "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "blur",
+ "name" : "cellcontextmenu",
"type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Fires when a cell is right clicked",
+ "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "cellIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "change",
+ "name" : "celldblclick",
"type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Fires when a cell is double clicked",
+ "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
},
{
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "confirm",
+ "name" : "click",
"type" : "function",
- "desc" : "Fires when the 'confirm' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "The raw click event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "combo",
- "type" : "Roo.form.Signature",
- "desc" : "This combo box",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "columnmove",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when the user moves a column",
+ "sig" : "function (oldIndex, newIndex)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "oldIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newIndex",
+ "type" : "Number",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "disable",
+ "name" : "columnresize",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when the user resizes a column",
+ "sig" : "function (columnIndex, newSize)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newSize",
+ "type" : "Number",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "enable",
+ "name" : "contextmenu",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "The raw contextmenu event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "focus",
+ "name" : "dblclick",
"type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "The raw dblclick event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "hide",
+ "name" : "dragdrop",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when dragged row(s) are dropped on a valid DD target",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "invalid",
+ "name" : "dragenter",
"type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
},
{
- "name" : "msg",
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "targetId",
"type" : "String",
- "desc" : "The validation message",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "keyup",
+ "name" : "dragout",
"type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
},
+ {
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
{
"name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
+ "type" : "event",
+ "desc" : "The raw browser event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "move",
+ "name" : "dragover",
"type" : "function",
- "desc" : "Fires after the component is moved.",
- "sig" : "function (_self, x, y)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
+ "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
},
{
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
"isOptional" : false
},
{
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "enddrag",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a drag operation is complete",
+ "sig" : "function (_self, dd, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo, record)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
"isOptional" : false
},
{
- "name" : "record",
- "type" : "Roo.data.Record|false",
- "desc" : "The data record returned from the underlying store (or false on nothing selected)",
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resize",
+ "name" : "headerclick",
"type" : "function",
- "desc" : "Fires after the component is resized.",
- "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
+ "desc" : "Fires when a header is clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
},
{
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
- "isOptional" : false
- },
- {
- "name" : "rawWidth",
+ "name" : "columnIndex",
"type" : "Number",
- "desc" : "The width that was originally specified",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "headercontextmenu",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a header is right clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "specialkey",
+ "name" : "headerdblclick",
"type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Fires when a header cell is double clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
"desc" : "",
"isOptional" : false
},
{
"name" : "e",
"type" : "Roo.EventObject",
- "desc" : "The event object",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "valid",
+ "name" : "keydown",
"type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "The raw keydown event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "addEvents",
+ "name" : "keypress",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw keypress event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "mousedown",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw mousedown event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "applyTo",
+ "name" : "mouseout",
"type" : "function",
- "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
- "sig" : "(el)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw mouseout event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id of the node, a DOM node or an existing Element",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.form.Field",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "capture",
+ "name" : "mouseover",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw mouseover event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "createToolbar",
+ "name" : "mouseup",
"type" : "function",
- "desc" : "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons.",
- "sig" : "(editor)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw mouseup event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "editor",
- "type" : "HtmlEditor",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "render",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the grid is rendered",
+ "sig" : "function (grid)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "grid",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "rowclass",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a row is rendered, so you can change add a style to it.",
+ "sig" : "function (gridview, rowcfg)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "gridview",
+ "type" : "GridView",
+ "desc" : "The grid view",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowcfg",
+ "type" : "Object",
+ "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "enable",
+ "name" : "rowclick",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a row is clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "rowcontextmenu",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a row is right clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
+ "name" : "this",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "focus",
+ "name" : "rowdblclick",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a row is double clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getBox",
+ "name" : "startdrag",
"type" : "function",
- "desc" : "Gets the current box measurements of the component's underlying element.",
- "sig" : "(local)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when row(s) start being dragged",
+ "sig" : "function (_self, dd, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "getConfirmed",
+ "name" : "validateedit",
"type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "desc" : "Fires after a cell is edited, but before the value is set in the record. \nYou can use this to modify the value being set in the field, Return false\nto cancel the change. The edit event object has the following properties <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>editor - This editor</li>\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "this.isConfirmed"
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "An edit event (see above for description)",
+ "isOptional" : false
}
- ]
- },
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
{
- "name" : "getEl",
+ "name" : "addColumns",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
+ "desc" : "addColumns\nAdd's a column, default at the end..",
+ "sig" : "(position, of)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "name" : "position",
+ "type" : "int",
+ "desc" : "to add (default end)",
+ "isOptional" : false
+ },
+ {
+ "name" : "of",
+ "type" : "Array",
+ "desc" : "objects of column configuration see {@link Roo.grid.ColumnModel}",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getHeight",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Number",
- "desc" : "this.height"
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getId",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
+ "name" : "eventName",
"type" : "String",
- "desc" : ""
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getImageDataURI",
+ "name" : "autoSize",
"type" : "function",
- "desc" : "when user is clicked confirm then show this image.....",
+ "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "Image Data URI"
- }
- ]
+ "returns" : []
},
{
- "name" : "getName",
+ "name" : "capture",
"type" : "function",
- "desc" : "Returns the name attribute of the field if available",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : "name The field name"
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getPosition",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Gets the current XY position of the component's underlying element.",
- "sig" : "(local)",
+ "desc" : "Destroy this grid.",
+ "sig" : "(removeEl)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "local",
+ "name" : "removeEl",
"type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "desc" : "True to remove the element",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Array",
- "desc" : "The XY position of the element (e.g., [100, 200])"
- }
- ]
+ "returns" : []
},
{
- "name" : "getRawValue",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "getSize",
+ "name" : "getColumnModel",
"type" : "function",
- "desc" : "Gets the current size of the component's underlying element.",
+ "desc" : "Returns the grid's ColumnModel.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
+ "type" : "ColumnModel",
+ "desc" : ""
}
]
},
{
- "name" : "getValue",
+ "name" : "getDataSource",
"type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "desc" : "Returns the grid's DataSource.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "DataSource",
+ "desc" : ""
}
]
},
{
- "name" : "getWidth",
+ "name" : "getDragDropText",
"type" : "function",
- "desc" : "",
+ "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "this.width"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "hasChanged",
+ "name" : "getGridEl",
"type" : "function",
- "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
+ "desc" : "Returns the grid's underlying element.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
- },
- {
- "name" : "hasListener",
- "type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "hide",
+ "name" : "getSelectionModel",
"type" : "function",
- "desc" : "Hide this component.",
+ "desc" : "Returns the grid's SelectionModel.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "SelectionModel",
+ "desc" : ""
}
]
},
{
- "name" : "isDirty",
+ "name" : "getView",
"type" : "function",
- "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
+ "desc" : "Returns the grid's GridView object.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
- },
- {
- "name" : "isValid",
- "type" : "function",
- "desc" : "Returns whether or not the field value is currently valid",
- "sig" : "(preventMark)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "True to disable marking the field invalid",
- "isOptional" : false
- }
- ],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "type" : "GridView",
+ "desc" : ""
}
]
},
{
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "markInvalid",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "msg",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The validation message",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
"name" : "on",
"returns" : []
},
{
- "name" : "onPosition",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
- "sig" : "(x, y)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "onResize",
+ "name" : "reconfigure",
"type" : "function",
- "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
- "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
+ "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.",
+ "sig" : "(dataSource, The)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
- "isOptional" : false
- },
- {
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
+ "name" : "dataSource",
+ "type" : "Roo.data.Store",
+ "desc" : "The new {@link Roo.data.Store} object",
"isOptional" : false
},
{
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
+ "name" : "The",
+ "type" : "Roo.grid.ColumnModel",
+ "desc" : "new {@link Roo.grid.ColumnModel} object",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "releaseCapture",
"type" : "function",
{
"name" : "render",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "resetHasChanged",
- "type" : "function",
- "desc" : "stores the current value in loadedValue",
+ "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
- },
- {
- "name" : "setDisabled",
- "type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setPagePosition",
- "type" : "function",
- "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
- "sig" : "(x, y)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setPosition",
- "type" : "function",
- "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
- "sig" : "(left, top)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "left",
- "type" : "Number",
- "desc" : "The new left",
- "isOptional" : false
- },
- {
- "name" : "top",
- "type" : "Number",
- "desc" : "The new top",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setSize",
- "type" : "function",
- "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
- "sig" : "(width, height)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "width",
- "type" : "Number/Object",
- "desc" : "The new width to set, or a size object in the format {width, height}",
- "isOptional" : false
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "The new height to set (not required if a size object is passed as the first arg)",
- "isOptional" : false
- }
- ],
"returns" : [
{
"name" : "",
- "type" : "Roo.BoxComponent",
+ "type" : "Roo.grid.Grid",
"desc" : "this"
}
]
},
{
- "name" : "setValue",
+ "name" : "startEditing",
"type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
+ "desc" : "Starts editing the specified for the specified row/column",
+ "sig" : "(rowIndex, colIndex)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "colIndex",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "syncSize",
+ "name" : "stopEditing",
"type" : "function",
- "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
+ "desc" : "Stops any active editing",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
],
"returns" : []
- },
- {
- "name" : "updateBox",
- "type" : "function",
- "desc" : "Sets the current box measurements of the component's underlying element.",
- "sig" : "(box)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "box",
- "type" : "Object",
- "desc" : "An object in the format {x, y, width, height}",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
+ "implementations" : [
+ "Roo.grid.PropertyGrid"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.TextArea" : {
+ "Roo.grid.Grid" : {
"props" : [
{
- "name" : "actionMode",
+ "name" : "autoExpandColumn",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
+ "desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.form.TextField",
+ "name" : "autoExpandMax",
+ "type" : "Number",
+ "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
+ "name" : "autoExpandMin",
+ "type" : "Number",
+ "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "allowLeadingSpace",
+ "name" : "autoHeight",
"type" : "Boolean",
- "desc" : "True to prevent the stripping of leading white space",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoCreate",
- "type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"textarea\", style: \"width:300px;height:60px;\", autocomplete: \"off\"})",
+ "desc" : "True to fit the height of the grid container to the height of the data. Default is false.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
+ "name" : "autoSizeColumns",
+ "type" : "Boolean",
+ "desc" : "True to automatically resize the columns to fit their content\n<b>on initial render.</b> It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disableKeyFilter",
+ "name" : "autoSizeHeaders",
"type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.form.TextField",
+ "desc" : "True to measure headers with column data when auto sizing columns. Default is true.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disabled",
+ "name" : "autoWidth",
"type" : "Boolean",
- "desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field",
+ "desc" : "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "emptyText",
- "type" : "String",
- "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField",
+ "name" : "cm[]",
+ "type" : "Roo.grid.ColumnModel",
+ "desc" : "The columns of the grid",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "fieldClass",
+ "name" : "ddGroup",
"type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field",
+ "desc" : "- drag drop group.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "fieldLabel",
+ "name" : "ddText",
"type" : "String",
- "desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Configures the text is the drag proxy (defaults to \"%0 selected row(s)\").\n%0 is replaced with the number of selected rows.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "focusClass",
+ "name" : "dragGroup",
"type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field",
+ "desc" : "- drag group (?? not sure if needed.)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "grow",
- "type" : "Boolean",
- "desc" : "True if this field should automatically grow and shrink to its content",
- "memberOf" : "Roo.form.TextField",
+ "name" : "dropTarget",
+ "type" : "Roo.dd.DropTarget",
+ "desc" : "An {@link Roo.dd.DropTarget} config",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "growMax",
- "type" : "Number",
- "desc" : "The maximum height to allow when grow = true (defaults to 1000)",
+ "name" : "ds",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store for the grid",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "growMin",
- "type" : "Number",
- "desc" : "The minimum height to allow when grow = true (defaults to 60)",
+ "name" : "enableColumnHide",
+ "type" : "Boolean",
+ "desc" : "True to enable hiding of columns with the header context menu. Default is true.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent",
+ "name" : "enableColumnMove",
+ "type" : "Boolean",
+ "desc" : "True to enable drag and drop reorder of columns. Default is true.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
+ "name" : "enableDrag",
+ "type" : "Boolean",
+ "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
+ "optvals" : []
},
{
- "name" : "inputType",
- "type" : "String",
- "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field",
+ "name" : "enableDragDrop",
+ "type" : "Boolean",
+ "desc" : "True to enable drag and drop of rows. Default is false.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field",
+ "name" : "enableDrop",
+ "type" : "Boolean",
+ "desc" : "True to enable drop of elements. Default is false. (double check if this is needed?)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : "Roo.form.Field",
+ "name" : "enableRowHeightSync",
+ "type" : "Boolean",
+ "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "labelSeparator",
- "type" : "String",
- "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
- "memberOf" : "Roo.form.Field",
+ "name" : "footer",
+ "type" : "Roo.PagingToolbar",
+ "desc" : "the paging toolbar",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.form.TextField",
+ "name" : "loadMask",
+ "type" : "Object",
+ "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "minLength",
+ "name" : "maxHeight",
"type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "msgFx",
- "type" : "String",
- "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "msgTarget",
- "type" : "String",
- "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "name",
- "type" : "String",
- "desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "preventScrollbars",
+ "name" : "maxRowsToMeasure",
"type" : "Boolean",
- "desc" : "True to prevent scrollbars from appearing regardless of how much text is\nin the field (equivalent to setting overflow: hidden, defaults to false)",
+ "desc" : "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "qtip",
- "type" : "String",
- "desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field",
+ "name" : "minColumnWidth",
+ "type" : "Number",
+ "desc" : "The minimum width a column can be resized to. Default is 25.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "readOnly",
+ "name" : "monitorWindowResize",
"type" : "Boolean",
- "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf" : "Roo.form.Field",
+ "desc" : "True to autoSize the grid when the window resizes. Default is true.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.form.TextField",
+ "name" : "sm",
+ "type" : "Roo.grid.AbstractSelectionModel",
+ "desc" : "The selection Model (default = Roo.grid.RowSelectionModel)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "regexText",
- "type" : "String",
- "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.form.TextField",
+ "name" : "sortColMenu",
+ "type" : "boolean",
+ "desc" : "Sort the column order menu when it shows (usefull for long lists..) default false",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "selectOnFocus",
+ "name" : "stripeRows",
"type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "css styles to add to component\neg. text-align:right;",
- "memberOf" : "Roo.Component",
+ "desc" : "True to stripe the rows. Default is true.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tabIndex",
- "type" : "Number",
- "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : "Roo.form.Field",
+ "name" : "toolbar",
+ "type" : "Roo.Toolbar",
+ "desc" : "a toolbar for buttons etc.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "validateOnBlur",
+ "name" : "trackMouseOver",
"type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.form.TextField",
+ "desc" : "True to highlight rows when the mouse is over. Default is true.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent",
+ "name" : "view",
+ "type" : "Roo.grid.GridView",
+ "desc" : "The view that renders the grid (default = Roo.grid.GridView)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "autosize",
- "type" : "function",
- "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
- "sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : "Roo.form.TextField",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "This text field",
- "isOptional" : false
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The new field width",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
+ }
+ ],
+ "events" : [
{
- "name" : "beforedestroy",
+ "name" : "bodyscroll",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when the body element is scrolled",
+ "sig" : "function (scrollLeft, scrollTop)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "scrollLeft",
+ "type" : "Number",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "scrollTop",
+ "type" : "Number",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "cellclick",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a cell is clicked",
+ "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "blur",
+ "name" : "cellcontextmenu",
"type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Fires when a cell is right clicked",
+ "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "cellIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "change",
+ "name" : "celldblclick",
"type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Fires when a cell is double clicked",
+ "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
},
{
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "click",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "The raw click event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "disable",
+ "name" : "columnmove",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when the user moves a column",
+ "sig" : "function (oldIndex, newIndex)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "oldIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newIndex",
+ "type" : "Number",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "enable",
+ "name" : "columnresize",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when the user resizes a column",
+ "sig" : "function (columnIndex, newSize)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newSize",
+ "type" : "Number",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "focus",
+ "name" : "contextmenu",
"type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "The raw contextmenu event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "hide",
+ "name" : "dblclick",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "The raw dblclick event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "invalid",
+ "name" : "dragdrop",
"type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Fires when dragged row(s) are dropped on a valid DD target",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
},
{
- "name" : "msg",
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "targetId",
"type" : "String",
- "desc" : "The validation message",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "keyup",
+ "name" : "dragenter",
"type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
},
+ {
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
{
"name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
+ "type" : "event",
+ "desc" : "The raw browser event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "move",
+ "name" : "dragout",
"type" : "function",
- "desc" : "Fires after the component is moved.",
- "sig" : "function (_self, x, y)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
+ "desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
},
{
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
"isOptional" : false
},
{
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resize",
+ "name" : "dragover",
"type" : "function",
- "desc" : "Fires after the component is resized.",
- "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
+ "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
},
{
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
"isOptional" : false
},
{
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
"isOptional" : false
},
{
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "enddrag",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a drag operation is complete",
+ "sig" : "function (_self, dd, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "specialkey",
+ "name" : "headerclick",
"type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Fires when a header is clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
"desc" : "",
"isOptional" : false
},
{
"name" : "e",
"type" : "Roo.EventObject",
- "desc" : "The event object",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "valid",
+ "name" : "headercontextmenu",
"type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Fires when a header is right clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "methods" : [
- {
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "headerdblclick",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a header cell is double clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "applyTo",
+ "name" : "keydown",
"type" : "function",
- "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
- "sig" : "(el)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw keydown event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id of the node, a DOM node or an existing Element",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.form.Field",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "Automatically grows the field to accomodate the height of the text up to the maximum field height allowed.\nThis only takes effect if grow = true, and fires the autosize event if the height changes.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "keypress",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw keypress event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "disable",
+ "name" : "mousedown",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw mousedown event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "enable",
+ "name" : "mouseout",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw mouseout event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "mouseover",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw mouseover event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
},
{
- "name" : "focus",
+ "name" : "mouseup",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw mouseup event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "getBox",
+ "name" : "render",
"type" : "function",
- "desc" : "Gets the current box measurements of the component's underlying element.",
- "sig" : "(local)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the grid is rendered",
+ "sig" : "function (grid)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "name" : "grid",
+ "type" : "Grid",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "getEl",
+ "name" : "rowclass",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a row is rendered, so you can change add a style to it.",
+ "sig" : "function (gridview, rowcfg)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
- }
- ]
- },
- {
- "name" : "getId",
- "type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "name" : "gridview",
+ "type" : "GridView",
+ "desc" : "The grid view",
+ "isOptional" : false
+ },
{
- "name" : "",
- "type" : "String",
- "desc" : ""
+ "name" : "rowcfg",
+ "type" : "Object",
+ "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getName",
+ "name" : "rowclick",
"type" : "function",
- "desc" : "Returns the name attribute of the field if available",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a row is clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : "name The field name"
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getPosition",
+ "name" : "rowcontextmenu",
"type" : "function",
- "desc" : "Gets the current XY position of the component's underlying element.",
- "sig" : "(local)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a row is right clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Array",
- "desc" : "The XY position of the element (e.g., [100, 200])"
- }
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
{
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getSize",
+ "name" : "rowdblclick",
"type" : "function",
- "desc" : "Gets the current size of the component's underlying element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a row is double clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Object",
- "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
- }
- ]
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
{
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "hasChanged",
- "type" : "function",
- "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ ],
"returns" : []
},
{
- "name" : "hasListener",
+ "name" : "startdrag",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when row(s) start being dragged",
+ "sig" : "function (_self, dd, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "isDirty",
- "type" : "function",
- "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ ],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "isValid",
+ "name" : "addColumns",
"type" : "function",
- "desc" : "Returns whether or not the field value is currently valid",
- "sig" : "(preventMark)",
+ "desc" : "addColumns\nAdd's a column, default at the end..",
+ "sig" : "(position, of)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "True to disable marking the field invalid",
+ "name" : "position",
+ "type" : "int",
+ "desc" : "to add (default end)",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "name" : "of",
+ "type" : "Array",
+ "desc" : "objects of column configuration see {@link Roo.grid.ColumnModel}",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ ],
"returns" : []
},
{
- "name" : "markInvalid",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "on",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "desc" : "Appends an event handler to this component",
"sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
{
"name" : "options",
"type" : "Object",
- "desc" : "(optional)",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onPosition",
+ "name" : "autoSize",
"type" : "function",
- "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
- "sig" : "(x, y)",
+ "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "onResize",
+ "name" : "capture",
"type" : "function",
- "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
- "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
"isOptional" : false
},
{
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Destroy this grid.",
+ "sig" : "(removeEl)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "removeEl",
+ "type" : "Boolean",
+ "desc" : "True to remove the element",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ "returns" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "reset",
+ "name" : "getColumnModel",
"type" : "function",
- "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
+ "desc" : "Returns the grid's ColumnModel.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "ColumnModel",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "resetHasChanged",
+ "name" : "getDataSource",
"type" : "function",
- "desc" : "stores the current value in loadedValue",
+ "desc" : "Returns the grid's DataSource.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "DataSource",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "selectText",
+ "name" : "getDragDropText",
"type" : "function",
- "desc" : "Selects text in this field",
- "sig" : "(start, end)",
+ "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.\nOverride this to put something different in the dragged text.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "start",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should start (defaults to 0)",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "end",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should end (defaults to the text length)",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setDisabled",
+ "name" : "getGridEl",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Returns the grid's underlying element.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Element",
+ "desc" : "The element"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setPagePosition",
+ "name" : "getSelectionModel",
"type" : "function",
- "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
- "sig" : "(x, y)",
+ "desc" : "Returns the grid's SelectionModel.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
+ "name" : "",
+ "type" : "SelectionModel",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setPosition",
+ "name" : "getView",
"type" : "function",
- "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
- "sig" : "(left, top)",
+ "desc" : "Returns the grid's GridView object.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "left",
- "type" : "Number",
- "desc" : "The new left",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "top",
- "type" : "Number",
- "desc" : "The new top",
- "isOptional" : false
+ "name" : "",
+ "type" : "GridView",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setRawValue",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "setSize",
+ "name" : "on",
"type" : "function",
- "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
- "sig" : "(width, height)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "width",
- "type" : "Number/Object",
- "desc" : "The new width to set, or a size object in the format {width, height}",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "The new height to set (not required if a size object is passed as the first arg)",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.BoxComponent",
- "desc" : "this"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "setValue",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "reconfigure",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.",
+ "sig" : "(dataSource, The)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "dataSource",
+ "type" : "Roo.data.Store",
+ "desc" : "The new {@link Roo.data.Store} object",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "The",
+ "type" : "Roo.grid.ColumnModel",
+ "desc" : "new {@link Roo.grid.ColumnModel} object",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "show",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Show this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "syncSize",
- "type" : "function",
- "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ ],
"returns" : []
},
{
- "name" : "un",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
+ "desc" : "Removes a listener",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"returns" : []
},
{
- "name" : "updateBox",
- "type" : "function",
- "desc" : "Sets the current box measurements of the component's underlying element.",
- "sig" : "(box)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "box",
- "type" : "Object",
- "desc" : "An object in the format {x, y, width, height}",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "validate",
+ "name" : "render",
"type" : "function",
- "desc" : "Validates the field value",
+ "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "type" : "Roo.grid.Grid",
+ "desc" : "this"
}
]
},
{
- "name" : "validateValue",
+ "name" : "un",
"type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [
- "Roo.form.FCKeditor"
+ "Roo.grid.Calendar",
+ "Roo.grid.EditorGrid",
+ "Roo.grid.PropertyGrid"
],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.TextField" : {
+ "Roo.grid.GridEditor" : {
"props" : [
{
"name" : "actionMode",
"optvals" : []
},
{
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "",
+ "name" : "alignment",
+ "type" : "String",
+ "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details, defaults to \"c-c?\").",
+ "memberOf" : "Roo.Editor",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "allowLeadingSpace",
- "type" : "Boolean",
- "desc" : "True to prevent the stripping of leading white space",
- "memberOf" : "",
+ "name" : "autosize",
+ "type" : "Boolean/String",
+ "desc" : "True for the editor to automatically adopt the size of the underlying field, \"width\" to adopt the width only,\nor \"height\" to adopt the height only (defaults to false)",
+ "memberOf" : "Roo.Editor",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "autoCreate",
- "type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
- "memberOf" : "Roo.form.Field",
+ "name" : "cancelOnEsc",
+ "type" : "Boolean",
+ "desc" : "True to cancel the edit when the escape key is pressed (defaults to false)",
+ "memberOf" : "Roo.Editor",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "",
+ "name" : "completeOnEnter",
+ "type" : "Boolean",
+ "desc" : "True to complete the edit when the enter key is pressed (defaults to false)",
+ "memberOf" : "Roo.Editor",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "cls",
- "type" : "String",
- "desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field",
+ "name" : "constrain",
+ "type" : "Boolean",
+ "desc" : "True to constrain the editor to the viewport",
+ "memberOf" : "Roo.Editor",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "emptyText",
- "type" : "String",
- "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "name" : "field",
+ "type" : "Roo.form.Field",
+ "desc" : "Field to wrap (or xtyped)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "fieldClass",
- "type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fieldLabel",
- "type" : "String",
- "desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "grow",
+ "name" : "hideEl",
"type" : "Boolean",
- "desc" : "True if this field should automatically grow and shrink to its content",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "growMax",
- "type" : "Number",
- "desc" : "The maximum width to allow when grow = true (defaults to 800)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "growMin",
- "type" : "Number",
- "desc" : "The minimum width to allow when grow = true (defaults to 30)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent",
+ "desc" : "False to keep the bound element visible while the editor is displayed (defaults to true)",
+ "memberOf" : "Roo.Editor",
"isOptional" : false,
"optvals" : []
},
]
},
{
- "name" : "inputType",
- "type" : "String",
- "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelSeparator",
- "type" : "String",
- "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
- "memberOf" : "Roo.form.Field",
+ "name" : "ignoreNoChange",
+ "type" : "Boolean",
+ "desc" : "True to skip the the edit completion process (no save, no events fired) if the user completes an edit and\nthe value has not changed (defaults to false). Applies only to string values - edits for other data types\nwill never be ignored.",
+ "memberOf" : "Roo.Editor",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "msgFx",
- "type" : "String",
- "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "msgTarget",
- "type" : "String",
- "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "name",
- "type" : "String",
- "desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "qtip",
- "type" : "String",
- "desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "readOnly",
+ "name" : "revertInvalid",
"type" : "Boolean",
- "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : "",
+ "desc" : "True to automatically revert the field value and cancel the edit when the user completes an edit and the field\nvalidation fails (defaults to true)",
+ "memberOf" : "Roo.Editor",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "",
+ "name" : "shadow",
+ "type" : "Boolean/String",
+ "desc" : "\"sides\" for sides/bottom only, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"frame\")",
+ "memberOf" : "Roo.Editor",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "tabIndex",
- "type" : "Number",
- "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validateOnBlur",
+ "name" : "updateEl",
"type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "",
+ "desc" : "True to update the innerHTML of the bound element when the update completes (defaults to false)",
+ "memberOf" : "Roo.Editor",
"isOptional" : false,
"optvals" : []
},
{
"name" : "value",
"type" : "Mixed",
- "desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent",
+ "desc" : "The data value of the underlying field (defaults to \"\")",
+ "memberOf" : "Roo.Editor",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
{
- "name" : "autosize",
+ "name" : "beforecomplete",
"type" : "function",
- "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
- "sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after a change has been made to the field, but before the change is reflected in the underlying\nfield. Saving the change to the field can be canceled by returning false from the handler of this event.\nNote that if the value has not changed and ignoreNoChange = true, the editing will still end but this\nevent will not fire since no edit actually occurred.",
+ "sig" : "function (_self, value, startValue)\n{\n\n}",
+ "memberOf" : "Roo.Editor",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "This text field",
+ "type" : "Editor",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "The new field width",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The current field value",
+ "isOptional" : false
+ },
+ {
+ "name" : "startValue",
+ "type" : "Mixed",
+ "desc" : "The original field value",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
+ "name" : "beforestartedit",
"type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Fires when editing is initiated, but before the value changes. Editing can be canceled by returning\nfalse from the handler of this event.",
+ "sig" : "function (_self, boundEl, value)\n{\n\n}",
+ "memberOf" : "Roo.Editor",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Editor",
"desc" : "",
"isOptional" : false
},
{
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "boundEl",
+ "type" : "Roo.Element",
+ "desc" : "The underlying element bound to this editor",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The field value being set",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "hide",
+ "name" : "complete",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires after editing is complete and any changed value has been written to the underlying field.",
+ "sig" : "function (_self, value, startValue)\n{\n\n}",
+ "memberOf" : "Roo.Editor",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Editor",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The current field value",
+ "isOptional" : false
+ },
+ {
+ "name" : "startValue",
+ "type" : "Mixed",
+ "desc" : "The original field value",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "invalid",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "keyup",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "move",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires after the component is moved.",
- "sig" : "function (_self, x, y)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "resize",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires after the component is resized.",
- "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
- "isOptional" : false
- },
- {
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
- "isOptional" : false
- },
- {
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
- "isOptional" : false
}
],
"returns" : []
"type" : "function",
"desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
"sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.Editor",
"example" : "",
"deprecated" : "",
"since" : "",
"returns" : []
},
{
- "name" : "valid",
+ "name" : "startedit",
"type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Fires when this editor is displayed",
+ "sig" : "function (boundEl, value)\n{\n\n}",
+ "memberOf" : "Roo.Editor",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "boundEl",
+ "type" : "Roo.Element",
+ "desc" : "The underlying element bound to this editor",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The starting field value",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "applyTo",
+ "name" : "cancelEdit",
"type" : "function",
- "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
- "sig" : "(el)",
+ "desc" : "Cancels the editing process and hides the editor without persisting any changes. The field value will be\nreverted to the original starting value.",
+ "sig" : "(remainVisible)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.Editor",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id of the node, a DOM node or an existing Element",
+ "name" : "remainVisible",
+ "type" : "Boolean",
+ "desc" : "Override the default behavior and keep the editor visible after\ncancel (defaults to false)",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.form.Field",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
"returns" : []
},
{
"returns" : []
},
{
- "name" : "clearInvalid",
+ "name" : "completeEdit",
"type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
+ "desc" : "Ends the editing process, persists the changed value to the underlying field, and hides the editor.",
+ "sig" : "(remainVisible)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.Editor",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "remainVisible",
+ "type" : "Boolean",
+ "desc" : "Override the default behavior and keep the editor visible after edit (defaults to false)",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
]
},
{
- "name" : "getBox",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Gets the current box measurements of the component's underlying element.",
- "sig" : "(local)",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "getEl",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component",
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getId",
+ "name" : "getValue",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Gets the data value of the editor",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.Editor",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
+ "type" : "Mixed",
+ "desc" : "The data value"
+ }
+ ]
+ },
+ {
+ "name" : "hasListener",
+ "type" : "function",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
"type" : "String",
- "desc" : ""
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "getName",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns the name attribute of the field if available",
+ "desc" : "Hide this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "name The field name"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getPosition",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Gets the current XY position of the component's underlying element.",
- "sig" : "(local)",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "on",
+ "type" : "function",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "local",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "realign",
+ "type" : "function",
+ "desc" : "Realigns the editor to the bound field based on the current alignment config value.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Editor",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "disabled",
"type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setSize",
+ "type" : "function",
+ "desc" : "Sets the height and width of this editor.",
+ "sig" : "(width, height)",
+ "static" : false,
+ "memberOf" : "Roo.Editor",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The new width",
+ "isOptional" : false
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets the data value of the editor",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.Editor",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "Any valid value supported by the underlying field",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Array",
- "desc" : "The XY position of the element (e.g., [100, 200])"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getRawValue",
+ "name" : "show",
"type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "desc" : "Show this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getSize",
+ "name" : "startEdit",
"type" : "function",
- "desc" : "Gets the current size of the component's underlying element.",
+ "desc" : "Starts the editing process and shows the editor.",
+ "sig" : "(el, value)",
+ "static" : false,
+ "memberOf" : "Roo.Editor",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The element to edit",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "(optional) A value to initialize the editor with. If a value is not provided, it defaults\nto the innerHTML of el.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.grid.GridView" : {
+ "props" : [
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "autoSizeColumn",
+ "type" : "function",
+ "desc" : "Autofit a column to its content.",
+ "sig" : "(colIndex, forceMinSize)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "colIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "forceMinSize",
+ "type" : "Boolean",
+ "desc" : "true to force the column to go smaller if possible",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "autoSizeColumns",
+ "type" : "function",
+ "desc" : "Autofits all columns to their content and then expands to fit any extra space in the grid",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "capture",
+ "type" : "function",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "ensureVisible",
+ "type" : "function",
+ "desc" : "Scrolls the specified cell into view",
+ "sig" : "(row, col, hscroll)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "row",
+ "type" : "Number",
+ "desc" : "The row index",
+ "isOptional" : false
+ },
+ {
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ },
+ {
+ "name" : "hscroll",
+ "type" : "Boolean",
+ "desc" : "false to disable horizontal scrolling",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "fireEvent",
+ "type" : "function",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
+ },
+ {
+ "name" : "fitColumns",
+ "type" : "function",
+ "desc" : "Autofits all columns to the grid's width proportionate with their current size",
+ "sig" : "(reserveScrollSpace)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "reserveScrollSpace",
+ "type" : "Boolean",
+ "desc" : "Reserve space for a scrollbar",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "focusCell",
+ "type" : "function",
+ "desc" : "Focuses the specified cell.",
+ "sig" : "(row, col, hscroll)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "row",
+ "type" : "Number",
+ "desc" : "The row index",
+ "isOptional" : false
+ },
+ {
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ },
+ {
+ "name" : "hscroll",
+ "type" : "Boolean",
+ "desc" : "false to disable horizontal scrolling",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "focusRow",
+ "type" : "function",
+ "desc" : "Focuses the specified row.",
+ "sig" : "(row)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "row",
+ "type" : "Number",
+ "desc" : "The row index",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "getCell",
+ "type" : "function",
+ "desc" : "Gets the 'td' of the cell",
+ "sig" : "(rowIndex, colIndex)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "rowIndex",
+ "type" : "Integer",
+ "desc" : "row to select",
+ "isOptional" : false
+ },
+ {
+ "name" : "colIndex",
+ "type" : "Integer",
+ "desc" : "column to select",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
"type" : "Object",
- "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
+ "desc" : ""
}
]
},
{
- "name" : "getValue",
+ "name" : "getFooterPanel",
"type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Gets a panel in the footer of the grid that can be used for toolbars etc.\nAfter modifying the contents of this panel a call to grid.autoSize() may be\nrequired to register any changes in size.",
+ "sig" : "(doShow)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "doShow",
+ "type" : "Boolean",
+ "desc" : "By default the footer is hidden. Pass true to show the panel",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "",
+ "desc" : "Roo.Element"
}
]
},
{
- "name" : "hasChanged",
+ "name" : "getHeaderPanel",
"type" : "function",
- "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Gets a panel in the header of the grid that can be used for toolbars etc.\nAfter modifying the contents of this panel a call to grid.autoSize() may be\nrequired to register any changes in size.",
+ "sig" : "(doShow)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "doShow",
+ "type" : "Boolean",
+ "desc" : "By default the header is hidden. Pass true to show the panel",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "",
+ "desc" : "Roo.Element"
+ }
+ ]
},
{
"name" : "hasListener",
]
},
{
- "name" : "hide",
+ "name" : "on",
"type" : "function",
- "desc" : "Hide this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "isDirty",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "isValid",
+ "name" : "refresh",
"type" : "function",
- "desc" : "Returns whether or not the field value is currently valid",
- "sig" : "(preventMark)",
+ "desc" : "Refreshes the grid",
+ "sig" : "(headersToo)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "preventMark",
+ "name" : "headersToo",
"type" : "Boolean",
- "desc" : "True to disable marking the field invalid",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
"returns" : []
},
{
- "name" : "markInvalid",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "on",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onPosition",
+ "name" : "scrollToTop",
"type" : "function",
- "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
- "sig" : "(x, y)",
+ "desc" : "Scrolls the grid to the top",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "onResize",
+ "name" : "un",
"type" : "function",
- "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
- "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.grid.PropertyGrid" : {
+ "props" : [
+ {
+ "name" : "autoExpandColumn",
+ "type" : "String",
+ "desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "name" : "autoExpandMax",
+ "type" : "Number",
+ "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoExpandMin",
+ "type" : "Number",
+ "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoHeight",
+ "type" : "Boolean",
+ "desc" : "True to fit the height of the grid container to the height of the data. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoSizeColumns",
+ "type" : "Boolean",
+ "desc" : "True to automatically resize the columns to fit their content\n<b>on initial render.</b> It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoSizeHeaders",
+ "type" : "Boolean",
+ "desc" : "True to measure headers with column data when auto sizing columns. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoWidth",
+ "type" : "Boolean",
+ "desc" : "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "clicksToEdit",
+ "type" : "Number",
+ "desc" : "The number of clicks on a cell required to display the cell's editor (defaults to 2)",
+ "memberOf" : "Roo.grid.EditorGrid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cm[]",
+ "type" : "Roo.grid.ColumnModel",
+ "desc" : "The columns of the grid",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "customEditors",
+ "type" : "Object",
+ "desc" : "map of colnames=> custom editors.\nthe custom editor can be one of the standard ones (date|string|number|int|boolean), or a\ngrid editor eg. Roo.grid.GridEditor(new Roo.form.TextArea({selectOnFocus:true})),\nfalse disables editing of the field.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "ddGroup",
+ "type" : "String",
+ "desc" : "- drag drop group.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "ddText",
+ "type" : "String",
+ "desc" : "Configures the text is the drag proxy (defaults to \"%0 selected row(s)\").\n%0 is replaced with the number of selected rows.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dragGroup",
+ "type" : "String",
+ "desc" : "- drag group (?? not sure if needed.)",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dropTarget",
+ "type" : "Roo.dd.DropTarget",
+ "desc" : "An {@link Roo.dd.DropTarget} config",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "ds",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store for the grid",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableColumnHide",
+ "type" : "Boolean",
+ "desc" : "True to enable hiding of columns with the header context menu. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableColumnMove",
+ "type" : "Boolean",
+ "desc" : "True to enable drag and drop reorder of columns. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableDrag",
+ "type" : "Boolean",
+ "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableDragDrop",
+ "type" : "Boolean",
+ "desc" : "True to enable drag and drop of rows. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableDrop",
+ "type" : "Boolean",
+ "desc" : "True to enable drop of elements. Default is false. (double check if this is needed?)",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableRowHeightSync",
+ "type" : "Boolean",
+ "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "footer",
+ "type" : "Roo.PagingToolbar",
+ "desc" : "the paging toolbar",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "loadMask",
+ "type" : "Object",
+ "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxHeight",
+ "type" : "Number",
+ "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxRowsToMeasure",
+ "type" : "Boolean",
+ "desc" : "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minColumnWidth",
+ "type" : "Number",
+ "desc" : "The minimum width a column can be resized to. Default is 25.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "monitorWindowResize",
+ "type" : "Boolean",
+ "desc" : "True to autoSize the grid when the window resizes. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "propertyNames",
+ "type" : "Object",
+ "desc" : "map of property Names to their displayed value",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sm",
+ "type" : "Roo.grid.AbstractSelectionModel",
+ "desc" : "The selection Model (default = Roo.grid.RowSelectionModel)",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sortColMenu",
+ "type" : "boolean",
+ "desc" : "Sort the column order menu when it shows (usefull for long lists..) default false",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "stripeRows",
+ "type" : "Boolean",
+ "desc" : "True to stripe the rows. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "toolbar",
+ "type" : "Roo.Toolbar",
+ "desc" : "a toolbar for buttons etc.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "trackMouseOver",
+ "type" : "Boolean",
+ "desc" : "True to highlight rows when the mouse is over. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "view",
+ "type" : "Roo.grid.GridView",
+ "desc" : "The view that renders the grid (default = Roo.grid.GridView)",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "afteredit",
+ "type" : "function",
+ "desc" : "Fires after a cell is edited. <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n</ul>",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.EditorGrid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "An edit event (see above for description)",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "beforeedit",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before cell editing is triggered. The edit event object has the following properties <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value for the field being edited.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.EditorGrid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "An edit event (see above for description)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "beforepropertychange",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before a property changes (return false to stop?)",
+ "sig" : "function (grid, id, newval, oldval)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "grid",
+ "type" : "Roo.grid.PropertyGrid",
+ "desc" : "property grid? (check could be store)",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
"type" : "String",
- "desc" : "The type of event to listen for",
+ "desc" : "Record Id",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "newval",
+ "type" : "String",
+ "desc" : "New Value",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "oldval",
+ "type" : "String",
+ "desc" : "Old Value",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "bodyscroll",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the body element is scrolled",
+ "sig" : "function (scrollLeft, scrollTop)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "scrollLeft",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollTop",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "reset",
+ "name" : "cellclick",
"type" : "function",
- "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a cell is clicked",
+ "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "resetHasChanged",
+ "name" : "cellcontextmenu",
"type" : "function",
- "desc" : "stores the current value in loadedValue",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a cell is right clicked",
+ "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "cellIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "selectText",
+ "name" : "celldblclick",
"type" : "function",
- "desc" : "Selects text in this field",
- "sig" : "(start, end)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a cell is double clicked",
+ "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "start",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
"type" : "Number",
- "desc" : "(optional) The index where the selection should start (defaults to 0)",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "end",
+ "name" : "columnIndex",
"type" : "Number",
- "desc" : "(optional) The index where the selection should end (defaults to the text length)",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "click",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw click event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "setPagePosition",
+ "name" : "columnmove",
"type" : "function",
- "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
- "sig" : "(x, y)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the user moves a column",
+ "sig" : "function (oldIndex, newIndex)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "x",
+ "name" : "oldIndex",
"type" : "Number",
- "desc" : "The new x position",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "y",
+ "name" : "newIndex",
"type" : "Number",
- "desc" : "The new y position",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setPosition",
+ "name" : "columnresize",
"type" : "function",
- "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
- "sig" : "(left, top)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the user resizes a column",
+ "sig" : "function (columnIndex, newSize)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "left",
+ "name" : "columnIndex",
"type" : "Number",
- "desc" : "The new left",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "top",
+ "name" : "newSize",
"type" : "Number",
- "desc" : "The new top",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setRawValue",
+ "name" : "contextmenu",
"type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw contextmenu event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setSize",
+ "name" : "dblclick",
"type" : "function",
- "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
- "sig" : "(width, height)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw dblclick event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "width",
- "type" : "Number/Object",
- "desc" : "The new width to set, or a size object in the format {width, height}",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "dragdrop",
+ "type" : "function",
+ "desc" : "Fires when dragged row(s) are dropped on a valid DD target",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "The new height to set (not required if a size object is passed as the first arg)",
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.BoxComponent",
- "desc" : "this"
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "setValue",
+ "name" : "dragenter",
"type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "dragout",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "show",
+ "name" : "dragover",
"type" : "function",
- "desc" : "Show this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "syncSize",
+ "name" : "enddrag",
"type" : "function",
- "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a drag operation is complete",
+ "sig" : "function (_self, dd, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "un",
+ "name" : "headerclick",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a header is clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "updateBox",
+ "name" : "headercontextmenu",
"type" : "function",
- "desc" : "Sets the current box measurements of the component's underlying element.",
- "sig" : "(box)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a header is right clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "box",
- "type" : "Object",
- "desc" : "An object in the format {x, y, width, height}",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "validate",
+ "name" : "headerdblclick",
"type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a header cell is double clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "validateValue",
+ "name" : "keydown",
"type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw keydown event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.form.ComboBox",
- "Roo.form.ComboBoxArray",
- "Roo.form.ComboCheck",
- "Roo.form.ComboNested",
- "Roo.form.DateField",
- "Roo.form.FCKeditor",
- "Roo.form.Hidden",
- "Roo.form.MonthField",
- "Roo.form.NumberField",
- "Roo.form.Select",
- "Roo.form.TextArea",
- "Roo.form.TriggerField"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.form.TextItem" : {
- "props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
- },
- {
- "name" : "html",
- "type" : "String",
- "desc" : "the content for this item",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "css styles to add to component\neg. text-align:right;",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "tag",
- "type" : "String",
- "desc" : "the tag for this item (default div)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "returns" : []
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "beforedestroy",
+ "name" : "keypress",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "The raw keypress event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforehide",
+ "name" : "mousedown",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "The raw mousedown event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "mouseout",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "The raw mouseout event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "mouseover",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "The raw mouseover event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "mouseup",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "The raw mouseup event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "disable",
+ "name" : "propertychange",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires after a property changes",
+ "sig" : "function (grid, id, newval, oldval)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "grid",
+ "type" : "Roo.grid.PropertyGrid",
+ "desc" : "property grid? (check could be store)",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "Record Id",
+ "isOptional" : false
+ },
+ {
+ "name" : "newval",
+ "type" : "String",
+ "desc" : "New Value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldval",
+ "type" : "String",
+ "desc" : "Old Value",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enable",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when the grid is rendered",
+ "sig" : "function (grid)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "grid",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "hide",
+ "name" : "rowclass",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a row is rendered, so you can change add a style to it.",
+ "sig" : "function (gridview, rowcfg)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "gridview",
+ "type" : "GridView",
+ "desc" : "The grid view",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowcfg",
+ "type" : "Object",
+ "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "move",
+ "name" : "rowclick",
"type" : "function",
- "desc" : "Fires after the component is moved.",
- "sig" : "function (_self, x, y)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
+ "desc" : "Fires when a row is clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
},
{
- "name" : "x",
+ "name" : "rowIndex",
"type" : "Number",
- "desc" : "The new x position",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "rowcontextmenu",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a row is right clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "resize",
+ "name" : "rowdblclick",
"type" : "function",
- "desc" : "Fires after the component is resized.",
- "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
+ "desc" : "Fires when a row is double clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
},
{
- "name" : "adjWidth",
+ "name" : "rowIndex",
"type" : "Number",
- "desc" : "The box-adjusted width that was set",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "startdrag",
+ "type" : "function",
+ "desc" : "Fires when row(s) start being dragged",
+ "sig" : "function (_self, dd, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
"isOptional" : false
},
{
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "validateedit",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires after a cell is edited, but before the value is set in the record. \nYou can use this to modify the value being set in the field, Return false\nto cancel the change. The edit event object has the following properties <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>editor - This editor</li>\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.EditorGrid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "An edit event (see above for description)",
"isOptional" : false
}
],
}
],
"methods" : [
+ {
+ "name" : "addColumns",
+ "type" : "function",
+ "desc" : "addColumns\nAdd's a column, default at the end..",
+ "sig" : "(position, of)",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "position",
+ "type" : "int",
+ "desc" : "to add (default end)",
+ "isOptional" : false
+ },
+ {
+ "name" : "of",
+ "type" : "Array",
+ "desc" : "objects of column configuration see {@link Roo.grid.ColumnModel}",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "addEvents",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
{
"name" : "destroy",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Destroy this grid.",
+ "sig" : "(removeEl)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "removeEl",
+ "type" : "Boolean",
+ "desc" : "True to remove the element",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "enable",
+ "name" : "getColumnModel",
"type" : "function",
- "desc" : "Enable this component.",
+ "desc" : "Returns the grid's ColumnModel.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "ColumnModel",
+ "desc" : ""
}
]
},
{
- "name" : "fireEvent",
+ "name" : "getDataSource",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Returns the grid's DataSource.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "DataSource",
+ "desc" : ""
}
]
},
{
- "name" : "focus",
+ "name" : "getDragDropText",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.grid.EditorGrid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
}
- ],
+ ]
+ },
+ {
+ "name" : "getGridEl",
+ "type" : "function",
+ "desc" : "Returns the grid's underlying element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "getBox",
+ "name" : "getSelectionModel",
"type" : "function",
- "desc" : "Gets the current box measurements of the component's underlying element.",
- "sig" : "(local)",
+ "desc" : "Returns the grid's SelectionModel.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
- "isOptional" : false
+ "name" : "",
+ "type" : "SelectionModel",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "getEl",
+ "name" : "getSource",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Gets all the data from the grid.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "Object",
+ "desc" : "data data stored in grid"
}
]
},
{
- "name" : "getId",
+ "name" : "getView",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Returns the grid's GridView object.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
+ "type" : "GridView",
"desc" : ""
}
]
},
{
- "name" : "getPosition",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Gets the current XY position of the component's underlying element.",
- "sig" : "(local)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Array",
- "desc" : "The XY position of the element (e.g., [100, 200])"
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "getSize",
+ "name" : "on",
"type" : "function",
- "desc" : "Gets the current size of the component's underlying element.",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "reconfigure",
+ "type" : "function",
+ "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.",
+ "sig" : "(dataSource, The)",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Object",
- "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
+ "name" : "dataSource",
+ "type" : "Roo.data.Store",
+ "desc" : "The new {@link Roo.data.Store} object",
+ "isOptional" : false
+ },
+ {
+ "name" : "The",
+ "type" : "Roo.grid.ColumnModel",
+ "desc" : "new {@link Roo.grid.ColumnModel} object",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The name of the event to check for",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hide",
+ "name" : "render",
"type" : "function",
- "desc" : "Hide this component.",
+ "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
+ "type" : "Roo.grid.Grid",
"desc" : "this"
}
]
},
{
- "name" : "isVisible",
+ "name" : "setSource",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
+ "desc" : "Sets the data for the Grid\naccepts a Key => Value object of all the elements avaiable.",
+ "sig" : "(data)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "to appear in grid.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "startEditing",
+ "type" : "function",
+ "desc" : "Starts editing the specified for the specified row/column",
+ "sig" : "(rowIndex, colIndex)",
+ "static" : false,
+ "memberOf" : "Roo.grid.EditorGrid",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "colIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "stopEditing",
+ "type" : "function",
+ "desc" : "Stops any active editing",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.grid.EditorGrid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "on",
+ "name" : "un",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.grid.RowSelectionModel" : {
+ "props" : [
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "singleSelect",
+ "type" : "Boolean",
+ "desc" : "True to allow selection of only one row at a time (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "afterselectionchange",
+ "type" : "function",
+ "desc" : "Fires after the selection changes (eg. by key press or clicking)",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "this",
+ "type" : "SelectionModel",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onPosition",
+ "name" : "beforerowselect",
"type" : "function",
- "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
- "sig" : "(x, y)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a row is selected being selected, return false to cancel.",
+ "sig" : "function (_self, rowIndex, keepExisting)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "x",
+ "name" : "this",
+ "type" : "SelectionModel",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
"type" : "Number",
- "desc" : "The new x position",
+ "desc" : "The selected index",
"isOptional" : false
},
{
- "name" : "y",
+ "name" : "keepExisting",
+ "type" : "Boolean",
+ "desc" : "False if other selections will be cleared",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "rowdeselect",
+ "type" : "function",
+ "desc" : "Fires when a row is deselected.",
+ "sig" : "function (_self, rowIndex)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "SelectionModel",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
"type" : "Number",
- "desc" : "The new y position",
+ "desc" : "The selected index",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onResize",
+ "name" : "rowselect",
"type" : "function",
- "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
- "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a row is selected.",
+ "sig" : "function (_self, rowIndex, r)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
+ "name" : "this",
+ "type" : "SelectionModel",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "rawWidth",
+ "name" : "rowIndex",
"type" : "Number",
- "desc" : "The width that was originally specified",
+ "desc" : "The selected index",
"isOptional" : false
},
{
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
+ "name" : "r",
+ "type" : "Roo.data.Record",
+ "desc" : "The record",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "selectionchange",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the selection changes",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "SelectionModel",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "releaseCapture",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
"memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "capture",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "clearSelections",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Clears all selections.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setPagePosition",
+ "name" : "deselectRange",
"type" : "function",
- "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
- "sig" : "(x, y)",
+ "desc" : "Deselects a range of rows. All rows in between startRow and endRow are also deselected.",
+ "sig" : "(startRow, endRow)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "x",
+ "name" : "startRow",
"type" : "Number",
- "desc" : "The new x position",
+ "desc" : "The index of the first row in the range",
"isOptional" : false
},
{
- "name" : "y",
+ "name" : "endRow",
"type" : "Number",
- "desc" : "The new y position",
+ "desc" : "The index of the last row in the range",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setPosition",
+ "name" : "deselectRow",
"type" : "function",
- "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
- "sig" : "(left, top)",
+ "desc" : "Deselects a row.",
+ "sig" : "(row)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "left",
- "type" : "Number",
- "desc" : "The new left",
- "isOptional" : false
- },
- {
- "name" : "top",
+ "name" : "row",
"type" : "Number",
- "desc" : "The new top",
+ "desc" : "The index of the row to deselect",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setSize",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
- "sig" : "(width, height)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "width",
- "type" : "Number/Object",
- "desc" : "The new width to set, or a size object in the format {width, height}",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "The new height to set (not required if a size object is passed as the first arg)",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.BoxComponent",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "setVisible",
+ "name" : "getCount",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Gets the number of selected rows.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Number",
+ "desc" : ""
}
]
},
{
- "name" : "show",
+ "name" : "getSelected",
"type" : "function",
- "desc" : "Show this component.",
+ "desc" : "Returns the first selected record.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Record",
+ "desc" : ""
}
]
},
{
- "name" : "syncSize",
+ "name" : "getSelections",
"type" : "function",
- "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
+ "desc" : "Returns the selected records",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "Array of selected records"
+ }
+ ]
},
{
- "name" : "un",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "updateBox",
+ "name" : "hasSelection",
"type" : "function",
- "desc" : "Sets the current box measurements of the component's underlying element.",
- "sig" : "(box)",
+ "desc" : "Returns True if there is a selection.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "box",
- "type" : "Object",
- "desc" : "An object in the format {x, y, width, height}",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
}
- ],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.form.TriggerField" : {
- "props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowLeadingSpace",
- "type" : "Boolean",
- "desc" : "True to prevent the stripping of leading white space",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoCreate",
- "type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"16\", autocomplete: \"off\"})",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "emptyText",
- "type" : "String",
- "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fieldClass",
- "type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fieldLabel",
- "type" : "String",
- "desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
]
},
{
- "name" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "inputType",
- "type" : "String",
- "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelSeparator",
- "type" : "String",
- "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "msgFx",
- "type" : "String",
- "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "msgTarget",
- "type" : "String",
- "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "name",
- "type" : "String",
- "desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "qtip",
- "type" : "String",
- "desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "css styles to add to component\neg. text-align:right;",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "tabIndex",
- "type" : "Number",
- "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "triggerClass",
- "type" : "String",
- "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.form.TextField",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "autosize",
+ "name" : "isIdSelected",
"type" : "function",
- "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
- "sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : "Roo.form.TextField",
+ "desc" : "Returns True if the specified record id is selected.",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "This text field",
- "isOptional" : false
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The new field width",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of record to check",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "beforedestroy",
+ "name" : "isLocked",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Returns true if the selections are locked.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.AbstractSelectionModel",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "beforehide",
+ "name" : "isSelected",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Returns True if the specified row is selected.",
+ "sig" : "(record)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "record",
+ "type" : "Number/Record",
+ "desc" : "The record or index of the record to check",
"isOptional" : false
}
],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "lock",
+ "type" : "function",
+ "desc" : "Locks the selections.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.AbstractSelectionModel",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "on",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "blur",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "change",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "selectAll",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Selects all rows.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "selectFirstRow",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Selects the first row in the grid.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "enable",
+ "name" : "selectLastRow",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Select the last row.",
+ "sig" : "(keepExisting)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "keepExisting",
+ "type" : "Boolean",
+ "desc" : "(optional) True to keep existing selections",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "focus",
+ "name" : "selectNext",
"type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Selects the row immediately following the last selected row.",
+ "sig" : "(keepExisting)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "keepExisting",
+ "type" : "Boolean",
+ "desc" : "(optional) True to keep existing selections",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "hide",
+ "name" : "selectPrevious",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Selects the row that precedes the last selected row.",
+ "sig" : "(keepExisting)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "keepExisting",
+ "type" : "Boolean",
+ "desc" : "(optional) True to keep existing selections",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "invalid",
+ "name" : "selectRange",
"type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Selects a range of rows. All rows in between startRow and endRow are also selected.",
+ "sig" : "(startRow, endRow, keepExisting)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "startRow",
+ "type" : "Number",
+ "desc" : "The index of the first row in the range",
"isOptional" : false
},
{
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
+ "name" : "endRow",
+ "type" : "Number",
+ "desc" : "The index of the last row in the range",
+ "isOptional" : false
+ },
+ {
+ "name" : "keepExisting",
+ "type" : "Boolean",
+ "desc" : "(optional) True to retain existing selections",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "keyup",
+ "name" : "selectRecords",
"type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Select records.",
+ "sig" : "(records, keepExisting)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "records",
+ "type" : "Array",
+ "desc" : "The records to select",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
+ "name" : "keepExisting",
+ "type" : "Boolean",
+ "desc" : "(optional) True to keep existing selections",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "move",
+ "name" : "selectRow",
"type" : "function",
- "desc" : "Fires after the component is moved.",
- "sig" : "function (_self, x, y)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
+ "desc" : "Selects a row.",
+ "sig" : "(row, keepExisting)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "x",
+ "name" : "row",
"type" : "Number",
- "desc" : "The new x position",
+ "desc" : "The index of the row to select",
"isOptional" : false
},
{
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
+ "name" : "keepExisting",
+ "type" : "Boolean",
+ "desc" : "(optional) True to keep existing selections",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "selectRows",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Selects multiple rows.",
+ "sig" : "(rows, keepExisting)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "rows",
+ "type" : "Array",
+ "desc" : "Array of the indexes of the row to select",
+ "isOptional" : false
+ },
+ {
+ "name" : "keepExisting",
+ "type" : "Boolean",
+ "desc" : "(optional) True to keep existing selections",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resize",
+ "name" : "un",
"type" : "function",
- "desc" : "Fires after the component is resized.",
- "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "unlock",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Unlocks the selections.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.AbstractSelectionModel",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.grid.SplitDragZone" : {
+ "props" : [
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "specialkey",
+ "name" : "addInvalidHandleClass",
"type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Lets you specify a css class of elements that will not initiate a drag",
+ "sig" : "(cssClass)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the elements you wish to ignore",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "valid",
+ "name" : "addInvalidHandleId",
"type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "id",
+ "type" : "string",
+ "desc" : "the element id of the element you wish to ignore",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "addEvents",
+ "name" : "addInvalidHandleType",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
+ "sig" : "(tagName)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to exclude",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "applyTo",
+ "name" : "addToGroup",
"type" : "function",
- "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
- "sig" : "(el)",
+ "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
+ "sig" : "(sGroup)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id of the node, a DOM node or an existing Element",
+ "name" : "sGroup",
+ "type" : "",
+ "desc" : "{string} the name of the group",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "alignElWithMouse",
+ "type" : "function",
+ "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
+ "sig" : "(el, iPageX, iPageY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DD",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.form.Field",
- "desc" : "this"
+ "name" : "el",
+ "type" : "HTMLElement",
+ "desc" : "the element to move",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the mousedown or drag event",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the mousedown or drag event",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "autoSize",
+ "name" : "applyConfig",
"type" : "function",
- "desc" : "",
+ "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
+ {
+ "name" : "autoOffset",
+ "type" : "function",
+ "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked",
+ "sig" : "(iPageX, iPageY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DD",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the click",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the click",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "cachePosition",
+ "type" : "function",
+ "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.",
+ "sig" : "(iPageX, iPageY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DD",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "iPageX",
+ "type" : "",
+ "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageY",
+ "type" : "",
+ "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
"returns" : []
},
{
- "name" : "clearInvalid",
+ "name" : "clearConstraints",
"type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
+ "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "clearTicks",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "desc" : "Clears any tick interval defined for this instance",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "disable",
+ "name" : "createFrame",
"type" : "function",
- "desc" : "Disable this component.",
+ "desc" : "Creates the proxy element if it does not yet exist",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.dd.DDProxy",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "enable",
+ "name" : "endDrag",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fired when we are done dragging the object",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
"name" : "fireEvent",
]
},
{
- "name" : "focus",
+ "name" : "getDragEl",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "HTMLElement",
+ "desc" : "the html element"
}
]
},
{
- "name" : "getBox",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Gets the current box measurements of the component's underlying element.",
- "sig" : "(local)",
+ "desc" : "Returns a reference to the linked element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
- "isOptional" : false
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "the html element"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "getEl",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "getId",
+ "name" : "init",
"type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
+ "sig" : "(id, sGroup, config)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the linked element",
+ "isOptional" : false
+ },
+ {
+ "name" : "sGroup",
"type" : "String",
- "desc" : ""
+ "desc" : "the group of related items",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "object",
+ "desc" : "configuration attributes",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getName",
+ "name" : "initFrame",
"type" : "function",
- "desc" : "Returns the name attribute of the field if available",
+ "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.dd.DDProxy",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "name The field name"
- }
- ]
+ "returns" : []
},
{
- "name" : "getPosition",
+ "name" : "initTarget",
"type" : "function",
- "desc" : "Gets the current XY position of the component's underlying element.",
- "sig" : "(local)",
+ "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
+ "sig" : "(id, sGroup, config)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the linked element",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Array",
- "desc" : "The XY position of the element (e.g., [100, 200])"
+ "name" : "sGroup",
+ "type" : "String",
+ "desc" : "the group of related items",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "object",
+ "desc" : "configuration attributes",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getRawValue",
+ "name" : "isLocked",
"type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "boolean",
+ "desc" : "true if this obj or all drag/drop is locked, else\nfalse"
}
]
},
{
- "name" : "getSize",
+ "name" : "isTarget",
"type" : "function",
- "desc" : "Gets the current size of the component's underlying element.",
+ "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
- }
- ]
+ "returns" : []
},
{
- "name" : "getValue",
+ "name" : "isValidHandleChild",
"type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Checks the tag exclusion list to see if this click should be ignored",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "node",
+ "type" : "HTMLElement",
+ "desc" : "the HTMLElement to evaluate",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "boolean",
+ "desc" : "true if this is a valid tag type, false if not"
}
]
},
{
- "name" : "hasChanged",
+ "name" : "lock",
"type" : "function",
- "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
+ "desc" : "Lock this instance",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "hasListener",
+ "name" : "on",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The name of the event to check for",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hide",
+ "name" : "onAvailable",
"type" : "function",
- "desc" : "Hide this component.",
+ "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "isDirty",
+ "name" : "onDrag",
"type" : "function",
- "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "isValid",
+ "name" : "onDragDrop",
"type" : "function",
- "desc" : "Returns whether or not the field value is currently valid",
- "sig" : "(preventMark)",
+ "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "True to disable marking the field invalid",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "isVisible",
+ "name" : "onDragEnter",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "markInvalid",
+ "name" : "onDragOut",
"type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
+ "desc" : "Abstract method called when we are no longer hovering over an element",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "on",
+ "name" : "onDragOver",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onPosition",
+ "name" : "onInvalidDrop",
"type" : "function",
- "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
- "sig" : "(x, y)",
+ "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onResize",
+ "name" : "onMouseDown",
"type" : "function",
- "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
- "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
- "isOptional" : false
- },
- {
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
- "isOptional" : false
- },
- {
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousedown event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onTriggerClick",
+ "name" : "onMouseUp",
"type" : "function",
- "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
"sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [
{
"name" : "e",
- "type" : "EventObject",
- "desc" : "",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "padding",
+ "type" : "function",
+ "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "purgeListeners",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "removeFromGroup",
+ "type" : "function",
+ "desc" : "Remove's this instance from the supplied interaction group",
+ "sig" : "(sGroup)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "sGroup",
+ "type" : "string",
+ "desc" : "The group to drop",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeInvalidHandleClass",
+ "type" : "function",
+ "desc" : "Unsets an invalid css class",
+ "sig" : "(cssClass)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the element(s) you wish to\nre-enable",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeInvalidHandleId",
+ "type" : "function",
+ "desc" : "Unsets an invalid handle id",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "string",
+ "desc" : "the id of the element to re-enable",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeInvalidHandleType",
+ "type" : "function",
+ "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
+ "sig" : "(tagName)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to unexclude",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "removeListener",
"type" : "function",
"returns" : []
},
{
- "name" : "render",
+ "name" : "resetConstraints",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "resetConstraints must be called if you manually reposition a dd element.",
+ "sig" : "(maintainOffset)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "maintainOffset",
+ "type" : "boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "reset",
+ "name" : "setDelta",
"type" : "function",
- "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)",
+ "sig" : "(iDeltaX, iDeltaY)",
"static" : false,
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "iDeltaX",
+ "type" : "int",
+ "desc" : "the distance from the left",
+ "isOptional" : false
+ },
+ {
+ "name" : "iDeltaY",
+ "type" : "int",
+ "desc" : "the distance from the top",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "resetHasChanged",
+ "name" : "setDragElId",
"type" : "function",
- "desc" : "stores the current value in loadedValue",
- "sig" : "()\n{\n\n}",
+ "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "",
+ "desc" : "{string} the id of the element that will be used to initiate the drag",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "selectText",
+ "name" : "setDragElPos",
"type" : "function",
- "desc" : "Selects text in this field",
- "sig" : "(start, end)",
+ "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
+ "sig" : "(iPageX, iPageY)",
"static" : false,
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "start",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should start (defaults to 0)",
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the mousedown or drag event",
"isOptional" : false
},
{
- "name" : "end",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should end (defaults to the text length)",
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the mousedown or drag event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "setHandleElId",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "id",
+ "type" : "",
+ "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setPagePosition",
+ "name" : "setInitPosition",
"type" : "function",
- "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
- "sig" : "(x, y)",
+ "desc" : "Stores the initial placement of the linked element.",
+ "sig" : "(diffX, diffY)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
+ "name" : "diffX",
+ "type" : "int",
+ "desc" : "the X offset, default 0",
"isOptional" : false
},
{
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
+ "name" : "diffY",
+ "type" : "int",
+ "desc" : "the Y offset, default 0",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setPosition",
+ "name" : "setOuterHandleElId",
"type" : "function",
- "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
- "sig" : "(left, top)",
+ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "left",
- "type" : "Number",
- "desc" : "The new left",
- "isOptional" : false
- },
- {
- "name" : "top",
- "type" : "Number",
- "desc" : "The new top",
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the element that will be used to initiate the drag",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setRawValue",
+ "name" : "setPadding",
"type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
+ "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
+ "sig" : "(iTop, iRight, iBot, iLeft)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "iTop",
+ "type" : "int",
+ "desc" : "Top pad",
+ "isOptional" : false
+ },
+ {
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "Right pad",
+ "isOptional" : false
+ },
+ {
+ "name" : "iBot",
+ "type" : "int",
+ "desc" : "Bot pad",
+ "isOptional" : false
+ },
+ {
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "Left pad",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setSize",
+ "name" : "setXConstraint",
"type" : "function",
- "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
- "sig" : "(width, height)",
+ "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
+ "sig" : "(iLeft, iRight, iTickSize)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "width",
- "type" : "Number/Object",
- "desc" : "The new width to set, or a size object in the format {width, height}",
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the left",
"isOptional" : false
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "The new height to set (not required if a size object is passed as the first arg)",
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the\nright",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.BoxComponent",
- "desc" : "this"
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "setValue",
+ "name" : "setYConstraint",
"type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
+ "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
+ "sig" : "(iUp, iDown, iTickSize)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "iUp",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move up",
+ "isOptional" : false
+ },
+ {
+ "name" : "iDown",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move down",
+ "isOptional" : false
+ },
+ {
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "startDrag",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
+ "sig" : "(X, Y)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "X",
+ "type" : "int",
+ "desc" : "click location",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "Y",
+ "type" : "int",
+ "desc" : "click location",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "show",
+ "name" : "toString",
"type" : "function",
- "desc" : "Show this component.",
+ "desc" : "toString method",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "string",
+ "desc" : "string representation of the dd obj"
}
]
},
- {
- "name" : "syncSize",
- "type" : "function",
- "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "un",
"type" : "function",
"returns" : []
},
{
- "name" : "updateBox",
+ "name" : "unlock",
"type" : "function",
- "desc" : "Sets the current box measurements of the component's underlying element.",
- "sig" : "(box)",
+ "desc" : "Unlock this instace",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "box",
- "type" : "Object",
- "desc" : "An object in the format {x, y, width, height}",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "validate",
+ "name" : "unreg",
"type" : "function",
- "desc" : "Validates the field value",
+ "desc" : "Remove all drag and drop hooks for this element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.Block" : {
+ "props" : [
+ {
+ "name" : "Context",
+ "type" : "Object",
+ "desc" : "menu - see Roo.form.HtmlEditor.ToolbarContext",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "validateValue",
+ "name" : "friendly_name",
+ "type" : "String",
+ "desc" : "the name that appears in the context bar about this block",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "The node to apply stuff to.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "factory",
"type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
+ "desc" : "factory method to get the block from an element (using cache if necessary)",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
+ "name" : "the",
+ "type" : "HtmlElement",
+ "desc" : "dom element",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.form.ComboBox",
- "Roo.form.ComboCheck",
- "Roo.form.ComboNested",
- "Roo.form.DateField",
- "Roo.form.MonthField",
- "Roo.form.Select"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.form.VTypes" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ "returns" : []
+ },
{
- "name" : "alpha",
+ "name" : "getVal",
"type" : "function",
- "desc" : "The function used to validate alpha values",
- "sig" : "(value)",
+ "desc" : "used by readEleemnt to extract data from a node\nmay need improving as it's pretty basic",
+ "sig" : "(node, tag, attribute, style)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "tag",
"type" : "String",
- "desc" : "The value",
+ "desc" : "- tag to find, eg. IMG ?? might be better to use DomQuery ?",
+ "isOptional" : false
+ },
+ {
+ "name" : "attribute",
+ "type" : "String",
+ "desc" : "(use html - for contents, style for using next param as style, or false to return the node)",
+ "isOptional" : false
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "the style property - eg. text-align",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "alphanum",
+ "name" : "initAll",
"type" : "function",
- "desc" : "The function used to validate alphanumeric values",
- "sig" : "(value)",
- "static" : false,
+ "desc" : "initalize all Elements from content that are 'blockable'",
+ "sig" : "(the)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "String",
- "desc" : "The value",
+ "name" : "the",
+ "type" : "",
+ "desc" : "body element",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "email",
+ "name" : "readElement",
"type" : "function",
- "desc" : "The function used to validate email addresses",
- "sig" : "(value)",
+ "desc" : "Read a node that has a 'data-block' property - and extract the values from it.",
+ "sig" : "(node)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "String",
- "desc" : "The email address",
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "- the node",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "url",
+ "name" : "toHTML",
"type" : "function",
- "desc" : "The function used to validate URLs",
- "sig" : "(value)",
+ "desc" : "convert to plain HTML for calling insertAtCursor..",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "String",
- "desc" : "The URL",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "urlWeb",
+ "name" : "toObject",
"type" : "function",
- "desc" : "The funciton used to validate URLs (only allow schemes 'https' and 'http')",
- "sig" : "(v)",
+ "desc" : "create a DomHelper friendly object - for use with \nRoo.DomHelper.markup / overwrite / etc..\n(override this)",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "updateElement",
+ "type" : "function",
+ "desc" : "Update a node with values from this object",
+ "sig" : "(node)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "v",
- "type" : "String",
- "desc" : "The URL",
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "",
"isOptional" : false
}
],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.grid" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.grid.AbstractGridView" : {
+ "Roo.htmleditor.BlockFigure" : {
"props" : [
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) alignment for the block default le",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
+ },
+ {
+ "name" : "caption",
+ "type" : "String",
+ "desc" : "the text to appear below (and in the alt tag)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "caption_display",
+ "type" : "String",
+ "desc" : "e) display or not the capti",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "block",
+ "none"
+ ]
+ },
+ {
+ "name" : "image_height",
+ "type" : "String|number",
+ "desc" : "the height of the image number or %?",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "image_src",
+ "type" : "String",
+ "desc" : "the url for the image",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "image_width",
+ "type" : "String|number",
+ "desc" : "the width of the image number or %?",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
}
"events" : [],
"methods" : [
{
- "name" : "addEvents",
+ "name" : "toObject",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "create a DomHelper friendly object - for use with\nRoo.DomHelper.markup / overwrite / etc..",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.BlockTable" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "addListener",
+ "name" : "toObject",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "create a DomHelper friendly object - for use with\nRoo.DomHelper.markup / overwrite / etc..\n?? should it be called with option to hide all editing features?",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.BlockTd" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "capture",
+ "name" : "toObject",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "create a DomHelper friendly object - for use with\nRoo.DomHelper.markup / overwrite / etc..\n?? should it be called with option to hide all editing features?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.Filter" : {
+ "props" : [
+ {
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "The node to iterate and filter",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "fireEvent",
+ "name" : "tag",
+ "type" : "boolean|String|Array",
+ "desc" : "Tags to replace",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.FilterAttributes" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.FilterBlack" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.FilterBlock" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.FilterComment" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.FilterHashLink" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.FilterKeepChildren" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.FilterLongBr" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.FilterParagraph" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.FilterSpan" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.FilterStyleToTag" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.FilterTableWidth" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.FilterWord" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "replaceTag",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Clean up MS wordisms...",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
+ "params" : [],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.KeyEnter" : {
+ "props" : [
+ {
+ "name" : "core",
+ "type" : "Roo.HtmlEditorCore",
+ "desc" : "the editor.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.TidyEntities" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "decode",
+ "type" : "function",
+ "desc" : "Decodes the specified string, this will replace entities with raw UTF characters.",
+ "sig" : "(text)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "text",
"type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "desc" : "Text to entity decode.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "String",
+ "desc" : "Entity decoded string."
}
]
},
{
- "name" : "hasListener",
+ "name" : "encodeAllRaw",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
+ "desc" : "Encoded the specified text with both the attributes and text entities. This function will produce larger text contents\nsince it doesn't know if the context is within a attribute or text node. This was added for compatibility\nand is exposed as the DOMUtils.encode function.",
+ "sig" : "(text)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "text",
"type" : "String",
- "desc" : "The name of the event to check for",
+ "desc" : "Text to encode.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "String",
+ "desc" : "Entity encoded text."
}
]
},
{
- "name" : "on",
+ "name" : "encodeNamed",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
+ "desc" : "Encodes the specified string using named entities. The core entities will be encoded\nas named ones but all non lower ascii characters will be encoded into named entities.",
+ "sig" : "(text, attr, entities)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "text",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "Text to encode.",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "attr",
+ "type" : "Boolean",
+ "desc" : "Optional flag to specify if the text is attribute contents.",
"isOptional" : false
},
{
- "name" : "options",
+ "name" : "entities",
"type" : "Object",
- "desc" : "(optional)",
+ "desc" : "Optional parameter with entities to use.",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "Entity encoded text."
+ }
+ ]
},
{
- "name" : "releaseCapture",
+ "name" : "encodeNumeric",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
+ "desc" : "Encodes the specified string using numeric entities. The core entities will be\nencoded as named ones but all non lower ascii characters will be encoded into numeric entities.",
+ "sig" : "(text, attr)",
"static" : true,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "text",
+ "type" : "String",
+ "desc" : "Text to encode.",
+ "isOptional" : false
+ },
+ {
+ "name" : "attr",
+ "type" : "Boolean",
+ "desc" : "Optional flag to specify if the text is attribute contents.",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "Entity encoded text."
+ }
+ ]
},
{
- "name" : "removeListener",
+ "name" : "encodeRaw",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
+ "desc" : "Encodes the specified string using raw entities. This means only the required XML base entities will be encoded.",
+ "sig" : "(text, attr)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "text",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "Text to encode.",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "attr",
+ "type" : "Boolean",
+ "desc" : "Optional flag to specify if the text is attribute contents.",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "Entity encoded text."
+ }
+ ]
},
{
- "name" : "setCSSStyle",
+ "name" : "getEncodeFunc",
"type" : "function",
- "desc" : "Set a css style for a column dynamically.",
- "sig" : "(colIndex, name, value)",
- "static" : false,
+ "desc" : "Returns an encode function based on the name(s) and it's optional entities.",
+ "sig" : "(name, entities)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"exceptions" : "",
"requires" : "",
"params" : [
- {
- "name" : "colIndex",
- "type" : "Number",
- "desc" : "The index of the column",
- "isOptional" : false
- },
{
"name" : "name",
"type" : "String",
- "desc" : "The css property name",
+ "desc" : "Comma separated list of encoders for example named,numeric.",
"isOptional" : false
},
{
- "name" : "value",
+ "name" : "entities",
"type" : "String",
- "desc" : "The css value",
+ "desc" : "Optional parameter with entities to use instead of the built in set.",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "function",
+ "desc" : "Encode function to be used."
+ }
+ ]
},
{
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
+ "name" : "init",
+ "type" : "function",
+ "desc" : "initialize data..",
+ "sig" : "()\n{\n\n}",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
}
],
- "isAbstract" : true,
+ "isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.grid.AbstractSelectionModel" : {
- "props" : [
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- }
- ],
+ "Roo.htmleditor.TidySerializer" : {
+ "props" : [],
"events" : [],
"methods" : [
{
- "name" : "addEvents",
+ "name" : "inner",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "",
+ "sig" : "(inner)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "inner",
+ "type" : "boolean",
+ "desc" : "do the inner of the node.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "serialize",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Serializes the specified node into a string.",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "example" : "",
+ "example" : "new tinymce.html.Serializer().serialize(new tinymce.html.DomParser().parse('<p>text</p>'));",
"deprecated" : "",
"since" : "",
"see" : "",
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "Node instance to serialize.",
"isOptional" : false
}
],
- "returns" : []
- },
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "String with HTML based on DOM tree."
+ }
+ ]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.TidyWriter" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "capture",
+ "name" : "cdata",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Writes a cdata node such as <![CDATA[data]]>.",
+ "sig" : "(text)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "text",
+ "type" : "String",
+ "desc" : "String to write out inside the cdata.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "comment",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Writes a comment node such as <!-- Comment -->.",
+ "sig" : "(text)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "text",
"type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "desc" : "String to write out inside the comment.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "doctype",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Writes a doctype node such as <!DOCTYPE data>.",
+ "sig" : "(text)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "text",
"type" : "String",
- "desc" : "The name of the event to check for",
+ "desc" : "String to write out inside the doctype.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "isLocked",
+ "name" : "end",
"type" : "function",
- "desc" : "Returns true if the selections are locked.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Writes the a end element such as </p>.",
+ "sig" : "(name)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "name" : "name",
+ "type" : "String",
+ "desc" : "Name of the element.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "lock",
+ "name" : "getContent",
"type" : "function",
- "desc" : "Locks the selections.",
+ "desc" : "Returns the contents that got serialized.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "HTML contents that got written down."
+ }
+ ]
},
{
- "name" : "on",
+ "name" : "pi",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Writes a PI node such as <?xml attr=\"value\" ?>.",
+ "sig" : "(name, text)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "name",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "desc" : "Name of the pi.",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "text",
+ "type" : "String",
+ "desc" : "String to write out inside the pi.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "reset",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Resets the internal buffer if one wants to reuse the writer.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "removeListener",
+ "name" : "start",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Writes the a start element such as <p id=\"a\">.",
+ "sig" : "(name, attrs, empty)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "name",
"type" : "String",
- "desc" : "The type of event to listen for",
+ "desc" : "Name of the element.",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "attrs",
+ "type" : "Array",
+ "desc" : "Optional attribute array or undefined if it hasn't any.",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "empty",
+ "type" : "Boolean",
+ "desc" : "Optional empty state if the tag should end like <br />.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "un",
+ "name" : "text",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Writes a text node.\n\nIn pre - we should not mess with the contents.",
+ "sig" : "(text, raw)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "text",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "String to write out.",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "raw",
+ "type" : "Boolean",
+ "desc" : "Optional raw state if true the contents wont get encoded.",
"isOptional" : false
}
],
"returns" : []
- },
- {
- "name" : "unlock",
- "type" : "function",
- "desc" : "Unlocks the selections.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
}
],
- "isAbstract" : true,
+ "isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.grid.CellSelectionModel",
- "Roo.grid.RowSelectionModel"
- ],
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.grid.Calendar" : {
+ "Roo.layout" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.layout.BasicRegion" : {
"props" : [
- {
- "name" : "autoExpandColumn",
- "type" : "String",
- "desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoExpandMax",
- "type" : "Number",
- "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoExpandMin",
- "type" : "Number",
- "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoHeight",
- "type" : "Boolean",
- "desc" : "True to fit the height of the grid container to the height of the data. Default is false.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoSizeColumns",
- "type" : "Boolean",
- "desc" : "True to automatically resize the columns to fit their content\n<b>on initial render.</b> It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoSizeHeaders",
- "type" : "Boolean",
- "desc" : "True to measure headers with column data when auto sizing columns. Default is true.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoWidth",
- "type" : "Boolean",
- "desc" : "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cm[]",
- "type" : "Roo.grid.ColumnModel",
- "desc" : "The columns of the grid",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "ddGroup",
- "type" : "String",
- "desc" : "- drag drop group.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "ddText",
- "type" : "String",
- "desc" : "Configures the text is the drag proxy (defaults to \"%0 selected row(s)\").\n%0 is replaced with the number of selected rows.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "dragGroup",
- "type" : "String",
- "desc" : "- drag group (?? not sure if needed.)",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "dropTarget",
- "type" : "Roo.dd.DropTarget",
- "desc" : "An {@link Roo.dd.DropTarget} config",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "ds",
- "type" : "Roo.data.Store",
- "desc" : "The data store for the grid",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "enableColumnHide",
- "type" : "Boolean",
- "desc" : "True to enable hiding of columns with the header context menu. Default is true.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "enableColumnMove",
- "type" : "Boolean",
- "desc" : "True to enable drag and drop reorder of columns. Default is true.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "enableDrag",
- "type" : "Boolean",
- "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "enableDragDrop",
- "type" : "Boolean",
- "desc" : "True to enable drag and drop of rows. Default is false.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "enableDrop",
- "type" : "Boolean",
- "desc" : "True to enable drop of elements. Default is false. (double check if this is needed?)",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "enableRowHeightSync",
- "type" : "Boolean",
- "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "eventStore",
- "type" : "Store",
- "desc" : "The store that loads events.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "footer",
- "type" : "Roo.PagingToolbar",
- "desc" : "the paging toolbar",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
"memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
- },
- {
- "name" : "loadMask",
- "type" : "Object",
- "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxHeight",
- "type" : "Number",
- "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxRowsToMeasure",
- "type" : "Boolean",
- "desc" : "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minColumnWidth",
- "type" : "Number",
- "desc" : "The minimum width a column can be resized to. Default is 25.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "monitorWindowResize",
- "type" : "Boolean",
- "desc" : "True to autoSize the grid when the window resizes. Default is true.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "sm",
- "type" : "Roo.grid.AbstractSelectionModel",
- "desc" : "The selection Model (default = Roo.grid.RowSelectionModel)",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "sortColMenu",
- "type" : "boolean",
- "desc" : "Sort the column order menu when it shows (usefull for long lists..) default false",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "stripeRows",
- "type" : "Boolean",
- "desc" : "True to stripe the rows. Default is true.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "toolbar",
- "type" : "Roo.Toolbar",
- "desc" : "a toolbar for buttons etc.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "trackMouseOver",
- "type" : "Boolean",
- "desc" : "True to highlight rows when the mouse is over. Default is true.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "view",
- "type" : "Roo.grid.GridView",
- "desc" : "The view that renders the grid (default = Roo.grid.GridView)",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
}
],
"events" : [
{
- "name" : "bodyscroll",
+ "name" : "beforecollapse",
"type" : "function",
- "desc" : "Fires when the body element is scrolled",
- "sig" : "function (scrollLeft, scrollTop)\n{\n\n}",
+ "desc" : "Fires when this region before collapse.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "scrollLeft",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "scrollTop",
- "type" : "Number",
+ "name" : "this",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "cellclick",
+ "name" : "beforeremove",
"type" : "function",
- "desc" : "Fires when a cell is clicked",
- "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "desc" : "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument.",
+ "sig" : "function (_self, panel, e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
},
{
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "panel",
+ "type" : "Roo.panel.Content",
+ "desc" : "The panel",
"isOptional" : false
},
{
"name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "type" : "Object",
+ "desc" : "The cancel event object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "cellcontextmenu",
+ "name" : "collapsed",
"type" : "function",
- "desc" : "Fires when a cell is right clicked",
- "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
+ "desc" : "Fires when this region is collapsed.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "cellIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "celldblclick",
+ "name" : "expanded",
"type" : "function",
- "desc" : "Fires when a cell is double clicked",
- "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "desc" : "Fires when this region is expanded.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "click",
+ "name" : "invalidated",
"type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
+ "desc" : "Fires when the layout for this region is changed.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "columnmove",
+ "name" : "panelactivated",
"type" : "function",
- "desc" : "Fires when the user moves a column",
- "sig" : "function (oldIndex, newIndex)\n{\n\n}",
+ "desc" : "Fires when a panel is activated.",
+ "sig" : "function (_self, panel)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "oldIndex",
- "type" : "Number",
+ "name" : "this",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
},
{
- "name" : "newIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "panel",
+ "type" : "Roo.panel.Content",
+ "desc" : "The activated panel",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "columnresize",
+ "name" : "paneladded",
"type" : "function",
- "desc" : "Fires when the user resizes a column",
- "sig" : "function (columnIndex, newSize)\n{\n\n}",
+ "desc" : "Fires when a panel is added.",
+ "sig" : "function (_self, panel)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "columnIndex",
- "type" : "Number",
+ "name" : "this",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
},
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "",
+ "name" : "panel",
+ "type" : "Roo.panel.Content",
+ "desc" : "The panel",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "contextmenu",
+ "name" : "panelremoved",
"type" : "function",
- "desc" : "The raw contextmenu event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
+ "desc" : "Fires when a panel is removed.",
+ "sig" : "function (_self, panel)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "panel",
+ "type" : "Roo.panel.Content",
+ "desc" : "The panel",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "dblclick",
+ "name" : "resized",
"type" : "function",
- "desc" : "The raw dblclick event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
+ "desc" : "Fires when the user resizes this region.",
+ "sig" : "function (_self, newSize)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new size (width for east/west, height for north/south)",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "dragdrop",
+ "name" : "slidehide",
"type" : "function",
- "desc" : "Fires when dragged row(s) are dropped on a valid DD target",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "desc" : "Fires when this region slides out of view.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
- "isOptional" : false
- },
- {
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "dragenter",
+ "name" : "slideshow",
"type" : "function",
- "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "desc" : "Fires when this region is slid into view.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
- "isOptional" : false
- },
- {
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "dragout",
+ "name" : "visibilitychange",
"type" : "function",
- "desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "desc" : "Fires when this region is shown or hidden",
+ "sig" : "function (_self, visibility)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
},
{
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
- "isOptional" : false
- },
- {
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "visibility",
+ "type" : "Boolean",
+ "desc" : "true or false",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "dragover",
+ "name" : "add",
"type" : "function",
- "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "desc" : "Add the passed ContentPanel(s)",
+ "sig" : "(panel)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
+ "name" : "panel",
+ "type" : "panel.Content...",
+ "desc" : "The ContentPanel(s) to add (you can pass more than one)",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
- "isOptional" : false
- },
+ "name" : "",
+ "type" : "Roo.panel.Content",
+ "desc" : "The panel added (if only one was added)"
+ }
+ ]
+ },
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enddrag",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Fires when a drag operation is complete",
- "sig" : "function (_self, dd, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "eventclick",
+ "name" : "capture",
"type" : "function",
- "desc" : "Fires when the mouse click an",
- "sig" : "function (_self, )\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Calendar",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "",
- "type" : "event",
- "desc" : "",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "evententer",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Fires when mouse over an event",
- "sig" : "function (_self, Event)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Calendar",
+ "name" : "eventName",
+ "type" : "String",
"desc" : "",
"isOptional" : false
},
{
- "name" : "Event",
- "type" : "event",
- "desc" : "",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "eventleave",
+ "name" : "getActivePanel",
"type" : "function",
- "desc" : "Fires when the mouse leaves an",
- "sig" : "function (_self, )\n{\n\n}",
+ "desc" : "Get the active panel for this region.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Calendar",
- "desc" : "",
- "isOptional" : false
- },
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
"name" : "",
- "type" : "event",
- "desc" : "",
- "isOptional" : false
+ "type" : "Roo.panel.Content",
+ "desc" : "The active panel or null"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "eventrender",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Fires before each cell is rendered, so you can modify the contents, like cls / title / qtip",
- "sig" : "function (_self, data)\n{\n\n}",
+ "desc" : "Returns the container element for this region.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Calendar",
- "desc" : "",
- "isOptional" : false
- },
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "data",
- "type" : "data",
- "desc" : "to be modified",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "headerclick",
+ "name" : "getPanel",
"type" : "function",
- "desc" : "Fires when a header is clicked",
- "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "desc" : "Returns the panel specified or null if it's not in this region.",
+ "sig" : "(panel)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "panel",
+ "type" : "Number/String/panel.Content",
+ "desc" : "The panels index, id or the panel itself",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.panel.Content",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "headercontextmenu",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "Fires when a header is right clicked",
- "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "desc" : "Returns this regions position (north/south/east/west/center).",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "headerdblclick",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Fires when a header cell is double clicked",
- "sig" : "function (_self, columnIndex, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "keydown",
+ "name" : "hasPanel",
"type" : "function",
- "desc" : "The raw keydown event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
+ "desc" : "Returns true if the panel is in this region.",
+ "sig" : "(panel)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "panel",
+ "type" : "Number/String/panel.Content",
+ "desc" : "The panels index, id or the panel itself",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "keypress",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "The raw keypress event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
+ "desc" : "Returns true if this region is currently visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "monthchange",
+ "name" : "on",
"type" : "function",
- "desc" : "Fires when the displayed month changes",
- "sig" : "function (_self, date)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "DatePicker",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "date",
- "type" : "Date",
- "desc" : "The selected month",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "mousedown",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "The raw mousedown event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "mouseout",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "The raw mouseout event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "mouseover",
+ "name" : "remove",
"type" : "function",
- "desc" : "The raw mouseover event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
+ "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
+ "sig" : "(panel, preservePanel)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "panel",
+ "type" : "Number/String/panel.Content",
+ "desc" : "The panels index, id or the panel itself",
+ "isOptional" : false
+ },
+ {
+ "name" : "preservePanel",
+ "type" : "Boolean",
+ "desc" : "Overrides the config preservePanel option",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.panel.Content",
+ "desc" : "The panel that was removed"
+ }
+ ]
},
{
- "name" : "mouseup",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "The raw mouseup event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "resizeTo",
"type" : "function",
- "desc" : "Fires when the grid is rendered",
- "sig" : "function (grid)\n{\n\n}",
+ "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
+ "sig" : "(newSize)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "grid",
- "type" : "Grid",
- "desc" : "",
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new width or height",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "rowclass",
+ "name" : "showPanel",
"type" : "function",
- "desc" : "Fires when a row is rendered, so you can change add a style to it.",
- "sig" : "function (gridview, rowcfg)\n{\n\n}",
+ "desc" : "Show the specified panel.",
+ "sig" : "(panelId)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "gridview",
- "type" : "GridView",
- "desc" : "The grid view",
- "isOptional" : false
- },
- {
- "name" : "rowcfg",
- "type" : "Object",
- "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.",
+ "name" : "panelId",
+ "type" : "Number/String/panel.Content",
+ "desc" : "The panels index, id or the panel itself",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.panel.Content",
+ "desc" : "The shown panel or null"
+ }
+ ]
},
{
- "name" : "rowclick",
+ "name" : "un",
"type" : "function",
- "desc" : "Fires when a row is clicked",
- "sig" : "function (_self, rowIndex, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.bootstrap.layout.Split",
+ "Roo.layout.Region",
+ "Roo.layout.SplitRegion"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.layout.Border" : {
+ "props" : [
+ {
+ "name" : "center",
+ "type" : "Roo.layout.Region",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "rowcontextmenu",
- "type" : "function",
- "desc" : "Fires when a row is right clicked",
- "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "name" : "east",
+ "type" : "Roo.layout.Region",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "north",
+ "type" : "Roo.layout.Region",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "south",
+ "type" : "Roo.layout.Region",
+ "desc" : "",
"memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "west",
+ "type" : "Roo.layout.Region",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "layout",
+ "type" : "function",
+ "desc" : "Fires when a layout is performed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.layout.Manager",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.layout.Manager",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "rowdblclick",
+ "name" : "regioncollapsed",
"type" : "function",
- "desc" : "Fires when a row is double clicked",
- "sig" : "function (_self, rowIndex, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when a region is collapsed.",
+ "sig" : "function (region)\n{\n\n}",
+ "memberOf" : "Roo.layout.Manager",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "region",
+ "type" : "Roo.layout.Region",
+ "desc" : "The collapsed region",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "select",
+ "name" : "regionexpanded",
"type" : "function",
- "desc" : "Fires when a date is selected",
- "sig" : "function (_self, date)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when a region is expanded.",
+ "sig" : "function (region)\n{\n\n}",
+ "memberOf" : "Roo.layout.Manager",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "DatePicker",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "date",
- "type" : "Date",
- "desc" : "The selected date",
+ "name" : "region",
+ "type" : "Roo.layout.Region",
+ "desc" : "The expanded region",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "startdrag",
+ "name" : "regionresized",
"type" : "function",
- "desc" : "Fires when row(s) start being dragged",
- "sig" : "function (_self, dd, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when the user resizes a region.",
+ "sig" : "function (region, newSize)\n{\n\n}",
+ "memberOf" : "Roo.layout.Manager",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
+ "name" : "region",
+ "type" : "Roo.layout.Region",
+ "desc" : "The resized region",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new size (width for east/west, height for north/south)",
"isOptional" : false
}
],
],
"methods" : [
{
- "name" : "addColumns",
+ "name" : "add",
"type" : "function",
- "desc" : "addColumns\nAdd's a column, default at the end..",
- "sig" : "(position, of)",
+ "desc" : "Adds a ContentPanel (or subclass) to this layout.",
+ "sig" : "(target, panel)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "position",
- "type" : "int",
- "desc" : "to add (default end)",
+ "name" : "target",
+ "type" : "String",
+ "desc" : "The target region key (north, south, east, west or center).",
"isOptional" : false
},
{
- "name" : "of",
- "type" : "Array",
- "desc" : "objects of column configuration see {@link Roo.grid.ColumnModel}",
+ "name" : "panel",
+ "type" : "Roo.panel.Content",
+ "desc" : "The panel to add",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.panel.Content",
+ "desc" : "The added panel"
+ }
+ ]
},
{
"name" : "addEvents",
"returns" : []
},
{
- "name" : "autoSize",
+ "name" : "addRegion",
"type" : "function",
- "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.",
+ "desc" : "Creates and adds a new region if it doesn't already exist.",
+ "sig" : "(target, config)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "String",
+ "desc" : "The target region key (north, south, east, west or center).",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The regions config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BorderLayoutRegion",
+ "desc" : "The new region"
+ }
+ ]
+ },
+ {
+ "name" : "addxtype",
+ "type" : "function",
+ "desc" : "Adds a xtype elements to the layout.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'ContentPanel',\n region: 'west',\n items: [ .... ]\n }\n);\n\nlayout.addxtype({\n xtype : 'NestedLayoutPanel',\n region: 'west',\n layout: {\n center: { },\n west: { } \n },\n items : [ ... list of content panels or nested layout panels.. ]\n }\n);\n</code></pre>",
+ "sig" : "(cfg)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "cfg",
+ "type" : "Object",
+ "desc" : "Xtype definition of item to add.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "batchAdd",
+ "type" : "function",
+ "desc" : "Adds a batch of multiple ContentPanels dynamically by passing a special regions config object. This config\nobject should contain properties for each region to add ContentPanels to, and each property's value should be\na valid ContentPanel config object. Example:\n<pre><code>\n// Create the main layout\nvar layout = new Roo.layout.Border('main-ct', {\n west: {\n split:true,\n minSize: 175,\n titlebar: true\n },\n center: {\n title:'Components'\n }\n}, 'main-ct');\n\n// Create and add multiple ContentPanels at once via configs\nlayout.batchAdd({\n west: {\n id: 'source-files',\n autoCreate:true,\n title:'Ext Source Files',\n autoScroll:true,\n fitToFrame:true\n },\n center : {\n el: cview,\n autoScroll:true,\n fitToFrame:true,\n toolbar: tb,\n resizeEl:'cbody'\n }\n});\n</code></pre>",
+ "sig" : "(regions)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "regions",
+ "type" : "Object",
+ "desc" : "An object containing ContentPanel configs by region name",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beginUpdate",
+ "type" : "function",
+ "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "create",
"type" : "function",
- "desc" : "Destroy this grid.",
- "sig" : "(removeEl)",
+ "desc" : "Shortcut for creating a new BorderLayout object and adding one or more ContentPanels to it in a single step, handling\nthe beginUpdate and endUpdate calls internally. The key to this method is the <b>panels</b> property that can be\nprovided with each region config, which allows you to add ContentPanel configs in addition to the region configs\nduring creation. The following code is equivalent to the constructor-based example at the beginning of this class:\n<pre><code>\n// shorthand\nvar CP = Roo.ContentPanel;\n\nvar layout = Roo.layout.Border.create({\n north: {\n initialSize: 25,\n titlebar: false,\n panels: [new CP(\"north\", \"North\")]\n },\n west: {\n split:true,\n initialSize: 200,\n minSize: 175,\n maxSize: 400,\n titlebar: true,\n collapsible: true,\n panels: [new CP(\"west\", {title: \"West\"})]\n },\n east: {\n split:true,\n initialSize: 202,\n minSize: 175,\n maxSize: 400,\n titlebar: true,\n collapsible: true,\n panels: [new CP(\"autoTabs\", {title: \"Auto Tabs\", closable: true})]\n },\n south: {\n split:true,\n initialSize: 100,\n minSize: 100,\n maxSize: 200,\n titlebar: true,\n collapsible: true,\n panels: [new CP(\"south\", {title: \"South\", closable: true})]\n },\n center: {\n titlebar: true,\n autoScroll:true,\n resizeTabs: true,\n minTabWidth: 50,\n preferredTabWidth: 150,\n panels: [\n new CP(\"center1\", {title: \"Close Me\", closable: true}),\n new CP(\"center2\", {title: \"Center Panel\", closable: false})\n ]\n }\n}, document.body);\n\nlayout.getRegion(\"center\").showPanel(\"center1\");\n</code></pre>",
+ "sig" : "(config, targetEl)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "targetEl",
+ "type" : "",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "endUpdate",
+ "type" : "function",
+ "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
+ "sig" : "(noLayout)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "removeEl",
+ "name" : "noLayout",
"type" : "Boolean",
- "desc" : "True to remove the element",
+ "desc" : "true to disable a layout update",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "findPanel",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Searches all regions for a panel with the specified id",
+ "sig" : "(panelId)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "panelId",
"type" : "String",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "Roo.panel.Content",
+ "desc" : "The panel or null if it wasn't found"
}
]
},
{
- "name" : "getColumnModel",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Returns the grid's ColumnModel.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "ColumnModel",
- "desc" : ""
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "getDataSource",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns the grid's DataSource.",
+ "desc" : "Returns the Element this layout is bound to.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "DataSource",
+ "type" : "Roo.Element",
"desc" : ""
}
]
},
{
- "name" : "getDragDropText",
+ "name" : "getRegion",
"type" : "function",
- "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.\nOverride this to put something different in the dragged text.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the specified region.",
+ "sig" : "(target)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "String",
+ "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "String",
+ "type" : "Roo.layout.Region",
"desc" : ""
}
]
},
{
- "name" : "getGridEl",
+ "name" : "getViewSize",
"type" : "function",
- "desc" : "Returns the grid's underlying element.",
+ "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Element",
- "desc" : "The element"
+ "type" : "Object",
+ "desc" : "The size as an object {width: (the width), height: (the height)}"
}
]
},
{
- "name" : "getSelectionModel",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Returns the grid's SelectionModel.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "SelectionModel",
- "desc" : ""
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "getView",
+ "name" : "isUpdating",
"type" : "function",
- "desc" : "Returns the grid's GridView object.",
+ "desc" : "Returns true if this layout is currently being updated",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "GridView",
+ "type" : "Boolean",
"desc" : ""
}
]
},
{
- "name" : "hasListener",
+ "name" : "layout",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Performs a layout update.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
"name" : "on",
"returns" : []
},
{
- "name" : "reconfigure",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.",
- "sig" : "(dataSource, The)",
- "static" : false,
- "memberOf" : "Roo.grid.Grid",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "dataSource",
- "type" : "Roo.data.Store",
- "desc" : "The new {@link Roo.data.Store} object",
- "isOptional" : false
- },
- {
- "name" : "The",
- "type" : "Roo.grid.ColumnModel",
- "desc" : "new {@link Roo.grid.ColumnModel} object",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "remove",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Remove a ContentPanel (or subclass) to this layout.",
+ "sig" : "(target, panel)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "target",
+ "type" : "String",
+ "desc" : "The target region key (north, south, east, west or center).",
+ "isOptional" : false
+ },
+ {
+ "name" : "panel",
+ "type" : "Number/String/Roo.panel.Content",
+ "desc" : "The index, id or panel to remove",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.panel.Content",
+ "desc" : "The removed panel"
+ }
+ ]
},
{
"name" : "removeListener",
"returns" : []
},
{
- "name" : "render",
+ "name" : "restoreState",
"type" : "function",
- "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Restores this layout's state using Roo.state.Manager or the state provided by the passed provider.",
+ "sig" : "(provider)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "provider",
+ "type" : "Roo.state.Provider",
+ "desc" : "(optional) An alternate state provider",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "showPanel",
+ "type" : "function",
+ "desc" : "Searches all regions for a panel with the specified id and activates (shows) it.",
+ "sig" : "(panelId)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panelId",
+ "type" : "String/panel.Content",
+ "desc" : "The panels id or the panel itself",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.grid.Grid",
- "desc" : "this"
+ "type" : "Roo.panel.Content",
+ "desc" : "The shown panel or null"
}
]
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
+ "implementations" : [
+ "Roo.layout.Reader"
+ ],
+ "tree_children" : [
+ "Roo.panel.Content",
+ "Roo.panel.Grid",
+ "Roo.panel.NestedLayout",
+ "Roo.panel.Tree"
+ ],
"tree_parent" : []
},
- "Roo.grid.CellSelectionModel" : {
+ "Roo.layout.Manager" : {
"props" : [
- {
- "name" : "enter_is_tab",
- "type" : "Boolean",
- "desc" : "Enter behaves the same as tab. (eg. goes to next cell) default: false",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
],
"events" : [
{
- "name" : "beforeeditnext",
- "type" : "function",
- "desc" : "Fires before the next editable sell is made active\nYou can use this to skip to another cell or fire the tabend\n if you set cell to false",
- "sig" : "function (eventdata)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "eventdata",
- "type" : "Object",
- "desc" : "object : { cell : [ row, col ] }",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerowselect",
+ "name" : "layout",
"type" : "function",
- "desc" : "Fires before a cell is selected.",
- "sig" : "function (_self, rowIndex, colIndex)\n{\n\n}",
+ "desc" : "Fires when a layout is performed.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "SelectionModel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "The selected row index",
- "isOptional" : false
- },
- {
- "name" : "colIndex",
- "type" : "Number",
- "desc" : "The selected cell index",
+ "type" : "Roo.layout.Manager",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "cellselect",
+ "name" : "regioncollapsed",
"type" : "function",
- "desc" : "Fires when a cell is selected.",
- "sig" : "function (_self, rowIndex, colIndex)\n{\n\n}",
+ "desc" : "Fires when a region is collapsed.",
+ "sig" : "function (region)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "SelectionModel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "The selected row index",
- "isOptional" : false
- },
- {
- "name" : "colIndex",
- "type" : "Number",
- "desc" : "The selected cell index",
+ "name" : "region",
+ "type" : "Roo.layout.Region",
+ "desc" : "The collapsed region",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "selectionchange",
+ "name" : "regionexpanded",
"type" : "function",
- "desc" : "Fires when the active selection changes.",
- "sig" : "function (_self, selection)\n{\n\n}",
+ "desc" : "Fires when a region is expanded.",
+ "sig" : "function (region)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "SelectionModel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "selection",
- "type" : "Object",
- "desc" : "null for no selection or an object (o) with two properties\n\t <ul>\n\t <li>o.record: the record object for the row the selection is in</li>\n\t <li>o.cell: An array of [rowIndex, columnIndex]</li>\n\t </ul>",
+ "name" : "region",
+ "type" : "Roo.layout.Region",
+ "desc" : "The expanded region",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "tabend",
+ "name" : "regionresized",
"type" : "function",
- "desc" : "Fires when the tab (or enter) was pressed on the last editable cell\nYou can use this to trigger add new row.",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Fires when the user resizes a region.",
+ "sig" : "function (region, newSize)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "SelectionModel",
- "desc" : "",
+ "name" : "region",
+ "type" : "Roo.layout.Region",
+ "desc" : "The resized region",
+ "isOptional" : false
+ },
+ {
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new size (width for east/west, height for north/south)",
"isOptional" : false
}
],
],
"returns" : []
},
+ {
+ "name" : "beginUpdate",
+ "type" : "function",
+ "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
"returns" : []
},
{
- "name" : "clearSelections",
+ "name" : "endUpdate",
"type" : "function",
- "desc" : "Clears all selections.",
- "sig" : "(true)",
+ "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
+ "sig" : "(noLayout)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "true",
+ "name" : "noLayout",
"type" : "Boolean",
- "desc" : "to prevent the gridview from being notified about the change.",
+ "desc" : "true to disable a layout update",
"isOptional" : false
}
],
]
},
{
- "name" : "getSelectedCell",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns the currently selected cell,.",
+ "desc" : "Returns the Element this layout is bound to.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : [
{
"name" : "",
- "type" : "Array",
- "desc" : "The selected cell (row, column) or null if none selected."
+ "type" : "Roo.Element",
+ "desc" : ""
}
]
},
{
- "name" : "hasListener",
+ "name" : "getRegion",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Returns the specified region.",
+ "sig" : "(target)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "target",
"type" : "String",
- "desc" : "The name of the event to check for",
+ "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "Roo.layout.Region",
+ "desc" : ""
}
]
},
{
- "name" : "hasSelection",
+ "name" : "getViewSize",
"type" : "function",
- "desc" : "Returns true if there is a selection.",
+ "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "type" : "Object",
+ "desc" : "The size as an object {width: (the width), height: (the height)}"
}
]
},
{
- "name" : "isLocked",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Returns true if the selections are locked.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.grid.AbstractSelectionModel",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
"type" : "Boolean",
- "desc" : ""
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "lock",
+ "name" : "isUpdating",
"type" : "function",
- "desc" : "Locks the selections.",
+ "desc" : "Returns true if this layout is currently being updated",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.grid.AbstractSelectionModel",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
"name" : "on",
],
"returns" : []
},
- {
- "name" : "onEditorKey",
- "type" : "function",
- "desc" : "Selects a cell.",
- "sig" : "(field, e)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "field",
- "type" : "Number",
- "desc" : "(not used) - as it's normally used as a listener",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Number",
- "desc" : "- event - fake it by using\n\nvar e = Roo.EventObjectImpl.prototype;\ne.keyCode = e.TAB",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "purgeListeners",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Selects a cell.",
- "sig" : "(rowIndex, collIndex)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "collIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "un",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "unlock",
- "type" : "function",
- "desc" : "Unlocks the selections.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.grid.AbstractSelectionModel",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
+ "implementations" : [
+ "Roo.layout.Border",
+ "Roo.layout.Reader"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.grid.ColumnModel" : {
+ "Roo.layout.Reader" : {
"props" : [
{
- "name" : "align",
- "type" : "String",
- "desc" : "t) Set the CSS text-align property of the column. Defaults to undefined (left",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "left",
- "right"
- ]
- },
- {
- "name" : "cursor",
- "type" : "String",
+ "name" : "center",
+ "type" : "Roo.layout.Region",
"desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "auto",
- "default",
- "none",
- "context-menu",
- "help",
- "pointer",
- "progress",
- "wait",
- "cell",
- "crosshair",
- "text",
- "vertical-text",
- "alias",
- "copy",
- "move",
- "no-drop",
- "not-allowed",
- "e-resize",
- "n-resize",
- "ne-resize",
- "nw-resize",
- "s-resize",
- "se-resize",
- "sw-resize",
- "w-resize",
- "ew-resize",
- "ns-resize",
- "nesw-resize",
- "nwse-resize",
- "col-resize",
- "row-resize",
- "all-scroll",
- "zoom-in",
- "zoom-out",
- "grab",
- "grabbing"
- ]
- },
- {
- "name" : "dataIndex",
- "type" : "String",
- "desc" : "The name of the field in the grid's {@link Roo.data.Store}'s\n{@link Roo.data.Record} definition from which to draw the column's value. If not\nspecified, the column's index is used as an index into the Record's data Array.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "editor",
- "type" : "Roo.grid.GridEditor",
- "desc" : "For grid editors - returns the grid editor",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fixed",
- "type" : "Boolean",
- "desc" : "True if the column width cannot be changed. Defaults to false.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "header",
- "type" : "String",
- "desc" : "The header text to display in the Grid view.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "True to hide the column. Defaults to false.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "can be '0' for hidden at this size (number less than 12)",
- "memberOf" : "",
+ "memberOf" : "Roo.layout.Border",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "lgHeader",
- "type" : "String",
- "desc" : "Header at Bootsrap Large width",
- "memberOf" : "",
+ "name" : "east",
+ "type" : "Roo.layout.Region",
+ "desc" : "",
+ "memberOf" : "Roo.layout.Border",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "locked",
- "type" : "Boolean",
- "desc" : "True to lock the column in place while scrolling the Grid. Defaults to false.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "md",
- "type" : "Number",
- "desc" : "can be '0' for hidden at this size (number less than 12)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "mdHeader",
- "type" : "String",
- "desc" : "Header at Bootsrap Medium width",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "renderer",
- "type" : "Function",
- "desc" : "A function used to generate HTML markup for a cell\ngiven the cell's data value. See {@link #setRenderer}. If not specified, the\ndefault renderer returns the escaped data value. If an object is returned (bootstrap only)\nthen it is treated as a Roo Component object instance, and it is rendered after the initial row is rendered",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "resizable",
- "type" : "Boolean",
- "desc" : "False to disable column resizing. Defaults to true.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "can be '0' for hidden at this size (number less than 12)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "smHeader",
- "type" : "String",
- "desc" : "Header at Bootsrap Small width",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "sortable",
- "type" : "Boolean",
- "desc" : "True if sorting is to be allowed on this column.\nDefaults to the value of the {@link #defaultSortable} property.\nWhether local/remote sorting is used is specified in {@link Roo.data.Store#remoteSort}.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "tooltip",
- "type" : "String",
- "desc" : "mouse over tooltip text",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "valign",
- "type" : "String",
- "desc" : "e) Set the CSS vertical-align property of the column (eg. middle, top, bottom etc). Defaults to undefined (middl",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "top",
- "bottom",
- "middle"
- ]
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The initial width in pixels of the column. Using this\ninstead of {@link Roo.grid.Grid#autoSizeColumns} is more efficient.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "xl",
- "type" : "Number",
- "desc" : "can be '0' for hidden at this size (number less than 12)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "xlHeader",
- "type" : "String",
- "desc" : "Header at Bootsrap extra Large width",
- "memberOf" : "",
+ "name" : "north",
+ "type" : "Roo.layout.Region",
+ "desc" : "",
+ "memberOf" : "Roo.layout.Border",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "xs",
- "type" : "Number",
- "desc" : "can be '0' for hidden at this size (number less than 12)",
- "memberOf" : "",
+ "name" : "south",
+ "type" : "Roo.layout.Region",
+ "desc" : "",
+ "memberOf" : "Roo.layout.Border",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "xsHeader",
- "type" : "String",
- "desc" : "Header at Bootsrap Extra Small width (default for all)",
- "memberOf" : "",
+ "name" : "west",
+ "type" : "Roo.layout.Region",
+ "desc" : "",
+ "memberOf" : "Roo.layout.Border",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
{
- "name" : "columlockchange",
- "type" : "function",
- "desc" : "Fires when a column's locked state is changed",
- "sig" : "function (_self, colIndex, locked)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "ColumnModel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "colIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "locked",
- "type" : "Boolean",
- "desc" : "true if locked",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "columnmoved",
+ "name" : "layout",
"type" : "function",
- "desc" : "Fires when a column is moved.",
- "sig" : "function (_self, oldIndex, newIndex)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when a layout is performed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.layout.Manager",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "ColumnModel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "oldIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newIndex",
- "type" : "Number",
+ "type" : "Roo.layout.Manager",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "headerchange",
+ "name" : "regioncollapsed",
"type" : "function",
- "desc" : "Fires when the text of a header changes.",
- "sig" : "function (_self, columnIndex, newText)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when a region is collapsed.",
+ "sig" : "function (region)\n{\n\n}",
+ "memberOf" : "Roo.layout.Manager",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "ColumnModel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "newText",
- "type" : "Number",
- "desc" : "The new header text",
+ "name" : "region",
+ "type" : "Roo.layout.Region",
+ "desc" : "The collapsed region",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "hiddenchange",
+ "name" : "regionexpanded",
"type" : "function",
- "desc" : "Fires when a column is hidden or \"unhidden\".",
- "sig" : "function (_self, columnIndex, hidden)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when a region is expanded.",
+ "sig" : "function (region)\n{\n\n}",
+ "memberOf" : "Roo.layout.Manager",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "ColumnModel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "true if hidden, false otherwise",
+ "name" : "region",
+ "type" : "Roo.layout.Region",
+ "desc" : "The expanded region",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "widthchange",
+ "name" : "regionresized",
"type" : "function",
- "desc" : "Fires when the width of a column changes.",
- "sig" : "function (_self, columnIndex, newWidth)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when the user resizes a region.",
+ "sig" : "function (region, newSize)\n{\n\n}",
+ "memberOf" : "Roo.layout.Manager",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "ColumnModel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "The column index",
+ "name" : "region",
+ "type" : "Roo.layout.Region",
+ "desc" : "The resized region",
"isOptional" : false
},
{
- "name" : "newWidth",
+ "name" : "newSize",
"type" : "Number",
- "desc" : "The new width",
+ "desc" : "The new size (width for east/west, height for north/south)",
"isOptional" : false
}
],
],
"methods" : [
{
- "name" : "addColumn",
+ "name" : "add",
"type" : "function",
- "desc" : "Add a column (experimental...) - defaults to adding to the end..",
- "sig" : "(config)",
+ "desc" : "Adds a ContentPanel (or subclass) to this layout.",
+ "sig" : "(target, panel)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.layout.Border",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "config",
- "type" : "Object",
- "desc" : "",
+ "name" : "target",
+ "type" : "String",
+ "desc" : "The target region key (north, south, east, west or center).",
+ "isOptional" : false
+ },
+ {
+ "name" : "panel",
+ "type" : "Roo.panel.Content",
+ "desc" : "The panel to add",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.panel.Content",
+ "desc" : "The added panel"
+ }
+ ]
},
{
"name" : "addEvents",
"returns" : []
},
{
- "name" : "capture",
- "type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "findColumnIndex",
- "type" : "function",
- "desc" : "Returns the index for a specified column dataIndex.",
- "sig" : "(dataIndex)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "dataIndex",
- "type" : "String",
- "desc" : "The column dataIndex",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "the index, or -1 if not found"
- }
- ]
- },
- {
- "name" : "fireEvent",
+ "name" : "addRegion",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Creates and adds a new region if it doesn't already exist.",
+ "sig" : "(target, config)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.layout.Border",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "target",
"type" : "String",
- "desc" : "",
+ "desc" : "The target region key (north, south, east, west or center).",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The regions config object",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "BorderLayoutRegion",
+ "desc" : "The new region"
}
]
},
{
- "name" : "getCellEditor",
+ "name" : "addxtype",
"type" : "function",
- "desc" : "Returns the editor defined for the cell/column.\nreturn false or null to disable editing.",
- "sig" : "(colIndex, rowIndex)",
+ "desc" : "Adds a xtype elements to the layout.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'ContentPanel',\n region: 'west',\n items: [ .... ]\n }\n);\n\nlayout.addxtype({\n xtype : 'NestedLayoutPanel',\n region: 'west',\n layout: {\n center: { },\n west: { } \n },\n items : [ ... list of content panels or nested layout panels.. ]\n }\n);\n</code></pre>",
+ "sig" : "(cfg)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.layout.Border",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "colIndex",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "The row index",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
+ "name" : "cfg",
"type" : "Object",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getColumnByDataIndex",
- "type" : "function",
- "desc" : "Returns the column Object for a specified dataIndex.",
- "sig" : "(dataIndex)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "dataIndex",
- "type" : "String",
- "desc" : "The column dataIndex",
+ "desc" : "Xtype definition of item to add.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Object|Boolean",
- "desc" : "the column or false if not found"
- }
- ]
+ "returns" : []
},
{
- "name" : "getColumnById",
+ "name" : "batchAdd",
"type" : "function",
- "desc" : "Returns the column for a specified id.",
- "sig" : "(id)",
+ "desc" : "Adds a batch of multiple ContentPanels dynamically by passing a special regions config object. This config\nobject should contain properties for each region to add ContentPanels to, and each property's value should be\na valid ContentPanel config object. Example:\n<pre><code>\n// Create the main layout\nvar layout = new Roo.layout.Border('main-ct', {\n west: {\n split:true,\n minSize: 175,\n titlebar: true\n },\n center: {\n title:'Components'\n }\n}, 'main-ct');\n\n// Create and add multiple ContentPanels at once via configs\nlayout.batchAdd({\n west: {\n id: 'source-files',\n autoCreate:true,\n title:'Ext Source Files',\n autoScroll:true,\n fitToFrame:true\n },\n center : {\n el: cview,\n autoScroll:true,\n fitToFrame:true,\n toolbar: tb,\n resizeEl:'cbody'\n }\n});\n</code></pre>",
+ "sig" : "(regions)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.layout.Border",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String",
- "desc" : "The column id",
+ "name" : "regions",
+ "type" : "Object",
+ "desc" : "An object containing ContentPanel configs by region name",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "the column"
- }
- ]
+ "returns" : []
},
{
- "name" : "getColumnCount",
+ "name" : "beginUpdate",
"type" : "function",
- "desc" : "Returns the number of columns.",
+ "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getColumnHeader",
- "type" : "function",
- "desc" : "Returns the header for the specified column.",
- "sig" : "(col)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getColumnId",
- "type" : "function",
- "desc" : "Returns the id of the column at the specified index.",
- "sig" : "(index)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "the id"
- }
- ]
+ "returns" : []
},
{
- "name" : "getColumnTooltip",
+ "name" : "capture",
"type" : "function",
- "desc" : "Returns the tooltip for the specified column.",
- "sig" : "(col)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getColumnWidth",
- "type" : "function",
- "desc" : "Returns the width for the specified column.",
- "sig" : "(col, (optional))",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
"isOptional" : false
},
{
- "name" : "(optional)",
- "type" : "",
- "desc" : "{String} gridSize bootstrap width size.",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getColumnsBy",
+ "name" : "create",
"type" : "function",
- "desc" : "Returns the column configs that return true by the passed function that is called with (columnConfig, index)",
- "sig" : "(fn, scope)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
+ "desc" : "Shortcut for creating a new BorderLayout object and adding one or more ContentPanels to it in a single step, handling\nthe beginUpdate and endUpdate calls internally. The key to this method is the <b>panels</b> property that can be\nprovided with each region config, which allows you to add ContentPanel configs in addition to the region configs\nduring creation. The following code is equivalent to the constructor-based example at the beginning of this class:\n<pre><code>\n// shorthand\nvar CP = Roo.ContentPanel;\n\nvar layout = Roo.layout.Border.create({\n north: {\n initialSize: 25,\n titlebar: false,\n panels: [new CP(\"north\", \"North\")]\n },\n west: {\n split:true,\n initialSize: 200,\n minSize: 175,\n maxSize: 400,\n titlebar: true,\n collapsible: true,\n panels: [new CP(\"west\", {title: \"West\"})]\n },\n east: {\n split:true,\n initialSize: 202,\n minSize: 175,\n maxSize: 400,\n titlebar: true,\n collapsible: true,\n panels: [new CP(\"autoTabs\", {title: \"Auto Tabs\", closable: true})]\n },\n south: {\n split:true,\n initialSize: 100,\n minSize: 100,\n maxSize: 200,\n titlebar: true,\n collapsible: true,\n panels: [new CP(\"south\", {title: \"South\", closable: true})]\n },\n center: {\n titlebar: true,\n autoScroll:true,\n resizeTabs: true,\n minTabWidth: 50,\n preferredTabWidth: 150,\n panels: [\n new CP(\"center1\", {title: \"Close Me\", closable: true}),\n new CP(\"center2\", {title: \"Center Panel\", closable: false})\n ]\n }\n}, document.body);\n\nlayout.getRegion(\"center\").showPanel(\"center1\");\n</code></pre>",
+ "sig" : "(config, targetEl)",
+ "static" : true,
+ "memberOf" : "Roo.layout.Border",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
+ "name" : "config",
+ "type" : "",
"desc" : "",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "targetEl",
+ "type" : "",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Array",
- "desc" : "result"
- }
- ]
+ "returns" : []
},
{
- "name" : "getDataIndex",
+ "name" : "endUpdate",
"type" : "function",
- "desc" : "Returns the dataIndex for the specified column.",
- "sig" : "(col)",
+ "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
+ "sig" : "(noLayout)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
+ "name" : "noLayout",
+ "type" : "Boolean",
+ "desc" : "true to disable a layout update",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getIndexById",
+ "name" : "findPanel",
"type" : "function",
- "desc" : "Returns the index for a specified column id.",
- "sig" : "(id)",
+ "desc" : "Searches all regions for a panel with the specified id",
+ "sig" : "(panelId)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.layout.Border",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
+ "name" : "panelId",
"type" : "String",
- "desc" : "The column id",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "the index, or -1 if not found"
+ "type" : "Roo.panel.Content",
+ "desc" : "The panel or null if it wasn't found"
}
]
},
{
- "name" : "getRenderer",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Returns the rendering (formatting) function defined for the column.",
- "sig" : "(col)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index.",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Function",
- "desc" : "The function used to render the cell. See {@link #setRenderer}."
- }
- ]
- },
- {
- "name" : "getTotalWidth",
- "type" : "function",
- "desc" : "Returns the total width of all columns.",
- "sig" : "(includeHidden)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "includeHidden",
- "type" : "Boolean",
- "desc" : "True to include hidden column widths",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : ""
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "hasListener",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Returns the Element this layout is bound to.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "Roo.Element",
+ "desc" : ""
}
]
},
{
- "name" : "isCellEditable",
+ "name" : "getRegion",
"type" : "function",
- "desc" : "Returns true if the cell is editable.",
- "sig" : "(colIndex, rowIndex)",
+ "desc" : "Returns the specified region.",
+ "sig" : "(target)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "colIndex",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "The row index - this is nto actually used..?",
+ "name" : "target",
+ "type" : "String",
+ "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
+ "type" : "Roo.layout.Region",
"desc" : ""
}
]
},
{
- "name" : "isFixed",
+ "name" : "getViewSize",
"type" : "function",
- "desc" : "Returns true if the column width cannot be changed",
+ "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "The size as an object {width: (the width), height: (the height)}"
+ }
+ ]
},
{
- "name" : "isHidden",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Returns true if the column is hidden.",
- "sig" : "(colIndex)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "colIndex",
- "type" : "Number",
- "desc" : "The column index",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Boolean",
- "desc" : ""
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "isResizable",
+ "name" : "isUpdating",
"type" : "function",
- "desc" : "Returns true if the column can be resized",
+ "desc" : "Returns true if this layout is currently being updated",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
]
},
{
- "name" : "isSortable",
+ "name" : "layout",
"type" : "function",
- "desc" : "Returns true if the specified column is sortable.",
- "sig" : "(col)",
+ "desc" : "Performs a layout update.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.layout.Border",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
"name" : "on",
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "remove",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Remove a ContentPanel (or subclass) to this layout.",
+ "sig" : "(target, panel)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.layout.Border",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "target",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "The target region key (north, south, east, west or center).",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "panel",
+ "type" : "Number/String/Roo.panel.Content",
+ "desc" : "The index, id or panel to remove",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "setColumnHeader",
- "type" : "function",
- "desc" : "Sets the header for a column.",
- "sig" : "(col, header)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
+ "returns" : [
{
- "name" : "header",
- "type" : "String",
- "desc" : "The new header",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.panel.Content",
+ "desc" : "The removed panel"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setColumnTooltip",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Sets the tooltip for a column.",
- "sig" : "(col, tooltip)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "tooltip",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The new tooltip",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setColumnWidth",
- "type" : "function",
- "desc" : "Sets the width for a column.",
- "sig" : "(col, width)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The new width",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setDataIndex",
- "type" : "function",
- "desc" : "Sets the dataIndex for a column.",
- "sig" : "(col, dataIndex)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "dataIndex",
- "type" : "Number",
- "desc" : "The new dataIndex",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setEditable",
- "type" : "function",
- "desc" : "Sets if a column is editable.",
- "sig" : "(col, editable)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "editable",
- "type" : "Boolean",
- "desc" : "True if the column is editable",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setEditor",
+ "name" : "restoreState",
"type" : "function",
- "desc" : "Sets the editor for a column.",
- "sig" : "(col, editor)",
+ "desc" : "Restores this layout's state using Roo.state.Manager or the state provided by the passed provider.",
+ "sig" : "(provider)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.layout.Border",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "editor",
- "type" : "Object",
- "desc" : "The editor object",
+ "name" : "provider",
+ "type" : "Roo.state.Provider",
+ "desc" : "(optional) An alternate state provider",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setHidden",
+ "name" : "showPanel",
"type" : "function",
- "desc" : "Sets if a column is hidden.",
- "sig" : "(colIndex, hidden)",
+ "desc" : "Searches all regions for a panel with the specified id and activates (shows) it.",
+ "sig" : "(panelId)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.layout.Border",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "colIndex",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "True if the column is hidden",
+ "name" : "panelId",
+ "type" : "String/panel.Content",
+ "desc" : "The panels id or the panel itself",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "setRenderer",
- "type" : "function",
- "desc" : "Sets the rendering (formatting) function for a column.",
- "sig" : "(col, fn)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
+ "returns" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to use to process the cell's raw data\nto return HTML markup for the grid view. The render function is called with\nthe following parameters:<ul>\n<li>Data value.</li>\n<li>Cell metadata. An object in which you may set the following attributes:<ul>\n<li>css A CSS style string to apply to the table cell.</li>\n<li>attr An HTML attribute definition string to apply to the data container element <i>within</i> the table cell.</li></ul>\n<li>The {@link Roo.data.Record} from which the data was extracted.</li>\n<li>Row index</li>\n<li>Column index</li>\n<li>The {@link Roo.data.Store} object from which the Record was extracted</li></ul>",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.panel.Content",
+ "desc" : "The shown panel or null"
}
- ],
- "returns" : []
+ ]
},
{
"name" : "un",
"tree_children" : [],
"tree_parent" : []
},
- "Roo.grid.EditorGrid" : {
+ "Roo.layout.Region" : {
"props" : [
{
- "name" : "autoExpandColumn",
- "type" : "String",
- "desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoExpandMax",
- "type" : "Number",
- "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoExpandMin",
- "type" : "Number",
- "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoHeight",
+ "name" : "alwaysShowTabs",
"type" : "Boolean",
- "desc" : "True to fit the height of the grid container to the height of the data. Default is false.",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "autoSizeColumns",
+ "name" : "animate",
"type" : "Boolean",
- "desc" : "True to automatically resize the columns to fit their content\n<b>on initial render.</b> It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "True to animate expand/collapse (defaults to false)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "autoSizeHeaders",
+ "name" : "autoHide",
"type" : "Boolean",
- "desc" : "True to measure headers with column data when auto sizing columns. Default is true.",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "autoWidth",
+ "name" : "autoScroll",
"type" : "Boolean",
- "desc" : "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "clicksToEdit",
- "type" : "Number",
- "desc" : "The number of clicks on a cell required to display the cell's editor (defaults to 2)",
+ "desc" : "True to enable overflow scrolling (defaults to false)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "cm[]",
- "type" : "Roo.grid.ColumnModel",
- "desc" : "The columns of the grid",
- "memberOf" : "Roo.grid.Grid",
+ "name" : "closeOnTab",
+ "type" : "Boolean",
+ "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "ddGroup",
- "type" : "String",
- "desc" : "- drag drop group.",
- "memberOf" : "Roo.grid.Grid",
+ "name" : "cmargins",
+ "type" : "Object",
+ "desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "ddText",
- "type" : "String",
- "desc" : "Configures the text is the drag proxy (defaults to \"%0 selected row(s)\").\n%0 is replaced with the number of selected rows.",
- "memberOf" : "Roo.grid.Grid",
+ "name" : "collapsed",
+ "type" : "Boolean",
+ "desc" : "True to set the initial display to collapsed (defaults to false)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "dragGroup",
+ "name" : "collapsedTitle",
"type" : "String",
- "desc" : "- drag group (?? not sure if needed.)",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "dropTarget",
- "type" : "Roo.dd.DropTarget",
- "desc" : "An {@link Roo.dd.DropTarget} config",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "ds",
- "type" : "Roo.data.Store",
- "desc" : "The data store for the grid",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Optional string message to display in the collapsed block of a north or south region",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "enableColumnHide",
+ "name" : "collapsible",
"type" : "Boolean",
- "desc" : "True to enable hiding of columns with the header context menu. Default is true.",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "False to disable collapsing (defaults to true)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "enableColumnMove",
+ "name" : "disableTabTips",
"type" : "Boolean",
- "desc" : "True to enable drag and drop reorder of columns. Default is true.",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "True to disable tab tooltips",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "enableDrag",
+ "name" : "floatable",
"type" : "Boolean",
- "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "False to disable floating (defaults to true)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "enableDragDrop",
- "type" : "Boolean",
- "desc" : "True to enable drag and drop of rows. Default is false.",
- "memberOf" : "Roo.grid.Grid",
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "For North/South panels",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "enableDrop",
+ "name" : "hidden",
"type" : "Boolean",
- "desc" : "True to enable drop of elements. Default is false. (double check if this is needed?)",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "True to start the region hidden (defaults to false)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "enableRowHeightSync",
+ "name" : "hideTabs",
"type" : "Boolean",
- "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "True to hide the tab strip (defaults to false)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "footer",
- "type" : "Roo.PagingToolbar",
- "desc" : "the paging toolbar",
- "memberOf" : "Roo.grid.Grid",
+ "name" : "hideWhenEmpty",
+ "type" : "Boolean",
+ "desc" : "True to hide the region when it has no panels",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "loadMask",
+ "name" : "margins",
"type" : "Object",
- "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "maxHeight",
+ "name" : "minTabWidth",
"type" : "Number",
- "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxRowsToMeasure",
- "type" : "Boolean",
- "desc" : "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "The minimum tab width (defaults to 40)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "minColumnWidth",
+ "name" : "preferredTabWidth",
"type" : "Number",
- "desc" : "The minimum width a column can be resized to. Default is 25.",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "The preferred tab width (defaults to 150)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "monitorWindowResize",
+ "name" : "preservePanels",
"type" : "Boolean",
- "desc" : "True to autoSize the grid when the window resizes. Default is true.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "sm",
- "type" : "Roo.grid.AbstractSelectionModel",
- "desc" : "The selection Model (default = Roo.grid.RowSelectionModel)",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "sortColMenu",
- "type" : "boolean",
- "desc" : "Sort the column order menu when it shows (usefull for long lists..) default false",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "stripeRows",
+ "name" : "resizeTabs",
"type" : "Boolean",
- "desc" : "True to stripe the rows. Default is true.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "toolbar",
- "type" : "Roo.Toolbar",
- "desc" : "a toolbar for buttons etc.",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "trackMouseOver",
+ "name" : "showPin",
"type" : "Boolean",
- "desc" : "True to highlight rows when the mouse is over. Default is true.",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "True to show a pin button",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "view",
- "type" : "Roo.grid.GridView",
- "desc" : "The view that renders the grid (default = Roo.grid.GridView)",
- "memberOf" : "Roo.grid.Grid",
+ "name" : "split",
+ "type" : "Boolean",
+ "desc" : "To show the splitter",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "afteredit",
- "type" : "function",
- "desc" : "Fires after a cell is edited. <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n</ul>",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Object",
- "desc" : "An edit event (see above for description)",
- "isOptional" : false
- }
- ],
- "returns" : []
},
{
- "name" : "beforeedit",
- "type" : "function",
- "desc" : "Fires before cell editing is triggered. The edit event object has the following properties <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value for the field being edited.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>",
- "sig" : "function (e)\n{\n\n}",
+ "name" : "tabPosition",
+ "type" : "String",
+ "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom",
"memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Object",
- "desc" : "An edit event (see above for description)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "bodyscroll",
- "type" : "function",
- "desc" : "Fires when the body element is scrolled",
- "sig" : "function (scrollLeft, scrollTop)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "scrollLeft",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "scrollTop",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "cellclick",
- "type" : "function",
- "desc" : "Fires when a cell is clicked",
- "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "cellcontextmenu",
- "type" : "function",
- "desc" : "Fires when a cell is right clicked",
- "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "cellIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "celldblclick",
- "type" : "function",
- "desc" : "Fires when a cell is double clicked",
- "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "click",
- "type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "columnmove",
- "type" : "function",
- "desc" : "Fires when the user moves a column",
- "sig" : "function (oldIndex, newIndex)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "oldIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "columnresize",
- "type" : "function",
- "desc" : "Fires when the user resizes a column",
- "sig" : "function (columnIndex, newSize)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newSize",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "contextmenu",
- "type" : "function",
- "desc" : "The raw contextmenu event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "dblclick",
- "type" : "function",
- "desc" : "The raw dblclick event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "dragdrop",
- "type" : "function",
- "desc" : "Fires when dragged row(s) are dropped on a valid DD target",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
- "isOptional" : false
- },
- {
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "dragenter",
- "type" : "function",
- "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
- "isOptional" : false
- },
- {
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "dragout",
- "type" : "function",
- "desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
- "isOptional" : false
- },
- {
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "bottom"
+ ]
},
{
- "name" : "dragover",
- "type" : "function",
- "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
- "isOptional" : false
- },
- {
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title for the region (overrides panel titles)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "enddrag",
- "type" : "function",
- "desc" : "Fires when a drag operation is complete",
- "sig" : "function (_self, dd, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "titlebar",
+ "type" : "Boolean",
+ "desc" : "True to display a title bar (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "headerclick",
- "type" : "function",
- "desc" : "Fires when a header is clicked",
- "sig" : "function (_self, columnIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "toolbar",
+ "type" : "Boolean",
+ "desc" : "xtype configuration for a toolbar - shows on right of tabbar",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "headercontextmenu",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "For East/West panels",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforecollapse",
"type" : "function",
- "desc" : "Fires when a header is right clicked",
- "sig" : "function (_self, columnIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires when this region before collapse.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "headerdblclick",
+ "name" : "beforeremove",
"type" : "function",
- "desc" : "Fires when a header cell is double clicked",
- "sig" : "function (_self, columnIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument.",
+ "sig" : "function (_self, panel, e)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
},
{
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "panel",
+ "type" : "Roo.panel.Content",
+ "desc" : "The panel",
"isOptional" : false
},
{
"name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "type" : "Object",
+ "desc" : "The cancel event object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "keydown",
+ "name" : "collapsed",
"type" : "function",
- "desc" : "The raw keydown event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires when this region is collapsed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "keypress",
+ "name" : "expanded",
"type" : "function",
- "desc" : "The raw keypress event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires when this region is expanded.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "mousedown",
+ "name" : "invalidated",
"type" : "function",
- "desc" : "The raw mousedown event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires when the layout for this region is changed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "mouseout",
+ "name" : "panelactivated",
"type" : "function",
- "desc" : "The raw mouseout event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires when a panel is activated.",
+ "sig" : "function (_self, panel)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "mouseover",
- "type" : "function",
- "desc" : "The raw mouseover event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "panel",
+ "type" : "Roo.panel.Content",
+ "desc" : "The activated panel",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "mouseup",
+ "name" : "paneladded",
"type" : "function",
- "desc" : "The raw mouseup event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires when a panel is added.",
+ "sig" : "function (_self, panel)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires when the grid is rendered",
- "sig" : "function (grid)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "grid",
- "type" : "Grid",
- "desc" : "",
+ "name" : "panel",
+ "type" : "Roo.panel.Content",
+ "desc" : "The panel",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "rowclass",
+ "name" : "panelremoved",
"type" : "function",
- "desc" : "Fires when a row is rendered, so you can change add a style to it.",
- "sig" : "function (gridview, rowcfg)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires when a panel is removed.",
+ "sig" : "function (_self, panel)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "gridview",
- "type" : "GridView",
- "desc" : "The grid view",
+ "name" : "this",
+ "type" : "Roo.layout.Region",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "rowcfg",
- "type" : "Object",
- "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.",
+ "name" : "panel",
+ "type" : "Roo.panel.Content",
+ "desc" : "The panel",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "rowclick",
+ "name" : "resized",
"type" : "function",
- "desc" : "Fires when a row is clicked",
- "sig" : "function (_self, rowIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires when the user resizes this region.",
+ "sig" : "function (_self, newSize)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
},
{
- "name" : "rowIndex",
+ "name" : "newSize",
"type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "desc" : "The new size (width for east/west, height for north/south)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "rowcontextmenu",
+ "name" : "slidehide",
"type" : "function",
- "desc" : "Fires when a row is right clicked",
- "sig" : "function (_self, rowIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires when this region slides out of view.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "rowdblclick",
+ "name" : "slideshow",
"type" : "function",
- "desc" : "Fires when a row is double clicked",
- "sig" : "function (_self, rowIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires when this region is slid into view.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "startdrag",
+ "name" : "visibilitychange",
"type" : "function",
- "desc" : "Fires when row(s) start being dragged",
- "sig" : "function (_self, dd, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires when this region is shown or hidden",
+ "sig" : "function (_self, visibility)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
},
{
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "validateedit",
- "type" : "function",
- "desc" : "Fires after a cell is edited, but before the value is set in the record. \nYou can use this to modify the value being set in the field, Return false\nto cancel the change. The edit event object has the following properties <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>editor - This editor</li>\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Object",
- "desc" : "An edit event (see above for description)",
+ "name" : "visibility",
+ "type" : "Boolean",
+ "desc" : "true or false",
"isOptional" : false
}
],
],
"methods" : [
{
- "name" : "addColumns",
+ "name" : "add",
"type" : "function",
- "desc" : "addColumns\nAdd's a column, default at the end..",
- "sig" : "(position, of)",
+ "desc" : "Adds the passed ContentPanel(s) to this region.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "position",
- "type" : "int",
- "desc" : "to add (default end)",
- "isOptional" : false
- },
- {
- "name" : "of",
- "type" : "Array",
- "desc" : "objects of column configuration see {@link Roo.grid.ColumnModel}",
+ "name" : "panel",
+ "type" : "panel.Content...",
+ "desc" : "The ContentPanel(s) to add (you can pass more than one)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.panel.Content",
+ "desc" : "The panel added (if only one was added; null otherwise)"
+ }
+ ]
},
{
"name" : "addEvents",
],
"returns" : []
},
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.grid.Grid",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "collapse",
"type" : "function",
- "desc" : "Destroy this grid.",
- "sig" : "(removeEl)",
+ "desc" : "Collapses this region.",
+ "sig" : "(skipAnim)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "removeEl",
+ "name" : "skipAnim",
"type" : "Boolean",
- "desc" : "True to remove the element",
+ "desc" : "(optional) true to collapse the element without animation (if animate is true)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expands this region if it was previously collapsed.",
+ "sig" : "(e, skipAnim)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event that triggered the expand (or null if calling manually)",
+ "isOptional" : false
+ },
+ {
+ "name" : "skipAnim",
+ "type" : "Boolean",
+ "desc" : "(optional) true to expand the element without animation (if animate is true)",
"isOptional" : false
}
],
]
},
{
- "name" : "getColumnModel",
+ "name" : "getActivePanel",
"type" : "function",
- "desc" : "Returns the grid's ColumnModel.",
+ "desc" : "Get the active panel for this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "ColumnModel",
- "desc" : ""
+ "type" : "Roo.panel.Content",
+ "desc" : "The active panel or null"
}
]
},
{
- "name" : "getDataSource",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns the grid's DataSource.",
+ "desc" : "Returns the container element for this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "DataSource",
+ "type" : "Roo.Element",
"desc" : ""
}
]
},
{
- "name" : "getDragDropText",
+ "name" : "getPanel",
"type" : "function",
- "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the panel specified or null if it's not in this region.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.layout.BasicRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/panel.Content",
+ "desc" : "The panels index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "String",
+ "type" : "Roo.panel.Content",
"desc" : ""
}
]
},
{
- "name" : "getGridEl",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "Returns the grid's underlying element.",
+ "desc" : "Returns this regions position (north/south/east/west/center).",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.layout.BasicRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Element",
- "desc" : "The element"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getSelectionModel",
+ "name" : "getTabs",
"type" : "function",
- "desc" : "Returns the grid's SelectionModel.",
+ "desc" : "Returns the TabPanel component used by this region",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "SelectionModel",
+ "type" : "Roo.panel.Tab",
"desc" : ""
}
]
},
{
- "name" : "getView",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Returns the grid's GridView object.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "GridView",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
+ },
+ {
+ "name" : "hasPanel",
+ "type" : "function",
+ "desc" : "Returns true if the panel is in this region.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "Roo.layout.BasicRegion",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/panel.Content",
+ "desc" : "The panels index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
"desc" : ""
}
]
},
{
- "name" : "hasListener",
+ "name" : "hide",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Hides this region.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "hidePanel",
+ "type" : "function",
+ "desc" : "Hides the tab for the specified panel.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "panel",
+ "type" : "Number/String/panel.Content",
+ "desc" : "The panel's index, id or the panel itself",
"isOptional" : false
}
],
+ "returns" : []
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this region is currently visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
"type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "desc" : ""
}
]
},
"returns" : []
},
{
- "name" : "reconfigure",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.",
- "sig" : "(dataSource, The)",
- "static" : false,
- "memberOf" : "Roo.grid.Grid",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "dataSource",
- "type" : "Roo.data.Store",
- "desc" : "The new {@link Roo.data.Store} object",
- "isOptional" : false
- },
- {
- "name" : "The",
- "type" : "Roo.grid.ColumnModel",
- "desc" : "new {@link Roo.grid.ColumnModel} object",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "remove",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
+ "sig" : "(panel, preservePanel)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "panel",
+ "type" : "Number/String/panel.Content",
+ "desc" : "The panel's index, id or the panel itself",
+ "isOptional" : false
+ },
+ {
+ "name" : "preservePanel",
+ "type" : "Boolean",
+ "desc" : "Overrides the config preservePanel option",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.panel.Content",
+ "desc" : "The panel that was removed"
+ }
+ ]
},
{
"name" : "removeListener",
"returns" : []
},
{
- "name" : "render",
+ "name" : "resizeTo",
"type" : "function",
- "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
+ "sig" : "(newSize)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.layout.BasicRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.grid.Grid",
- "desc" : "this"
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new width or height",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "startEditing",
+ "name" : "setCollapsedTitle",
"type" : "function",
- "desc" : "Starts editing the specified for the specified row/column",
- "sig" : "(rowIndex, colIndex)",
+ "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)",
+ "sig" : "(title)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "colIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "title",
+ "type" : "String",
+ "desc" : "(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, \"&#160;\")",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "stopEditing",
+ "name" : "show",
"type" : "function",
- "desc" : "Stops any active editing",
+ "desc" : "Shows this region if it was previously hidden.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"params" : [],
"returns" : []
},
+ {
+ "name" : "showPanel",
+ "type" : "function",
+ "desc" : "Shows the specified panel.",
+ "sig" : "(panelId)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panelId",
+ "type" : "Number/String/panel.Content",
+ "desc" : "The panel's index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.panel.Content",
+ "desc" : "The shown panel, or null if a panel could not be found from panelId"
+ }
+ ]
+ },
{
"name" : "un",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "unhidePanel",
+ "type" : "function",
+ "desc" : "Unhides the tab for a previously hidden panel.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/panel.Content",
+ "desc" : "The panel's index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [
- "Roo.grid.PropertyGrid"
+ "Roo.bootstrap.layout.Split",
+ "Roo.layout.SplitRegion"
],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.grid.Grid" : {
+ "Roo.layout.SplitRegion" : {
"props" : [
{
- "name" : "autoExpandColumn",
- "type" : "String",
- "desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoExpandMax",
- "type" : "Number",
- "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoExpandMin",
- "type" : "Number",
- "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoHeight",
+ "name" : "alwaysShowTabs",
"type" : "Boolean",
- "desc" : "True to fit the height of the grid container to the height of the data. Default is false.",
- "memberOf" : "",
+ "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "autoSizeColumns",
+ "name" : "animate",
"type" : "Boolean",
- "desc" : "True to automatically resize the columns to fit their content\n<b>on initial render.</b> It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.",
- "memberOf" : "",
+ "desc" : "True to animate expand/collapse (defaults to false)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "autoSizeHeaders",
+ "name" : "autoHide",
"type" : "Boolean",
- "desc" : "True to measure headers with column data when auto sizing columns. Default is true.",
- "memberOf" : "",
+ "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "autoWidth",
+ "name" : "autoScroll",
"type" : "Boolean",
- "desc" : "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.",
- "memberOf" : "",
+ "desc" : "True to enable overflow scrolling (defaults to false)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "cm[]",
- "type" : "Roo.grid.ColumnModel",
- "desc" : "The columns of the grid",
- "memberOf" : "",
+ "name" : "closeOnTab",
+ "type" : "Boolean",
+ "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "ddGroup",
- "type" : "String",
- "desc" : "- drag drop group.",
- "memberOf" : "",
+ "name" : "cmargins",
+ "type" : "Object",
+ "desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "ddText",
- "type" : "String",
- "desc" : "Configures the text is the drag proxy (defaults to \"%0 selected row(s)\").\n%0 is replaced with the number of selected rows.",
- "memberOf" : "",
+ "name" : "collapsed",
+ "type" : "Boolean",
+ "desc" : "True to set the initial display to collapsed (defaults to false)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "dragGroup",
+ "name" : "collapsedTitle",
"type" : "String",
- "desc" : "- drag group (?? not sure if needed.)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "dropTarget",
- "type" : "Roo.dd.DropTarget",
- "desc" : "An {@link Roo.dd.DropTarget} config",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "ds",
- "type" : "Roo.data.Store",
- "desc" : "The data store for the grid",
- "memberOf" : "",
+ "desc" : "Optional string message to display in the collapsed block of a north or south region",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "enableColumnHide",
+ "name" : "collapsible",
"type" : "Boolean",
- "desc" : "True to enable hiding of columns with the header context menu. Default is true.",
- "memberOf" : "",
+ "desc" : "False to disable collapsing (defaults to true)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "enableColumnMove",
+ "name" : "disableTabTips",
"type" : "Boolean",
- "desc" : "True to enable drag and drop reorder of columns. Default is true.",
- "memberOf" : "",
+ "desc" : "True to disable tab tooltips",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "enableDrag",
+ "name" : "floatable",
"type" : "Boolean",
- "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
- "memberOf" : "",
+ "desc" : "False to disable floating (defaults to true)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "enableDragDrop",
- "type" : "Boolean",
- "desc" : "True to enable drag and drop of rows. Default is false.",
- "memberOf" : "",
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "For North/South panels",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "enableDrop",
+ "name" : "hidden",
"type" : "Boolean",
- "desc" : "True to enable drop of elements. Default is false. (double check if this is needed?)",
- "memberOf" : "",
+ "desc" : "True to start the region hidden (defaults to false)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "enableRowHeightSync",
+ "name" : "hideTabs",
"type" : "Boolean",
- "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.",
- "memberOf" : "",
+ "desc" : "True to hide the tab strip (defaults to false)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "footer",
- "type" : "Roo.PagingToolbar",
- "desc" : "the paging toolbar",
- "memberOf" : "",
+ "name" : "hideWhenEmpty",
+ "type" : "Boolean",
+ "desc" : "True to hide the region when it has no panels",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "loadMask",
+ "name" : "margins",
"type" : "Object",
- "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
- "memberOf" : "",
+ "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "maxHeight",
+ "name" : "minTabWidth",
"type" : "Number",
- "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
- "memberOf" : "",
+ "desc" : "The minimum tab width (defaults to 40)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "maxRowsToMeasure",
- "type" : "Boolean",
- "desc" : "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).",
- "memberOf" : "",
+ "name" : "preferredTabWidth",
+ "type" : "Number",
+ "desc" : "The preferred tab width (defaults to 150)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "minColumnWidth",
- "type" : "Number",
- "desc" : "The minimum width a column can be resized to. Default is 25.",
- "memberOf" : "",
+ "name" : "preservePanels",
+ "type" : "Boolean",
+ "desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "monitorWindowResize",
+ "name" : "resizeTabs",
"type" : "Boolean",
- "desc" : "True to autoSize the grid when the window resizes. Default is true.",
- "memberOf" : "",
+ "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "sm",
- "type" : "Roo.grid.AbstractSelectionModel",
- "desc" : "The selection Model (default = Roo.grid.RowSelectionModel)",
- "memberOf" : "",
+ "name" : "showPin",
+ "type" : "Boolean",
+ "desc" : "True to show a pin button",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "sortColMenu",
- "type" : "boolean",
- "desc" : "Sort the column order menu when it shows (usefull for long lists..) default false",
- "memberOf" : "",
+ "name" : "split",
+ "type" : "Boolean",
+ "desc" : "To show the splitter",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "stripeRows",
- "type" : "Boolean",
- "desc" : "True to stripe the rows. Default is true.",
- "memberOf" : "",
+ "name" : "tabPosition",
+ "type" : "String",
+ "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom",
+ "memberOf" : "Roo.layout.Region",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "bottom"
+ ]
+ },
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title for the region (overrides panel titles)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "toolbar",
- "type" : "Roo.Toolbar",
- "desc" : "a toolbar for buttons etc.",
- "memberOf" : "",
+ "name" : "titlebar",
+ "type" : "Boolean",
+ "desc" : "True to display a title bar (defaults to true)",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "trackMouseOver",
+ "name" : "toolbar",
"type" : "Boolean",
- "desc" : "True to highlight rows when the mouse is over. Default is true.",
- "memberOf" : "",
+ "desc" : "xtype configuration for a toolbar - shows on right of tabbar",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "view",
- "type" : "Roo.grid.GridView",
- "desc" : "The view that renders the grid (default = Roo.grid.GridView)",
- "memberOf" : "",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "For East/West panels",
+ "memberOf" : "Roo.layout.Region",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
{
- "name" : "bodyscroll",
+ "name" : "beforecollapse",
"type" : "function",
- "desc" : "Fires when the body element is scrolled",
- "sig" : "function (scrollLeft, scrollTop)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when this region before collapse.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "scrollLeft",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "scrollTop",
- "type" : "Number",
+ "name" : "this",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "cellclick",
+ "name" : "beforeremove",
"type" : "function",
- "desc" : "Fires when a cell is clicked",
- "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument.",
+ "sig" : "function (_self, panel, e)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
},
{
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "panel",
+ "type" : "Roo.panel.Content",
+ "desc" : "The panel",
"isOptional" : false
},
{
"name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "type" : "Object",
+ "desc" : "The cancel event object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "cellcontextmenu",
+ "name" : "collapsed",
"type" : "function",
- "desc" : "Fires when a cell is right clicked",
- "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when this region is collapsed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "expanded",
+ "type" : "function",
+ "desc" : "Fires when this region is expanded.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "cellIndex",
- "type" : "Number",
+ "name" : "this",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "invalidated",
+ "type" : "function",
+ "desc" : "Fires when the layout for this region is changed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "celldblclick",
- "type" : "function",
- "desc" : "Fires when a cell is double clicked",
- "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
- "memberOf" : "",
+ "name" : "panelactivated",
+ "type" : "function",
+ "desc" : "Fires when a panel is activated.",
+ "sig" : "function (_self, panel)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "panel",
+ "type" : "Roo.panel.Content",
+ "desc" : "The activated panel",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "click",
+ "name" : "paneladded",
"type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when a panel is added.",
+ "sig" : "function (_self, panel)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "panel",
+ "type" : "Roo.panel.Content",
+ "desc" : "The panel",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "columnmove",
+ "name" : "panelremoved",
"type" : "function",
- "desc" : "Fires when the user moves a column",
- "sig" : "function (oldIndex, newIndex)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when a panel is removed.",
+ "sig" : "function (_self, panel)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "oldIndex",
- "type" : "Number",
+ "name" : "this",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
},
{
- "name" : "newIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "panel",
+ "type" : "Roo.panel.Content",
+ "desc" : "The panel",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "columnresize",
+ "name" : "resized",
"type" : "function",
- "desc" : "Fires when the user resizes a column",
- "sig" : "function (columnIndex, newSize)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when the user resizes this region.",
+ "sig" : "function (_self, newSize)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "columnIndex",
- "type" : "Number",
+ "name" : "this",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
},
{
"name" : "newSize",
"type" : "Number",
- "desc" : "",
+ "desc" : "The new size (width for east/west, height for north/south)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "contextmenu",
+ "name" : "slidehide",
"type" : "function",
- "desc" : "The raw contextmenu event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when this region slides out of view.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "dblclick",
+ "name" : "slideshow",
"type" : "function",
- "desc" : "The raw dblclick event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when this region is slid into view.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "dragdrop",
+ "name" : "visibilitychange",
"type" : "function",
- "desc" : "Fires when dragged row(s) are dropped on a valid DD target",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when this region is shown or hidden",
+ "sig" : "function (_self, visibility)\n{\n\n}",
+ "memberOf" : "Roo.layout.BasicRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
+ "type" : "Roo.layout.Region",
"desc" : "",
"isOptional" : false
},
{
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
- "isOptional" : false
- },
- {
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "visibility",
+ "type" : "Boolean",
+ "desc" : "true or false",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "dragenter",
+ "name" : "add",
"type" : "function",
- "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Adds the passed ContentPanel(s) to this region.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "Roo.layout.Region",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
- "isOptional" : false
- },
- {
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "panel",
+ "type" : "panel.Content...",
+ "desc" : "The ContentPanel(s) to add (you can pass more than one)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.panel.Content",
+ "desc" : "The panel added (if only one was added; null otherwise)"
+ }
+ ]
},
{
- "name" : "dragout",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
- "isOptional" : false
- },
- {
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "dragover",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enddrag",
+ "name" : "capture",
"type" : "function",
- "desc" : "Fires when a drag operation is complete",
- "sig" : "function (_self, dd, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "headerclick",
+ "name" : "collapse",
"type" : "function",
- "desc" : "Fires when a header is clicked",
- "sig" : "function (_self, columnIndex, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Collapses this region.",
+ "sig" : "(skipAnim)",
+ "static" : false,
+ "memberOf" : "Roo.layout.Region",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "skipAnim",
+ "type" : "Boolean",
+ "desc" : "(optional) true to collapse the element without animation (if animate is true)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "headercontextmenu",
+ "name" : "expand",
"type" : "function",
- "desc" : "Fires when a header is right clicked",
- "sig" : "function (_self, columnIndex, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Expands this region if it was previously collapsed.",
+ "sig" : "(e, skipAnim)",
+ "static" : false,
+ "memberOf" : "Roo.layout.Region",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event that triggered the expand (or null if calling manually)",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "skipAnim",
+ "type" : "Boolean",
+ "desc" : "(optional) true to expand the element without animation (if animate is true)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "headerdblclick",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Fires when a header cell is double clicked",
- "sig" : "function (_self, columnIndex, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
+ "name" : "eventName",
+ "type" : "String",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "keydown",
+ "name" : "getActivePanel",
"type" : "function",
- "desc" : "The raw keydown event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Get the active panel for this region.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.layout.Region",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.panel.Content",
+ "desc" : "The active panel or null"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "keypress",
+ "name" : "getEl",
"type" : "function",
- "desc" : "The raw keypress event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Returns the container element for this region.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.layout.Region",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "mousedown",
+ "name" : "getPanel",
"type" : "function",
- "desc" : "The raw mousedown event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Returns the panel specified or null if it's not in this region.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "Roo.layout.BasicRegion",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "panel",
+ "type" : "Number/String/panel.Content",
+ "desc" : "The panels index, id or the panel itself",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.panel.Content",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "mouseout",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "The raw mouseout event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Returns this regions position (north/south/east/west/center).",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.layout.BasicRegion",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "mouseover",
+ "name" : "getSplitBar",
"type" : "function",
- "desc" : "The raw mouseover event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
+ "desc" : "Returns the {@link Roo.SplitBar} for this region.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.SplitBar",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "mouseup",
+ "name" : "getTabs",
"type" : "function",
- "desc" : "The raw mouseup event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Returns the TabPanel component used by this region",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.layout.Region",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.panel.Tab",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "render",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Fires when the grid is rendered",
- "sig" : "function (grid)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "grid",
- "type" : "Grid",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "rowclass",
+ "name" : "hasPanel",
"type" : "function",
- "desc" : "Fires when a row is rendered, so you can change add a style to it.",
- "sig" : "function (gridview, rowcfg)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Returns true if the panel is in this region.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "Roo.layout.BasicRegion",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "gridview",
- "type" : "GridView",
- "desc" : "The grid view",
- "isOptional" : false
- },
- {
- "name" : "rowcfg",
- "type" : "Object",
- "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.",
+ "name" : "panel",
+ "type" : "Number/String/panel.Content",
+ "desc" : "The panels index, id or the panel itself",
"isOptional" : false
}
],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Hides this region.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.layout.Region",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "rowclick",
+ "name" : "hidePanel",
"type" : "function",
- "desc" : "Fires when a row is clicked",
- "sig" : "function (_self, rowIndex, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Hides the tab for the specified panel.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "Roo.layout.Region",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "panel",
+ "type" : "Number/String/panel.Content",
+ "desc" : "The panel's index, id or the panel itself",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "rowcontextmenu",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Fires when a row is right clicked",
- "sig" : "function (_self, rowIndex, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Returns true if this region is currently visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.layout.Region",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "on",
+ "type" : "function",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "rowdblclick",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Fires when a row is double clicked",
- "sig" : "function (_self, rowIndex, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "startdrag",
+ "name" : "remove",
"type" : "function",
- "desc" : "Fires when row(s) start being dragged",
- "sig" : "function (_self, dd, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
+ "sig" : "(panel, preservePanel)",
+ "static" : false,
+ "memberOf" : "Roo.layout.Region",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
+ "name" : "panel",
+ "type" : "Number/String/panel.Content",
+ "desc" : "The panel's index, id or the panel itself",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "preservePanel",
+ "type" : "Boolean",
+ "desc" : "Overrides the config preservePanel option",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "methods" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.panel.Content",
+ "desc" : "The panel that was removed"
+ }
+ ]
+ },
{
- "name" : "addColumns",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "addColumns\nAdd's a column, default at the end..",
- "sig" : "(position, of)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "position",
- "type" : "int",
- "desc" : "to add (default end)",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "of",
- "type" : "Array",
- "desc" : "objects of column configuration see {@link Roo.grid.ColumnModel}",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addEvents",
+ "name" : "resizeTo",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
+ "sig" : "(newSize)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.layout.BasicRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new width or height",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "setCollapsedTitle",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)",
+ "sig" : "(title)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.layout.Region",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "title",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "desc" : "(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, \"&#160;\")",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "autoSize",
+ "name" : "show",
"type" : "function",
- "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.",
+ "desc" : "Shows this region if it was previously hidden.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.layout.Region",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "capture",
+ "name" : "showPanel",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
+ "desc" : "Shows the specified panel.",
+ "sig" : "(panelId)",
+ "static" : false,
+ "memberOf" : "Roo.layout.Region",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panelId",
+ "type" : "Number/String/panel.Content",
+ "desc" : "The panel's index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.panel.Content",
+ "desc" : "The shown panel, or null if a panel could not be found from panelId"
+ }
+ ]
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
"memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "fn",
+ "name" : "handler",
"type" : "Function",
- "desc" : "The function to call",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "unhidePanel",
"type" : "function",
- "desc" : "Destroy this grid.",
- "sig" : "(removeEl)",
+ "desc" : "Unhides the tab for a previously hidden panel.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.layout.Region",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "removeEl",
- "type" : "Boolean",
- "desc" : "True to remove the element",
+ "name" : "panel",
+ "type" : "Number/String/panel.Content",
+ "desc" : "The panel's index, id or the panel itself",
"isOptional" : false
}
],
"returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.lib" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.lib.Ajax" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "request",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "serializeForm",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
+ "desc" : "serialize a form",
+ "sig" : "(form)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "form",
+ "type" : "DomForm",
+ "desc" : "element",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "String",
+ "desc" : "urlencode form output."
}
]
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.lib.Color" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "getColumnModel",
+ "name" : "getCSSHSL",
"type" : "function",
- "desc" : "Returns the grid's ColumnModel.",
+ "desc" : "getCSSHSL",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : [
{
"name" : "",
- "type" : "ColumnModel",
- "desc" : ""
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS HSL Color value - that\nis, a string of the form hsl(h,s%,l%) where h is in the range [0,100] and\ns and l are in the range [0,100]."
}
]
},
{
- "name" : "getDataSource",
+ "name" : "getCSSHSLA",
"type" : "function",
- "desc" : "Returns the grid's DataSource.",
+ "desc" : "getCSSHSLA",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : [
{
"name" : "",
- "type" : "DataSource",
- "desc" : ""
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS HSLA Color value - that\nis, a string of the form hsla(h,s%,l%,a) where h is in the range [0,100],\ns and l are in the range [0,100], and a is in the range [0,1]."
}
]
},
{
- "name" : "getDragDropText",
+ "name" : "getCSSHexadecimalRGB",
"type" : "function",
- "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.\nOverride this to put something different in the dragged text.",
+ "desc" : "getCSSHexadecimalRGB",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
{
"name" : "",
"type" : "String",
- "desc" : ""
+ "desc" : "a string representing this Color as a CSS hexadecimal RGB Color\nvalue - that is, a string of the form #RRGGBB where each of RR, GG, and BB\nare two-digit hexadecimal numbers."
}
]
},
{
- "name" : "getGridEl",
+ "name" : "getCSSIntegerRGB",
"type" : "function",
- "desc" : "Returns the grid's underlying element.",
+ "desc" : "getCSSIntegerRGB",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : [
{
"name" : "",
- "type" : "Element",
- "desc" : "The element"
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS integer RGB Color\nvalue - that is, a string of the form rgb(r,g,b) where each of r, g, and b\nare integers in the range [0,255]."
}
]
},
{
- "name" : "getSelectionModel",
+ "name" : "getCSSIntegerRGBA",
"type" : "function",
- "desc" : "Returns the grid's SelectionModel.",
+ "desc" : "getCSSIntegerRGBA",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : [
{
"name" : "",
- "type" : "SelectionModel",
- "desc" : ""
+ "type" : "String",
+ "desc" : "Returns a string representing this Color as a CSS integer RGBA Color\nvalue - that is, a string of the form rgba(r,g,b,a) where each of r, g, and\nb are integers in the range [0,255] and a is in the range [0,1]."
}
]
},
{
- "name" : "getView",
+ "name" : "getCSSPercentageRGB",
"type" : "function",
- "desc" : "Returns the grid's GridView object.",
+ "desc" : "getCSSPercentageRGB",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : [
{
"name" : "",
- "type" : "GridView",
- "desc" : ""
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS percentage RGB Color\nvalue - that is, a string of the form rgb(r%,g%,b%) where each of r, g, and\nb are in the range [0,100]."
}
]
},
{
- "name" : "hasListener",
+ "name" : "getCSSPercentageRGBA",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "getCSSPercentageRGBA",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS percentage RGBA Color\nvalue - that is, a string of the form rgba(r%,g%,b%,a) where each of r, g,\nand b are in the range [0,100] and a is in the range [0,1]."
}
]
},
{
- "name" : "on",
+ "name" : "getHSL",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "getHSL",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "options",
+ "name" : "",
"type" : "Object",
- "desc" : "(optional)",
- "isOptional" : false
+ "desc" : "the HSL and alpha components of this Color as an object with h,\ns, l, and a properties. h is in the range [0,360), s and l are in the range\n[0,100], and a is in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "purgeListeners",
+ "name" : "getHSV",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "getHSV",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "the HSV and alpha components of this Color as an object with h,\ns, v, and a properties. h is in the range [0,360), s and v are in the range\n[0,100], and a is in the range [0,1]."
+ }
+ ]
},
{
- "name" : "reconfigure",
+ "name" : "getIntegerRGB",
"type" : "function",
- "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.",
- "sig" : "(dataSource, The)",
+ "desc" : "getIntegerRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "dataSource",
- "type" : "Roo.data.Store",
- "desc" : "The new {@link Roo.data.Store} object",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "The",
- "type" : "Roo.grid.ColumnModel",
- "desc" : "new {@link Roo.grid.ColumnModel} object",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "an object representing the RGBA components of this Color. The red,\ngreen, and blue components are converted to integers in the range [0,255].\nThe alpha is a value in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "releaseCapture",
+ "name" : "getPercentageRGB",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "getPercentageRGB",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "an object representing the RGBA components of this Color. The red,\ngreen, and blue components are converted to numbers in the range [0,100].\nThe alpha is a value in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "removeListener",
+ "name" : "getRGB",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "getRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "scope",
+ "name" : "",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
+ "desc" : "the RGB and alpha components of this Color as an object with r,\ng, b, and a properties. r, g, and b are in the range [0,255] and a is in\nthe range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "render",
+ "name" : "setNodeBackgroundColor",
"type" : "function",
- "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the background Color of the specified node to this Color. This\nfunctions sets the CSS 'background-color' property for the node. The\nparameter is:",
+ "sig" : "(node)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.grid.Grid",
- "desc" : "this"
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "- the node whose background Color should be set",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "un",
+ "name" : "setNodeColor",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Sets the Color of the specified node to this Color. This functions sets\nthe CSS 'color' property for the node. The parameter is:",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "- the node whose Color should be set",
"isOptional" : false
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [
- "Roo.grid.Calendar",
- "Roo.grid.EditorGrid",
- "Roo.grid.PropertyGrid"
+ "Roo.lib.HSLColor",
+ "Roo.lib.HSVColor",
+ "Roo.lib.RGBColor"
],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.grid.GridEditor" : {
- "props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "alignment",
- "type" : "String",
- "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details, defaults to \"c-c?\").",
- "memberOf" : "Roo.Editor",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autosize",
- "type" : "Boolean/String",
- "desc" : "True for the editor to automatically adopt the size of the underlying field, \"width\" to adopt the width only,\nor \"height\" to adopt the height only (defaults to false)",
- "memberOf" : "Roo.Editor",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cancelOnEsc",
- "type" : "Boolean",
- "desc" : "True to cancel the edit when the escape key is pressed (defaults to false)",
- "memberOf" : "Roo.Editor",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "completeOnEnter",
- "type" : "Boolean",
- "desc" : "True to complete the edit when the enter key is pressed (defaults to false)",
- "memberOf" : "Roo.Editor",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "constrain",
- "type" : "Boolean",
- "desc" : "True to constrain the editor to the viewport",
- "memberOf" : "Roo.Editor",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "field",
- "type" : "Roo.form.Field",
- "desc" : "Field to wrap (or xtyped)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideEl",
- "type" : "Boolean",
- "desc" : "False to keep the bound element visible while the editor is displayed (defaults to true)",
- "memberOf" : "Roo.Editor",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
- },
- {
- "name" : "ignoreNoChange",
- "type" : "Boolean",
- "desc" : "True to skip the the edit completion process (no save, no events fired) if the user completes an edit and\nthe value has not changed (defaults to false). Applies only to string values - edits for other data types\nwill never be ignored.",
- "memberOf" : "Roo.Editor",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "revertInvalid",
- "type" : "Boolean",
- "desc" : "True to automatically revert the field value and cancel the edit when the user completes an edit and the field\nvalidation fails (defaults to true)",
- "memberOf" : "Roo.Editor",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "shadow",
- "type" : "Boolean/String",
- "desc" : "\"sides\" for sides/bottom only, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"frame\")",
- "memberOf" : "Roo.Editor",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "css styles to add to component\neg. text-align:right;",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "updateEl",
- "type" : "Boolean",
- "desc" : "True to update the innerHTML of the bound element when the update completes (defaults to false)",
- "memberOf" : "Roo.Editor",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The data value of the underlying field (defaults to \"\")",
- "memberOf" : "Roo.Editor",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "beforecomplete",
- "type" : "function",
- "desc" : "Fires after a change has been made to the field, but before the change is reflected in the underlying\nfield. Saving the change to the field can be canceled by returning false from the handler of this event.\nNote that if the value has not changed and ignoreNoChange = true, the editing will still end but this\nevent will not fire since no edit actually occurred.",
- "sig" : "function (_self, value, startValue)\n{\n\n}",
- "memberOf" : "Roo.Editor",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Editor",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The current field value",
- "isOptional" : false
- },
- {
- "name" : "startValue",
- "type" : "Mixed",
- "desc" : "The original field value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforestartedit",
- "type" : "function",
- "desc" : "Fires when editing is initiated, but before the value changes. Editing can be canceled by returning\nfalse from the handler of this event.",
- "sig" : "function (_self, boundEl, value)\n{\n\n}",
- "memberOf" : "Roo.Editor",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Editor",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "boundEl",
- "type" : "Roo.Element",
- "desc" : "The underlying element bound to this editor",
- "isOptional" : false
- },
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The field value being set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "complete",
- "type" : "function",
- "desc" : "Fires after editing is complete and any changed value has been written to the underlying field.",
- "sig" : "function (_self, value, startValue)\n{\n\n}",
- "memberOf" : "Roo.Editor",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Editor",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The current field value",
- "isOptional" : false
- },
- {
- "name" : "startValue",
- "type" : "Mixed",
- "desc" : "The original field value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
+ "Roo.lib.Dom" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "destroy",
+ "name" : "getDocumentHeight",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Get the Full Document height",
+ "sig" : "()\n{\n\n}",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The height"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "disable",
+ "name" : "getDocumentWidth",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Get the Full Document width",
+ "sig" : "()\n{\n\n}",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The width"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "enable",
+ "name" : "getViewHeight",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Get the view height",
+ "sig" : "(full)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "full",
+ "type" : "Boolean",
+ "desc" : "True will get the full document, otherwise it's the view height",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The height"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "render",
+ "name" : "getViewWidth",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Get the view width",
+ "sig" : "(full)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "full",
+ "type" : "Boolean",
+ "desc" : "True will get the full document, otherwise it's the view width",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The width"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "specialkey",
+ "name" : "getViewportHeight",
"type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.Editor",
+ "desc" : "Get the Window Viewport height",
+ "sig" : "()\n{\n\n}",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The height"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "startedit",
+ "name" : "getViewportWidth",
"type" : "function",
- "desc" : "Fires when this editor is displayed",
- "sig" : "function (boundEl, value)\n{\n\n}",
- "memberOf" : "Roo.Editor",
+ "desc" : "Get the Window Viewport width",
+ "sig" : "()\n{\n\n}",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "boundEl",
- "type" : "Roo.Element",
- "desc" : "The underlying element bound to this editor",
- "isOptional" : false
- },
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The starting field value",
- "isOptional" : false
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The width"
}
- ],
- "returns" : []
+ ]
}
],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.lib.HSLColor" : {
+ "props" : [],
+ "events" : [],
"methods" : [
{
- "name" : "addEvents",
+ "name" : "getCSSHSL",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "getCSSHSL",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS HSL Color value - that\nis, a string of the form hsl(h,s%,l%) where h is in the range [0,100] and\ns and l are in the range [0,100]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "addListener",
+ "name" : "getCSSHSLA",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "getCSSHSLA",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "eventName",
+ "name" : "",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
- "isOptional" : false
+ "desc" : "a string representing this Color as a CSS HSLA Color value - that\nis, a string of the form hsla(h,s%,l%,a) where h is in the range [0,100],\ns and l are in the range [0,100], and a is in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "cancelEdit",
+ "name" : "getCSSHexadecimalRGB",
"type" : "function",
- "desc" : "Cancels the editing process and hides the editor without persisting any changes. The field value will be\nreverted to the original starting value.",
- "sig" : "(remainVisible)",
+ "desc" : "getCSSHexadecimalRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Editor",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "remainVisible",
- "type" : "Boolean",
- "desc" : "Override the default behavior and keep the editor visible after\ncancel (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "capture",
- "type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS hexadecimal RGB Color\nvalue - that is, a string of the form #RRGGBB where each of RR, GG, and BB\nare two-digit hexadecimal numbers."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "completeEdit",
+ "name" : "getCSSIntegerRGB",
"type" : "function",
- "desc" : "Ends the editing process, persists the changed value to the underlying field, and hides the editor.",
- "sig" : "(remainVisible)",
+ "desc" : "getCSSIntegerRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Editor",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "remainVisible",
- "type" : "Boolean",
- "desc" : "Override the default behavior and keep the editor visible after edit (defaults to false)",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS integer RGB Color\nvalue - that is, a string of the form rgb(r,g,b) where each of r, g, and b\nare integers in the range [0,255]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "destroy",
+ "name" : "getCSSIntegerRGBA",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "desc" : "getCSSIntegerRGBA",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "Returns a string representing this Color as a CSS integer RGBA Color\nvalue - that is, a string of the form rgba(r,g,b,a) where each of r, g, and\nb are integers in the range [0,255] and a is in the range [0,1]."
+ }
+ ]
},
{
- "name" : "disable",
+ "name" : "getCSSPercentageRGB",
"type" : "function",
- "desc" : "Disable this component.",
+ "desc" : "getCSSPercentageRGB",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS percentage RGB Color\nvalue - that is, a string of the form rgb(r%,g%,b%) where each of r, g, and\nb are in the range [0,100]."
}
]
},
{
- "name" : "enable",
+ "name" : "getCSSPercentageRGBA",
"type" : "function",
- "desc" : "Enable this component.",
+ "desc" : "getCSSPercentageRGBA",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS percentage RGBA Color\nvalue - that is, a string of the form rgba(r%,g%,b%,a) where each of r, g,\nand b are in the range [0,100] and a is in the range [0,1]."
}
]
},
{
- "name" : "fireEvent",
+ "name" : "getHSL",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "getHSL",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "Object",
+ "desc" : "the HSL and alpha components of this Color as an object with h,\ns, l, and a properties. h is in the range [0,360), s and l are in the range\n[0,100], and a is in the range [0,1]."
}
]
},
{
- "name" : "focus",
+ "name" : "getHSV",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "getHSV",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Object",
+ "desc" : "the HSV and alpha components of this Color as an object with h,\ns, v, and a properties. h is in the range [0,360), s and v are in the range\n[0,100], and a is in the range [0,1]."
}
]
},
{
- "name" : "getEl",
+ "name" : "getIntegerRGB",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "getIntegerRGB",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "Object",
+ "desc" : "an object representing the RGBA components of this Color. The red,\ngreen, and blue components are converted to integers in the range [0,255].\nThe alpha is a value in the range [0,1]."
}
]
},
{
- "name" : "getId",
+ "name" : "getPercentageRGB",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "getPercentageRGB",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Object",
+ "desc" : "an object representing the RGBA components of this Color. The red,\ngreen, and blue components are converted to numbers in the range [0,100].\nThe alpha is a value in the range [0,1]."
}
]
},
{
- "name" : "getValue",
+ "name" : "getRGB",
"type" : "function",
- "desc" : "Gets the data value of the editor",
+ "desc" : "getRGB",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Editor",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "The data value"
+ "type" : "Object",
+ "desc" : "the RGB and alpha components of this Color as an object with r,\ng, b, and a properties. r, g, and b are in the range [0,255] and a is in\nthe range [0,1]."
}
]
},
{
- "name" : "hasListener",
+ "name" : "setNodeBackgroundColor",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Sets the background Color of the specified node to this Color. This\nfunctions sets the CSS 'background-color' property for the node. The\nparameter is:",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "- the node whose background Color should be set",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "hide",
+ "name" : "setNodeColor",
"type" : "function",
- "desc" : "Hide this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the Color of the specified node to this Color. This functions sets\nthe CSS 'color' property for the node. The parameter is:",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "- the node whose Color should be set",
+ "isOptional" : false
}
- ]
- },
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.lib.HSVColor" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "isVisible",
+ "name" : "getCSSHSL",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
+ "desc" : "getCSSHSL",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS HSL Color value - that\nis, a string of the form hsl(h,s%,l%) where h is in the range [0,100] and\ns and l are in the range [0,100]."
+ }
+ ]
},
{
- "name" : "on",
+ "name" : "getCSSHSLA",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "getCSSHSLA",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "eventName",
+ "name" : "",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
- "isOptional" : false
+ "desc" : "a string representing this Color as a CSS HSLA Color value - that\nis, a string of the form hsla(h,s%,l%,a) where h is in the range [0,100],\ns and l are in the range [0,100], and a is in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "purgeListeners",
+ "name" : "getCSSHexadecimalRGB",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "getCSSHexadecimalRGB",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS hexadecimal RGB Color\nvalue - that is, a string of the form #RRGGBB where each of RR, GG, and BB\nare two-digit hexadecimal numbers."
+ }
+ ]
},
{
- "name" : "realign",
+ "name" : "getCSSIntegerRGB",
"type" : "function",
- "desc" : "Realigns the editor to the bound field based on the current alignment config value.",
+ "desc" : "getCSSIntegerRGB",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Editor",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS integer RGB Color\nvalue - that is, a string of the form rgb(r,g,b) where each of r, g, and b\nare integers in the range [0,255]."
+ }
+ ]
},
{
- "name" : "releaseCapture",
+ "name" : "getCSSIntegerRGBA",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "getCSSIntegerRGBA",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.lib.Color",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "Returns a string representing this Color as a CSS integer RGBA Color\nvalue - that is, a string of the form rgba(r,g,b,a) where each of r, g, and\nb are integers in the range [0,255] and a is in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "removeListener",
+ "name" : "getCSSPercentageRGB",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "getCSSPercentageRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "eventName",
+ "name" : "",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
+ "desc" : "a string representing this Color as a CSS percentage RGB Color\nvalue - that is, a string of the form rgb(r%,g%,b%) where each of r, g, and\nb are in the range [0,100]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "render",
+ "name" : "getCSSPercentageRGBA",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "getCSSPercentageRGBA",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS percentage RGBA Color\nvalue - that is, a string of the form rgba(r%,g%,b%,a) where each of r, g,\nand b are in the range [0,100] and a is in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setDisabled",
+ "name" : "getHSL",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "getHSL",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "the HSL and alpha components of this Color as an object with h,\ns, l, and a properties. h is in the range [0,360), s and l are in the range\n[0,100], and a is in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setSize",
+ "name" : "getHSV",
"type" : "function",
- "desc" : "Sets the height and width of this editor.",
- "sig" : "(width, height)",
+ "desc" : "getHSV",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Editor",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The new width",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "height",
- "type" : "Number",
- "desc" : "The new height",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "the HSV and alpha components of this Color as an object with h,\ns, v, and a properties. h is in the range [0,360), s and v are in the range\n[0,100], and a is in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setValue",
+ "name" : "getIntegerRGB",
"type" : "function",
- "desc" : "Sets the data value of the editor",
- "sig" : "(value)",
+ "desc" : "getIntegerRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Editor",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "Any valid value supported by the underlying field",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "an object representing the RGBA components of this Color. The red,\ngreen, and blue components are converted to integers in the range [0,255].\nThe alpha is a value in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setVisible",
+ "name" : "getPercentageRGB",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "getPercentageRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Object",
+ "desc" : "an object representing the RGBA components of this Color. The red,\ngreen, and blue components are converted to numbers in the range [0,100].\nThe alpha is a value in the range [0,1]."
}
]
},
{
- "name" : "show",
+ "name" : "getRGB",
"type" : "function",
- "desc" : "Show this component.",
+ "desc" : "getRGB",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Object",
+ "desc" : "the RGB and alpha components of this Color as an object with r,\ng, b, and a properties. r, g, and b are in the range [0,255] and a is in\nthe range [0,1]."
}
]
},
{
- "name" : "startEdit",
+ "name" : "setNodeBackgroundColor",
"type" : "function",
- "desc" : "Starts the editing process and shows the editor.",
- "sig" : "(el, value)",
+ "desc" : "Sets the background Color of the specified node to this Color. This\nfunctions sets the CSS 'background-color' property for the node. The\nparameter is:",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.Editor",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The element to edit",
- "isOptional" : false
- },
- {
- "name" : "value",
- "type" : "String",
- "desc" : "(optional) A value to initialize the editor with. If a value is not provided, it defaults\nto the innerHTML of el.",
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "- the node whose background Color should be set",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "un",
+ "name" : "setNodeColor",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Sets the Color of the specified node to this Color. This functions sets\nthe CSS 'color' property for the node. The parameter is:",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "- the node whose Color should be set",
"isOptional" : false
}
],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.grid.GridView" : {
- "props" : [
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- }
- ],
+ "Roo.lib.RGBColor" : {
+ "props" : [],
"events" : [],
"methods" : [
{
- "name" : "addEvents",
+ "name" : "getCSSHSL",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "getCSSHSL",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS HSL Color value - that\nis, a string of the form hsl(h,s%,l%) where h is in the range [0,100] and\ns and l are in the range [0,100]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "addListener",
+ "name" : "getCSSHSLA",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "getCSSHSLA",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "eventName",
+ "name" : "",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
- "isOptional" : false
+ "desc" : "a string representing this Color as a CSS HSLA Color value - that\nis, a string of the form hsla(h,s%,l%,a) where h is in the range [0,100],\ns and l are in the range [0,100], and a is in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "autoSizeColumn",
+ "name" : "getCSSHexadecimalRGB",
"type" : "function",
- "desc" : "Autofit a column to its content.",
- "sig" : "(colIndex, forceMinSize)",
+ "desc" : "getCSSHexadecimalRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "colIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "forceMinSize",
- "type" : "Boolean",
- "desc" : "true to force the column to go smaller if possible",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS hexadecimal RGB Color\nvalue - that is, a string of the form #RRGGBB where each of RR, GG, and BB\nare two-digit hexadecimal numbers."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "autoSizeColumns",
+ "name" : "getCSSIntegerRGB",
"type" : "function",
- "desc" : "Autofits all columns to their content and then expands to fit any extra space in the grid",
+ "desc" : "getCSSIntegerRGB",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
- },
- {
- "name" : "capture",
- "type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
+ "returns" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS integer RGB Color\nvalue - that is, a string of the form rgb(r,g,b) where each of r, g, and b\nare integers in the range [0,255]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "ensureVisible",
+ "name" : "getCSSIntegerRGBA",
"type" : "function",
- "desc" : "Scrolls the specified cell into view",
- "sig" : "(row, col, hscroll)",
+ "desc" : "getCSSIntegerRGBA",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "row",
- "type" : "Number",
- "desc" : "The row index",
- "isOptional" : false
- },
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "hscroll",
- "type" : "Boolean",
- "desc" : "false to disable horizontal scrolling",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "Returns a string representing this Color as a CSS integer RGBA Color\nvalue - that is, a string of the form rgba(r,g,b,a) where each of r, g, and\nb are integers in the range [0,255] and a is in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "fireEvent",
+ "name" : "getCSSPercentageRGB",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "getCSSPercentageRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS percentage RGB Color\nvalue - that is, a string of the form rgb(r%,g%,b%) where each of r, g, and\nb are in the range [0,100]."
}
]
},
{
- "name" : "fitColumns",
+ "name" : "getCSSPercentageRGBA",
"type" : "function",
- "desc" : "Autofits all columns to the grid's width proportionate with their current size",
- "sig" : "(reserveScrollSpace)",
+ "desc" : "getCSSPercentageRGBA",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "reserveScrollSpace",
- "type" : "Boolean",
- "desc" : "Reserve space for a scrollbar",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS percentage RGBA Color\nvalue - that is, a string of the form rgba(r%,g%,b%,a) where each of r, g,\nand b are in the range [0,100] and a is in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "focusCell",
+ "name" : "getHSL",
"type" : "function",
- "desc" : "Focuses the specified cell.",
- "sig" : "(row, col, hscroll)",
+ "desc" : "getHSL",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "row",
- "type" : "Number",
- "desc" : "The row index",
- "isOptional" : false
- },
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "hscroll",
- "type" : "Boolean",
- "desc" : "false to disable horizontal scrolling",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "the HSL and alpha components of this Color as an object with h,\ns, l, and a properties. h is in the range [0,360), s and l are in the range\n[0,100], and a is in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "focusRow",
+ "name" : "getHSV",
"type" : "function",
- "desc" : "Focuses the specified row.",
- "sig" : "(row)",
+ "desc" : "getHSV",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "row",
- "type" : "Number",
- "desc" : "The row index",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "the HSV and alpha components of this Color as an object with h,\ns, v, and a properties. h is in the range [0,360), s and v are in the range\n[0,100], and a is in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "getCell",
+ "name" : "getIntegerRGB",
"type" : "function",
- "desc" : "Gets the 'td' of the cell",
- "sig" : "(rowIndex, colIndex)",
+ "desc" : "getIntegerRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "rowIndex",
- "type" : "Integer",
- "desc" : "row to select",
- "isOptional" : false
- },
- {
- "name" : "colIndex",
- "type" : "Integer",
- "desc" : "column to select",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
"type" : "Object",
- "desc" : ""
+ "desc" : "an object representing the RGBA components of this Color. The red,\ngreen, and blue components are converted to integers in the range [0,255].\nThe alpha is a value in the range [0,1]."
}
]
},
{
- "name" : "getFooterPanel",
+ "name" : "getPercentageRGB",
"type" : "function",
- "desc" : "Gets a panel in the footer of the grid that can be used for toolbars etc.\nAfter modifying the contents of this panel a call to grid.autoSize() may be\nrequired to register any changes in size.",
- "sig" : "(doShow)",
+ "desc" : "getPercentageRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "doShow",
- "type" : "Boolean",
- "desc" : "By default the footer is hidden. Pass true to show the panel",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "",
- "desc" : "Roo.Element"
+ "type" : "Object",
+ "desc" : "an object representing the RGBA components of this Color. The red,\ngreen, and blue components are converted to numbers in the range [0,100].\nThe alpha is a value in the range [0,1]."
}
]
},
{
- "name" : "getHeaderPanel",
+ "name" : "getRGB",
"type" : "function",
- "desc" : "Gets a panel in the header of the grid that can be used for toolbars etc.\nAfter modifying the contents of this panel a call to grid.autoSize() may be\nrequired to register any changes in size.",
- "sig" : "(doShow)",
+ "desc" : "getRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "doShow",
- "type" : "Boolean",
- "desc" : "By default the header is hidden. Pass true to show the panel",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "",
- "desc" : "Roo.Element"
+ "type" : "Object",
+ "desc" : "the RGB and alpha components of this Color as an object with r,\ng, b, and a properties. r, g, and b are in the range [0,255] and a is in\nthe range [0,1]."
}
]
},
{
- "name" : "hasListener",
+ "name" : "setNodeBackgroundColor",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Sets the background Color of the specified node to this Color. This\nfunctions sets the CSS 'background-color' property for the node. The\nparameter is:",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "- the node whose background Color should be set",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "on",
+ "name" : "setNodeColor",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Sets the Color of the specified node to this Color. This functions sets\nthe CSS 'color' property for the node. The parameter is:",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "- the node whose Color should be set",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.lib.Range" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "purgeListeners",
+ "name" : "wrap",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
+ "desc" : "Wrap a Dom Range object, to give it new features...",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "Range",
+ "desc" : "range to wrap",
+ "isOptional" : false
+ }
+ ],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.lib.Selection" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "refresh",
+ "name" : "insertNode",
"type" : "function",
- "desc" : "Refreshes the grid",
- "sig" : "(headersToo)",
+ "desc" : "insert node at selection",
+ "sig" : "(node, cursor)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "headersToo",
- "type" : "Boolean",
+ "name" : "node",
+ "type" : "DomElement|string",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "cursor",
+ "type" : "string",
+ "desc" : "(after|in|none) where to place the cursor after inserting.",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "wrap",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
+ "desc" : "Wrap a Dom Range object, to give it new features...",
+ "sig" : "(the)",
"static" : true,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "the",
+ "type" : "Range",
+ "desc" : "range to wrap",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.lib.UndoManager" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "removeListener",
+ "name" : "addEvent",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Manually add an event.\nNormall called without arguements - and it will just get added to the stack.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "scrollToTop",
+ "name" : "reset",
"type" : "function",
- "desc" : "Scrolls the grid to the top",
+ "desc" : "Reset the undo - probaly done on load to clear all history.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : []
},
{
- "name" : "un",
+ "name" : "transact",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "To push and execute a transaction, the method undoManager.transact\nmust be called by passing a transaction object as the first argument, and a merge\nflag as the second argument. A transaction object has the following properties:\n\nUsage:\n<pre><code>\nundoManager.transact({\n label: 'Typing',\n execute: function() { ... },\n undo: function() { ... },\n // redo same as execute\n redo: function() { this.execute(); }\n}, false);\n\n// merge transaction\nundoManager.transact({\n label: 'Typing',\n execute: function() { ... }, // this will be run...\n undo: function() { ... }, // what to do when undo is run.\n // redo same as execute\n redo: function() { this.execute(); }\n}, true); \n</code></pre>",
+ "sig" : "(transaction)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
+ "name" : "transaction",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "The transaction to add to the stack.",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "The HTML fragment"
+ }
+ ]
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.grid.PropertyGrid" : {
- "props" : [
- {
- "name" : "autoExpandColumn",
- "type" : "String",
- "desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoExpandMax",
- "type" : "Number",
- "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoExpandMin",
- "type" : "Number",
- "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoHeight",
- "type" : "Boolean",
- "desc" : "True to fit the height of the grid container to the height of the data. Default is false.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoSizeColumns",
- "type" : "Boolean",
- "desc" : "True to automatically resize the columns to fit their content\n<b>on initial render.</b> It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoSizeHeaders",
- "type" : "Boolean",
- "desc" : "True to measure headers with column data when auto sizing columns. Default is true.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoWidth",
- "type" : "Boolean",
- "desc" : "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "clicksToEdit",
- "type" : "Number",
- "desc" : "The number of clicks on a cell required to display the cell's editor (defaults to 2)",
- "memberOf" : "Roo.grid.EditorGrid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cm[]",
- "type" : "Roo.grid.ColumnModel",
- "desc" : "The columns of the grid",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "customEditors",
- "type" : "Object",
- "desc" : "map of colnames=> custom editors.\nthe custom editor can be one of the standard ones (date|string|number|int|boolean), or a\ngrid editor eg. Roo.grid.GridEditor(new Roo.form.TextArea({selectOnFocus:true})),\nfalse disables editing of the field.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "ddGroup",
- "type" : "String",
- "desc" : "- drag drop group.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "ddText",
- "type" : "String",
- "desc" : "Configures the text is the drag proxy (defaults to \"%0 selected row(s)\").\n%0 is replaced with the number of selected rows.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "dragGroup",
- "type" : "String",
- "desc" : "- drag group (?? not sure if needed.)",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "dropTarget",
- "type" : "Roo.dd.DropTarget",
- "desc" : "An {@link Roo.dd.DropTarget} config",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
+ "Roo.menu" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.menu.Adapter" : {
+ "props" : [
{
- "name" : "ds",
- "type" : "Roo.data.Store",
- "desc" : "The data store for the grid",
- "memberOf" : "Roo.grid.Grid",
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "enableColumnHide",
- "type" : "Boolean",
- "desc" : "True to enable hiding of columns with the header context menu. Default is true.",
- "memberOf" : "Roo.grid.Grid",
+ "name" : "activeClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")",
+ "memberOf" : "Roo.menu.BaseItem",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "enableColumnMove",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "True to enable drag and drop reorder of columns. Default is true.",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "enableDrag",
+ "name" : "canActivate",
"type" : "Boolean",
- "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "True if this item can be visually activated (defaults to false)",
+ "memberOf" : "Roo.menu.BaseItem",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "enableDragDrop",
- "type" : "Boolean",
- "desc" : "True to enable drag and drop of rows. Default is false.",
- "memberOf" : "Roo.grid.Grid",
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "enableDrop",
- "type" : "Boolean",
- "desc" : "True to enable drop of elements. Default is false. (double check if this is needed?)",
- "memberOf" : "Roo.grid.Grid",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
+ "memberOf" : "Roo.menu.BaseItem",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "enableRowHeightSync",
+ "name" : "hidden",
"type" : "Boolean",
- "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "footer",
- "type" : "Roo.PagingToolbar",
- "desc" : "the paging toolbar",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "loadMask",
- "type" : "Object",
- "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "True to prevent creation of this menu item (defaults to false)",
+ "memberOf" : "Roo.menu.BaseItem",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "maxHeight",
+ "name" : "hideDelay",
"type" : "Number",
- "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxRowsToMeasure",
- "type" : "Boolean",
- "desc" : "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
+ "memberOf" : "Roo.menu.BaseItem",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "minColumnWidth",
- "type" : "Number",
- "desc" : "The minimum width a column can be resized to. Default is 25.",
- "memberOf" : "Roo.grid.Grid",
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "monitorWindowResize",
+ "name" : "hideOnClick",
"type" : "Boolean",
- "desc" : "True to autoSize the grid when the window resizes. Default is true.",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "True to hide the containing menu after this item is clicked (defaults to true)",
+ "memberOf" : "Roo.menu.BaseItem",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "propertyNames",
+ "name" : "listeners",
"type" : "Object",
- "desc" : "map of property Names to their displayed value",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "sm",
- "type" : "Roo.grid.AbstractSelectionModel",
- "desc" : "The selection Model (default = Roo.grid.RowSelectionModel)",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "sortColMenu",
- "type" : "boolean",
- "desc" : "Sort the column order menu when it shows (usefull for long lists..) default false",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "stripeRows",
- "type" : "Boolean",
- "desc" : "True to stripe the rows. Default is true.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "toolbar",
- "type" : "Roo.Toolbar",
- "desc" : "a toolbar for buttons etc.",
- "memberOf" : "Roo.grid.Grid",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "trackMouseOver",
- "type" : "Boolean",
- "desc" : "True to highlight rows when the mouse is over. Default is true.",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "view",
- "type" : "Roo.grid.GridView",
- "desc" : "The view that renders the grid (default = Roo.grid.GridView)",
- "memberOf" : "Roo.grid.Grid",
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
{
- "name" : "afteredit",
+ "name" : "activate",
"type" : "function",
- "desc" : "Fires after a cell is edited. <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n</ul>",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.EditorGrid",
+ "desc" : "Fires when this item is activated",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.menu.BaseItem",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Object",
- "desc" : "An edit event (see above for description)",
+ "name" : "this",
+ "type" : "Roo.menu.BaseItem",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeedit",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fires before cell editing is triggered. The edit event object has the following properties <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value for the field being edited.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.EditorGrid",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Object",
- "desc" : "An edit event (see above for description)",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforepropertychange",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Fires before a property changes (return false to stop?)",
- "sig" : "function (grid, id, newval, oldval)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "grid",
- "type" : "Roo.grid.PropertyGrid",
- "desc" : "property grid? (check could be store)",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String",
- "desc" : "Record Id",
- "isOptional" : false
- },
- {
- "name" : "newval",
- "type" : "String",
- "desc" : "New Value",
- "isOptional" : false
- },
- {
- "name" : "oldval",
- "type" : "String",
- "desc" : "Old Value",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "bodyscroll",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires when the body element is scrolled",
- "sig" : "function (scrollLeft, scrollTop)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "scrollLeft",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "scrollTop",
- "type" : "Number",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "cellclick",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Fires when a cell is clicked",
- "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "cellcontextmenu",
+ "name" : "click",
"type" : "function",
- "desc" : "Fires when a cell is right clicked",
- "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires when this item is clicked",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.menu.BaseItem",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "cellIndex",
- "type" : "Number",
+ "type" : "Roo.menu.BaseItem",
"desc" : "",
"isOptional" : false
},
"returns" : []
},
{
- "name" : "celldblclick",
+ "name" : "deactivate",
"type" : "function",
- "desc" : "Fires when a cell is double clicked",
- "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires when this item is deactivated",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.menu.BaseItem",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.menu.BaseItem",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "click",
+ "name" : "destroy",
"type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "columnmove",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires when the user moves a column",
- "sig" : "function (oldIndex, newIndex)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "oldIndex",
- "type" : "Number",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "newIndex",
- "type" : "Number",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "columnresize",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires when the user resizes a column",
- "sig" : "function (columnIndex, newSize)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "columnIndex",
- "type" : "Number",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "newSize",
- "type" : "Number",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "contextmenu",
+ "name" : "show",
"type" : "function",
- "desc" : "The raw contextmenu event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "dblclick",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "The raw dblclick event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "dragdrop",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Fires when dragged row(s) are dropped on a valid DD target",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "dragenter",
+ "name" : "capture",
"type" : "function",
- "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "dragout",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "fireEvent",
+ "type" : "function",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
+ "name" : "eventName",
+ "type" : "String",
"desc" : "",
"isOptional" : false
},
{
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "The element"
+ }
+ ]
+ },
+ {
+ "name" : "getId",
+ "type" : "function",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "hasListener",
+ "type" : "function",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Hide this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "dragover",
+ "name" : "on",
"type" : "function",
- "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enddrag",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Fires when a drag operation is complete",
- "sig" : "function (_self, dd, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "headerclick",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Fires when a header is clicked",
- "sig" : "function (_self, columnIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "headercontextmenu",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires when a header is right clicked",
- "sig" : "function (_self, columnIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "columnIndex",
- "type" : "Number",
+ "name" : "disabled",
+ "type" : "Boolean",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "headerdblclick",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires when a header cell is double clicked",
- "sig" : "function (_self, columnIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Show this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
+ }
+ ],
+ "isAbstract" : true,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.menu.ColorItem",
+ "Roo.menu.DateItem"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.menu.BaseItem" : {
+ "props" : [
+ {
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "keydown",
- "type" : "function",
- "desc" : "The raw keydown event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "activeClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "keypress",
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "canActivate",
+ "type" : "Boolean",
+ "desc" : "True if this item can be visually activated (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "True to prevent creation of this menu item (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideDelay",
+ "type" : "Number",
+ "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "hideOnClick",
+ "type" : "Boolean",
+ "desc" : "True to hide the containing menu after this item is clicked (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "activate",
"type" : "function",
- "desc" : "The raw keypress event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires when this item is activated",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.menu.BaseItem",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "mousedown",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "The raw mousedown event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "mouseout",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "The raw mouseout event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "mouseover",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "The raw mouseover event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "mouseup",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "The raw mouseup event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "propertychange",
+ "name" : "click",
"type" : "function",
- "desc" : "Fires after a property changes",
- "sig" : "function (grid, id, newval, oldval)\n{\n\n}",
+ "desc" : "Fires when this item is clicked",
+ "sig" : "function (_self, e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "grid",
- "type" : "Roo.grid.PropertyGrid",
- "desc" : "property grid? (check could be store)",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String",
- "desc" : "Record Id",
- "isOptional" : false
- },
- {
- "name" : "newval",
- "type" : "String",
- "desc" : "New Value",
+ "name" : "this",
+ "type" : "Roo.menu.BaseItem",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "oldval",
- "type" : "String",
- "desc" : "Old Value",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "deactivate",
"type" : "function",
- "desc" : "Fires when the grid is rendered",
- "sig" : "function (grid)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires when this item is deactivated",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "grid",
- "type" : "Grid",
+ "name" : "this",
+ "type" : "Roo.menu.BaseItem",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "rowclass",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires when a row is rendered, so you can change add a style to it.",
- "sig" : "function (gridview, rowcfg)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "gridview",
- "type" : "GridView",
- "desc" : "The grid view",
- "isOptional" : false
- },
- {
- "name" : "rowcfg",
- "type" : "Object",
- "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "rowclick",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires when a row is clicked",
- "sig" : "function (_self, rowIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "rowcontextmenu",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires when a row is right clicked",
- "sig" : "function (_self, rowIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "rowdblclick",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires when a row is double clicked",
- "sig" : "function (_self, rowIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "startdrag",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires when row(s) start being dragged",
- "sig" : "function (_self, dd, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "validateedit",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires after a cell is edited, but before the value is set in the record. \nYou can use this to modify the value being set in the field, Return false\nto cancel the change. The edit event object has the following properties <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>editor - This editor</li>\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.EditorGrid",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Object",
- "desc" : "An edit event (see above for description)",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
}
],
"methods" : [
- {
- "name" : "addColumns",
- "type" : "function",
- "desc" : "addColumns\nAdd's a column, default at the end..",
- "sig" : "(position, of)",
- "static" : false,
- "memberOf" : "Roo.grid.Grid",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "position",
- "type" : "int",
- "desc" : "to add (default end)",
- "isOptional" : false
- },
- {
- "name" : "of",
- "type" : "Array",
- "desc" : "objects of column configuration see {@link Roo.grid.ColumnModel}",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "addEvents",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.grid.Grid",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
{
"name" : "destroy",
"type" : "function",
- "desc" : "Destroy this grid.",
- "sig" : "(removeEl)",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "removeEl",
- "type" : "Boolean",
- "desc" : "True to remove the element",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "fireEvent",
]
},
{
- "name" : "getColumnModel",
+ "name" : "focus",
"type" : "function",
- "desc" : "Returns the grid's ColumnModel.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "ColumnModel",
- "desc" : ""
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getDataSource",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns the grid's DataSource.",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "DataSource",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "getDragDropText",
+ "name" : "getId",
"type" : "function",
- "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.grid.EditorGrid",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
]
},
{
- "name" : "getGridEl",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Returns the grid's underlying element.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Element",
- "desc" : "The element"
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "getSelectionModel",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns the grid's SelectionModel.",
+ "desc" : "Hide this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "SelectionModel",
- "desc" : ""
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getSource",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Gets all the data from the grid.",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "on",
+ "type" : "function",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
"type" : "Object",
- "desc" : "data data stored in grid"
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getView",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Returns the grid's GridView object.",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "GridView",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
"memberOf" : "Roo.util.Observable",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "on",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "reconfigure",
+ "name" : "un",
"type" : "function",
- "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.",
- "sig" : "(dataSource, The)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "dataSource",
- "type" : "Roo.data.Store",
- "desc" : "The new {@link Roo.data.Store} object",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "The",
- "type" : "Roo.grid.ColumnModel",
- "desc" : "new {@link Roo.grid.ColumnModel} object",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : true,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.menu.Adapter",
+ "Roo.menu.CheckItem",
+ "Roo.menu.ColorItem",
+ "Roo.menu.DateItem",
+ "Roo.menu.Item",
+ "Roo.menu.Separator",
+ "Roo.menu.TextItem"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.menu.CheckItem" : {
+ "props" : [
+ {
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "activeClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")",
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "canActivate",
+ "type" : "Boolean",
+ "desc" : "True if this item can be visually activated (defaults to true)",
+ "memberOf" : "Roo.menu.Item",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "checked",
+ "type" : "Boolean",
+ "desc" : "True to initialize this checkbox as checked (defaults to false). Note that\nif this checkbox is part of a radio group (group = true) only the last item in the group that is\ninitialized with checked = true will be rendered as checked.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "group",
+ "type" : "String",
+ "desc" : "All check items with the same group name will automatically be grouped into a single-select\nradio button group (defaults to '')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "groupClass",
+ "type" : "String",
+ "desc" : "The default CSS class to use for radio group check items (defaults to \"x-menu-group-item\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "True to prevent creation of this menu item (defaults to false)",
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideDelay",
+ "type" : "Number",
+ "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "hideOnClick",
+ "type" : "Boolean",
+ "desc" : "True to hide the containing menu after this item is clicked (defaults to true)",
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "to render in menu\nThe text to show on the menu item (HTML version).",
+ "memberOf" : "Roo.menu.Item",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "icon",
+ "type" : "String",
+ "desc" : "The path to an icon to display in this menu item (defaults to Roo.BLANK_IMAGE_URL)",
+ "memberOf" : "Roo.menu.Item",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "itemCls",
+ "type" : "String",
+ "desc" : "The default CSS class to use for check items (defaults to \"x-menu-item x-menu-check-item\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "menu",
+ "type" : "Roo.menu.Menu",
+ "desc" : "A Sub menu",
+ "memberOf" : "Roo.menu.Item",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "showDelay",
+ "type" : "Number",
+ "desc" : "Length of time in milliseconds to wait before showing this item (defaults to 200)",
+ "memberOf" : "Roo.menu.Item",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "The text to show on the menu item.",
+ "memberOf" : "Roo.menu.Item",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "activate",
+ "type" : "function",
+ "desc" : "Fires when this item is activated",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.menu.BaseItem",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.menu.BaseItem",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforecheckchange",
+ "type" : "function",
+ "desc" : "Fires before the checked value is set, providing an opportunity to cancel if needed",
+ "sig" : "function (_self, checked)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.menu.CheckItem",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "checked",
+ "type" : "Boolean",
+ "desc" : "The new checked value that will be set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforedestroy",
+ "type" : "function",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.grid.Grid",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.grid.Grid",
- "desc" : "this"
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "setSource",
+ "name" : "checkchange",
"type" : "function",
- "desc" : "Sets the data for the Grid\naccepts a Key => Value object of all the elements avaiable.",
- "sig" : "(data)",
- "static" : false,
+ "desc" : "Fires after the checked value has been set",
+ "sig" : "function (_self, checked)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "data",
- "type" : "Object",
- "desc" : "to appear in grid.",
+ "name" : "this",
+ "type" : "Roo.menu.CheckItem",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "checked",
+ "type" : "Boolean",
+ "desc" : "The checked value that was set",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "startEditing",
+ "name" : "click",
"type" : "function",
- "desc" : "Starts editing the specified for the specified row/column",
- "sig" : "(rowIndex, colIndex)",
- "static" : false,
- "memberOf" : "Roo.grid.EditorGrid",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when this item is clicked",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.menu.BaseItem",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "rowIndex",
- "type" : "Number",
+ "name" : "this",
+ "type" : "Roo.menu.BaseItem",
"desc" : "",
"isOptional" : false
},
{
- "name" : "colIndex",
- "type" : "Number",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "stopEditing",
+ "name" : "deactivate",
"type" : "function",
- "desc" : "Stops any active editing",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.grid.EditorGrid",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when this item is deactivated",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.menu.BaseItem",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.menu.BaseItem",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "un",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.grid.RowSelectionModel" : {
- "props" : [
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
},
{
- "name" : "singleSelect",
- "type" : "Boolean",
- "desc" : "True to allow selection of only one row at a time (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "afterselectionchange",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires after the selection changes (eg. by key press or clicking)",
+ "desc" : "Fires after the component is disabled.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "SelectionModel",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforerowselect",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires when a row is selected being selected, return false to cancel.",
- "sig" : "function (_self, rowIndex, keepExisting)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "SelectionModel",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "The selected index",
- "isOptional" : false
- },
- {
- "name" : "keepExisting",
- "type" : "Boolean",
- "desc" : "False if other selections will be cleared",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "rowdeselect",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires when a row is deselected.",
- "sig" : "function (_self, rowIndex)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "SelectionModel",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "The selected index",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "rowselect",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires when a row is selected.",
- "sig" : "function (_self, rowIndex, r)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "SelectionModel",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "The selected index",
- "isOptional" : false
- },
- {
- "name" : "r",
- "type" : "Roo.data.Record",
- "desc" : "The record",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "selectionchange",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires when the selection changes",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "SelectionModel",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "clearSelections",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Clears all selections.",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "deselectRange",
+ "name" : "disable",
"type" : "function",
- "desc" : "Deselects a range of rows. All rows in between startRow and endRow are also deselected.",
- "sig" : "(startRow, endRow)",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "startRow",
- "type" : "Number",
- "desc" : "The index of the first row in the range",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "endRow",
- "type" : "Number",
- "desc" : "The index of the last row in the range",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "deselectRow",
+ "name" : "enable",
"type" : "function",
- "desc" : "Deselects a row.",
- "sig" : "(row)",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "row",
- "type" : "Number",
- "desc" : "The index of the row to deselect",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
"name" : "fireEvent",
]
},
{
- "name" : "getCount",
+ "name" : "focus",
"type" : "function",
- "desc" : "Gets the number of selected rows.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : ""
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getSelected",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns the first selected record.",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Record",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "getSelections",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns the selected records",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Array",
- "desc" : "Array of selected records"
+ "type" : "String",
+ "desc" : ""
}
]
},
]
},
{
- "name" : "hasSelection",
- "type" : "function",
- "desc" : "Returns True if there is a selection.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "isIdSelected",
- "type" : "function",
- "desc" : "Returns True if the specified record id is selected.",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The id of record to check",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "isLocked",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns true if the selections are locked.",
+ "desc" : "Hide this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.grid.AbstractSelectionModel",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "isSelected",
- "type" : "function",
- "desc" : "Returns True if the specified row is selected.",
- "sig" : "(record)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "record",
- "type" : "Number/Record",
- "desc" : "The record or index of the record to check",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "lock",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Locks the selections.",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.grid.AbstractSelectionModel",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "selectAll",
- "type" : "function",
- "desc" : "Selects all rows.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "selectFirstRow",
- "type" : "function",
- "desc" : "Selects the first row in the grid.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "selectLastRow",
+ "name" : "render",
"type" : "function",
- "desc" : "Select the last row.",
- "sig" : "(keepExisting)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "keepExisting",
- "type" : "Boolean",
- "desc" : "(optional) True to keep existing selections",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "selectNext",
+ "name" : "setChecked",
"type" : "function",
- "desc" : "Selects the row immediately following the last selected row.",
- "sig" : "(keepExisting)",
+ "desc" : "Set the checked state of this item",
+ "sig" : "(checked, suppressEvent)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "keepExisting",
+ "name" : "checked",
"type" : "Boolean",
- "desc" : "(optional) True to keep existing selections",
+ "desc" : "The new checked value",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "selectPrevious",
- "type" : "function",
- "desc" : "Selects the row that precedes the last selected row.",
- "sig" : "(keepExisting)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "keepExisting",
+ "name" : "suppressEvent",
"type" : "Boolean",
- "desc" : "(optional) True to keep existing selections",
+ "desc" : "(optional) True to prevent the checkchange event from firing (defaults to false)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "selectRange",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Selects a range of rows. All rows in between startRow and endRow are also selected.",
- "sig" : "(startRow, endRow, keepExisting)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "startRow",
- "type" : "Number",
- "desc" : "The index of the first row in the range",
- "isOptional" : false
- },
- {
- "name" : "endRow",
- "type" : "Number",
- "desc" : "The index of the last row in the range",
- "isOptional" : false
- },
- {
- "name" : "keepExisting",
+ "name" : "disabled",
"type" : "Boolean",
- "desc" : "(optional) True to retain existing selections",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "selectRecords",
+ "name" : "setText",
"type" : "function",
- "desc" : "Select records.",
- "sig" : "(records, keepExisting)",
+ "desc" : "Sets the text to display in this menu item",
+ "sig" : "(text, isHTML)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.menu.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "records",
- "type" : "Array",
- "desc" : "The records to select",
+ "name" : "text",
+ "type" : "String",
+ "desc" : "The text to display",
"isOptional" : false
},
{
- "name" : "keepExisting",
+ "name" : "isHTML",
"type" : "Boolean",
- "desc" : "(optional) True to keep existing selections",
+ "desc" : "true to indicate text is pure html.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "selectRow",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Selects a row.",
- "sig" : "(row, keepExisting)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "row",
- "type" : "Number",
- "desc" : "The index of the row to select",
- "isOptional" : false
- },
- {
- "name" : "keepExisting",
+ "name" : "visible",
"type" : "Boolean",
- "desc" : "(optional) True to keep existing selections",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "selectRows",
+ "name" : "show",
"type" : "function",
- "desc" : "Selects multiple rows.",
- "sig" : "(rows, keepExisting)",
+ "desc" : "Show this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "rows",
- "type" : "Array",
- "desc" : "Array of the indexes of the row to select",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "keepExisting",
- "type" : "Boolean",
- "desc" : "(optional) True to keep existing selections",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
"name" : "un",
}
],
"returns" : []
- },
- {
- "name" : "unlock",
- "type" : "function",
- "desc" : "Unlocks the selections.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.grid.AbstractSelectionModel",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.grid.SplitDragZone" : {
+ "Roo.menu.ColorItem" : {
"props" : [
+ {
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "activeClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")",
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "canActivate",
+ "type" : "Boolean",
+ "desc" : "True if this item can be visually activated (defaults to false)",
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "True to prevent creation of this menu item (defaults to false)",
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideDelay",
+ "type" : "Number",
+ "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "hideOnClick",
+ "type" : "Boolean",
+ "desc" : "True to hide the containing menu after this item is clicked (defaults to true)",
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
- "events" : [],
- "methods" : [
+ "events" : [
{
- "name" : "addEvents",
+ "name" : "activate",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when this item is activated",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.menu.BaseItem",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "this",
+ "type" : "Roo.menu.BaseItem",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addInvalidHandleClass",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Lets you specify a css class of elements that will not initiate a drag",
- "sig" : "(cssClass)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the elements you wish to ignore",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addInvalidHandleId",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "string",
- "desc" : "the element id of the element you wish to ignore",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addInvalidHandleType",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
- "sig" : "(tagName)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to exclude",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "Fires when this item is clicked",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.menu.BaseItem",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "this",
+ "type" : "Roo.menu.BaseItem",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "deactivate",
+ "type" : "function",
+ "desc" : "Fires when this item is deactivated",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.menu.BaseItem",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "this",
+ "type" : "Roo.menu.BaseItem",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addToGroup",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
- "sig" : "(sGroup)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "sGroup",
- "type" : "",
- "desc" : "{string} the name of the group",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "alignElWithMouse",
+ "name" : "disable",
"type" : "function",
- "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
- "sig" : "(el, iPageX, iPageY)",
- "static" : false,
- "memberOf" : "Roo.dd.DD",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "HTMLElement",
- "desc" : "the element to move",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the mousedown or drag event",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the mousedown or drag event",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "applyConfig",
+ "name" : "show",
"type" : "function",
- "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "autoOffset",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked",
- "sig" : "(iPageX, iPageY)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the click",
- "isOptional" : false
- },
- {
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the click",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "cachePosition",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.",
- "sig" : "(iPageX, iPageY)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iPageX",
- "type" : "",
- "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "iPageY",
- "type" : "",
- "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "clearConstraints",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "clearTicks",
+ "name" : "disable",
"type" : "function",
- "desc" : "Clears any tick interval defined for this instance",
+ "desc" : "Disable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "createFrame",
+ "name" : "enable",
"type" : "function",
- "desc" : "Creates the proxy element if it does not yet exist",
+ "desc" : "Enable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DDProxy",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "endDrag",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Fired when we are done dragging the object",
- "sig" : "(e)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "fireEvent",
+ "name" : "focus",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getDragEl",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "HTMLElement",
- "desc" : "the html element"
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "getEl",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns a reference to the linked element",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "HTMLElement",
- "desc" : "the html element"
+ "type" : "String",
+ "desc" : ""
}
]
},
]
},
{
- "name" : "init",
+ "name" : "hide",
"type" : "function",
- "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
- "sig" : "(id, sGroup, config)",
+ "desc" : "Hide this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "on",
+ "type" : "function",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "the id of the linked element",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "sGroup",
- "type" : "String",
- "desc" : "the group of related items",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "config",
- "type" : "object",
- "desc" : "configuration attributes",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "initFrame",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DDProxy",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "initTarget",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
- "sig" : "(id, sGroup, config)",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "the id of the linked element",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "sGroup",
- "type" : "String",
- "desc" : "the group of related items",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "config",
- "type" : "object",
- "desc" : "configuration attributes",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "isLocked",
+ "name" : "render",
"type" : "function",
- "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
- "sig" : "()\n{\n\n}",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "boolean",
- "desc" : "true if this obj or all drag/drop is locked, else\nfalse"
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "isTarget",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "isValidHandleChild",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Checks the tag exclusion list to see if this click should be ignored",
- "sig" : "(node)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "HTMLElement",
- "desc" : "the HTMLElement to evaluate",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "boolean",
- "desc" : "true if this is a valid tag type, false if not"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "lock",
+ "name" : "show",
"type" : "function",
- "desc" : "Lock this instance",
+ "desc" : "Show this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "on",
+ "name" : "un",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.menu.ColorMenu" : {
+ "props" : [
+ {
+ "name" : "allowOtherMenus",
+ "type" : "Boolean",
+ "desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)",
+ "memberOf" : "Roo.menu.Menu",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "defaultAlign",
+ "type" : "String",
+ "desc" : "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")",
+ "memberOf" : "Roo.menu.Menu",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minWidth",
+ "type" : "Number",
+ "desc" : "The minimum width of the menu in pixels (defaults to 120)",
+ "memberOf" : "Roo.menu.Menu",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "registerMenu",
+ "type" : "Boolean",
+ "desc" : "True (default) - means that clicking on screen etc. hides it.",
+ "memberOf" : "Roo.menu.Menu",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "shadow",
+ "type" : "Boolean/String",
+ "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")",
+ "memberOf" : "Roo.menu.Menu",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "subMenuAlign",
+ "type" : "String",
+ "desc" : "The {@link Roo.Element#alignTo} anchor position value to use for submenus of\nthis menu (defaults to \"tl-tr?\")",
+ "memberOf" : "Roo.menu.Menu",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforehide",
+ "type" : "function",
+ "desc" : "Fires before this menu is hidden",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.menu.Menu",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "this",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onAvailable",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before this menu is displayed",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.menu.Menu",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "onDrag",
+ "name" : "click",
"type" : "function",
- "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)",
+ "sig" : "function (_self, menuItem, e)\n{\n\n}",
+ "memberOf" : "Roo.menu.Menu",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "menuItem",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was clicked",
+ "isOptional" : false
+ },
{
"name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onDragDrop",
+ "name" : "hide",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
- "sig" : "(e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after this menu is hidden",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.menu.Menu",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "this",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "itemclick",
+ "type" : "function",
+ "desc" : "Fires when a menu item contained in this menu is clicked",
+ "sig" : "function (baseItem, e)\n{\n\n}",
+ "memberOf" : "Roo.menu.Menu",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "baseItem",
+ "type" : "Roo.menu.BaseItem",
+ "desc" : "The BaseItem that was clicked",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onDragEnter",
+ "name" : "mouseout",
"type" : "function",
- "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
- "sig" : "(e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the mouse exits this menu",
+ "sig" : "function (_self, e, menuItem)\n{\n\n}",
+ "memberOf" : "Roo.menu.Menu",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
+ "isOptional" : false
+ },
{
"name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.",
+ "name" : "menuItem",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was clicked",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onDragOut",
+ "name" : "mouseover",
"type" : "function",
- "desc" : "Abstract method called when we are no longer hovering over an element",
- "sig" : "(e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the mouse is hovering over this menu",
+ "sig" : "function (_self, e, menuItem)\n{\n\n}",
+ "memberOf" : "Roo.menu.Menu",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
+ "isOptional" : false
+ },
{
"name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.",
+ "name" : "menuItem",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was clicked",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onDragOver",
+ "name" : "select",
"type" : "function",
- "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
- "sig" : "(e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "",
+ "sig" : "function (palette, color)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
+ "name" : "palette",
+ "type" : "ColorPalette",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.",
+ "name" : "color",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onInvalidDrop",
+ "name" : "show",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
- "sig" : "(e)",
+ "desc" : "Fires after this menu is displayed",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.menu.Menu",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "add",
+ "type" : "function",
+ "desc" : "Addds one or more items of any type supported by the Menu class, or that can be converted into menu items.\nAny of the following are valid:\n<ul>\n<li>Any menu item object based on {@link Roo.menu.Item}</li>\n<li>An HTMLElement object which will be converted to a menu item</li>\n<li>A menu item config object that will be created as a new menu item</li>\n<li>A string, which can either be '-' or 'separator' to add a menu separator, otherwise\nit will be converted into a {@link Roo.menu.TextItem} and added</li>\n</ul>\nUsage:\n<pre><code>\n// Create the menu\nvar menu = new Roo.menu.Menu();\n\n// Create a menu item to add by reference\nvar menuItem = new Roo.menu.Item({ text: 'New Item!' });\n\n// Add a bunch of items at once using different methods.\n// Only the last item added will be returned.\nvar item = menu.add(\n menuItem, // add existing item by ref\n 'Dynamic Item', // new TextItem\n '-', // new separator\n { text: 'Config Item' } // new item by config\n);\n</code></pre>",
+ "sig" : "(args)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.menu.Menu",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "args",
+ "type" : "Mixed",
+ "desc" : "One or more menu items, menu item configs or other objects that can be converted to menu items",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was added, or the last one if multiple items were added"
+ }
+ ]
},
{
- "name" : "onMouseDown",
+ "name" : "addElement",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
- "sig" : "(e)",
+ "desc" : "Adds an {@link Roo.Element} object to the menu",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.menu.Menu",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousedown event",
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element or DOM node to add, or its id",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was added"
+ }
+ ]
},
{
- "name" : "onMouseUp",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
- "sig" : "(e)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "padding",
+ "name" : "addItem",
"type" : "function",
- "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu",
+ "sig" : "(item)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.menu.Menu",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "item",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item to add",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was added"
+ }
+ ]
},
{
- "name" : "purgeListeners",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "addMenuItem",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu",
+ "sig" : "(config)",
+ "static" : false,
+ "memberOf" : "Roo.menu.Menu",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "A MenuItem config object",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was added"
+ }
+ ]
},
{
- "name" : "removeFromGroup",
+ "name" : "addSeparator",
"type" : "function",
- "desc" : "Remove's this instance from the supplied interaction group",
- "sig" : "(sGroup)",
+ "desc" : "Adds a separator bar to the menu",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.menu.Menu",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "sGroup",
- "type" : "string",
- "desc" : "The group to drop",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was added"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "removeInvalidHandleClass",
+ "name" : "addText",
"type" : "function",
- "desc" : "Unsets an invalid css class",
- "sig" : "(cssClass)",
+ "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu",
+ "sig" : "(text)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.menu.Menu",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the element(s) you wish to\nre-enable",
+ "name" : "text",
+ "type" : "String",
+ "desc" : "The text to display in the menu item",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was added"
+ }
+ ]
},
{
- "name" : "removeInvalidHandleId",
+ "name" : "capture",
"type" : "function",
- "desc" : "Unsets an invalid handle id",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "string",
- "desc" : "the id of the element to re-enable",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeInvalidHandleType",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
- "sig" : "(tagName)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to unexclude",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "removeListener",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Returns this menu's underlying {@link Roo.Element} object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.menu.Menu",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "The element"
+ }
+ ]
+ },
+ {
+ "name" : "hasListener",
+ "type" : "function",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "resetConstraints",
+ "name" : "hide",
"type" : "function",
- "desc" : "resetConstraints must be called if you manually reposition a dd element.",
- "sig" : "(maintainOffset)",
+ "desc" : "Hides this menu and optionally all parent menus",
+ "sig" : "(deep)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.menu.Menu",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "maintainOffset",
- "type" : "boolean",
- "desc" : "",
+ "name" : "deep",
+ "type" : "Boolean",
+ "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDelta",
+ "name" : "insert",
"type" : "function",
- "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)",
- "sig" : "(iDeltaX, iDeltaY)",
+ "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index",
+ "sig" : "(index, item)",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "Roo.menu.Menu",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iDeltaX",
- "type" : "int",
- "desc" : "the distance from the left",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index in the menu's list of current items where the new item should be inserted",
"isOptional" : false
},
{
- "name" : "iDeltaY",
- "type" : "int",
- "desc" : "the distance from the top",
+ "name" : "item",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item to add",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was added"
+ }
+ ]
},
{
- "name" : "setDragElId",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
- "sig" : "(id)",
+ "desc" : "Read-only. Returns true if the menu is currently displayed, else false.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.menu.Menu",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "",
- "desc" : "{string} the id of the element that will be used to initiate the drag",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setDragElPos",
+ "name" : "on",
"type" : "function",
- "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
- "sig" : "(iPageX, iPageY)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the mousedown or drag event",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the mousedown or drag event",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setHandleElId",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
- "sig" : "(id)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "",
- "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setInitPosition",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Stores the initial placement of the linked element.",
- "sig" : "(diffX, diffY)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "diffX",
- "type" : "int",
- "desc" : "the X offset, default 0",
- "isOptional" : false
- },
- {
- "name" : "diffY",
- "type" : "int",
- "desc" : "the Y offset, default 0",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setOuterHandleElId",
+ "name" : "remove",
"type" : "function",
- "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
- "sig" : "(id)",
+ "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object",
+ "sig" : "(item)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.menu.Menu",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "the id of the element that will be used to initiate the drag",
+ "name" : "item",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item to remove",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setPadding",
+ "name" : "removeAll",
"type" : "function",
- "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
- "sig" : "(iTop, iRight, iBot, iLeft)",
+ "desc" : "Removes and destroys all items in the menu",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.menu.Menu",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "iTop",
- "type" : "int",
- "desc" : "Top pad",
- "isOptional" : false
- },
- {
- "name" : "iRight",
- "type" : "int",
- "desc" : "Right pad",
- "isOptional" : false
- },
- {
- "name" : "iBot",
- "type" : "int",
- "desc" : "Bot pad",
- "isOptional" : false
- },
- {
- "name" : "iLeft",
- "type" : "int",
- "desc" : "Left pad",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setXConstraint",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
- "sig" : "(iLeft, iRight, iTickSize)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iLeft",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the left",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "iRight",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the\nright",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setYConstraint",
+ "name" : "show",
"type" : "function",
- "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
- "sig" : "(iUp, iDown, iTickSize)",
+ "desc" : "Displays this menu relative to another element",
+ "sig" : "(element, position, parentMenu)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.menu.Menu",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iUp",
- "type" : "int",
- "desc" : "the number of pixels the element can move up",
+ "name" : "element",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element to align to",
"isOptional" : false
},
{
- "name" : "iDown",
- "type" : "int",
- "desc" : "the number of pixels the element can move down",
+ "name" : "position",
+ "type" : "String",
+ "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)",
"isOptional" : false
},
{
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
+ "name" : "parentMenu",
+ "type" : "Roo.menu.Menu",
+ "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "startDrag",
+ "name" : "showAt",
"type" : "function",
- "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
- "sig" : "(X, Y)",
+ "desc" : "Displays this menu at a specific xy position",
+ "sig" : "(xyPosition, parentMenu)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.menu.Menu",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "X",
- "type" : "int",
- "desc" : "click location",
+ "name" : "xyPosition",
+ "type" : "Array",
+ "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)",
"isOptional" : false
},
{
- "name" : "Y",
- "type" : "int",
- "desc" : "click location",
+ "name" : "parentMenu",
+ "type" : "Roo.menu.Menu",
+ "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "toString",
- "type" : "function",
- "desc" : "toString method",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "string",
- "desc" : "string representation of the dd obj"
- }
- ]
- },
{
"name" : "un",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "unlock",
- "type" : "function",
- "desc" : "Unlock this instace",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "unreg",
- "type" : "function",
- "desc" : "Remove all drag and drop hooks for this element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.htmleditor" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.htmleditor.Block" : {
+ "Roo.menu.DateItem" : {
"props" : [
{
- "name" : "Context",
- "type" : "Object",
- "desc" : "menu - see Roo.form.HtmlEditor.ToolbarContext",
- "memberOf" : "",
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "friendly_name",
+ "name" : "activeClass",
"type" : "String",
- "desc" : "the name that appears in the context bar about this block",
- "memberOf" : "",
+ "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")",
+ "memberOf" : "Roo.menu.BaseItem",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "node",
- "type" : "DomElement",
- "desc" : "The node to apply stuff to.",
- "memberOf" : "",
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "canActivate",
+ "type" : "Boolean",
+ "desc" : "True if this item can be visually activated (defaults to false)",
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "True to prevent creation of this menu item (defaults to false)",
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideDelay",
+ "type" : "Number",
+ "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "hideOnClick",
+ "type" : "Boolean",
+ "desc" : "True to hide the containing menu after this item is clicked (defaults to true)",
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
}
],
- "events" : [],
- "methods" : [
+ "events" : [
{
- "name" : "factory",
+ "name" : "activate",
"type" : "function",
- "desc" : "factory method to get the block from an element (using cache if necessary)",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when this item is activated",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.menu.BaseItem",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "the",
- "type" : "HtmlElement",
- "desc" : "dom element",
+ "name" : "this",
+ "type" : "Roo.menu.BaseItem",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "getVal",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "used by readEleemnt to extract data from a node\nmay need improving as it's pretty basic",
- "sig" : "(node, tag, attribute, style)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "DomElement",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "tag",
- "type" : "String",
- "desc" : "- tag to find, eg. IMG ?? might be better to use DomQuery ?",
- "isOptional" : false
- },
- {
- "name" : "attribute",
- "type" : "String",
- "desc" : "(use html - for contents, style for using next param as style, or false to return the node)",
- "isOptional" : false
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "the style property - eg. text-align",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "initAll",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "initalize all Elements from content that are 'blockable'",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "the",
- "type" : "",
- "desc" : "body element",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "readElement",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Read a node that has a 'data-block' property - and extract the values from it.",
- "sig" : "(node)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "DomElement",
- "desc" : "- the node",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "toHTML",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "convert to plain HTML for calling insertAtCursor..",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "toObject",
+ "name" : "click",
"type" : "function",
- "desc" : "create a DomHelper friendly object - for use with \nRoo.DomHelper.markup / overwrite / etc..\n(override this)",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when this item is clicked",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.menu.BaseItem",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.menu.BaseItem",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "updateElement",
+ "name" : "deactivate",
"type" : "function",
- "desc" : "Update a node with values from this object",
- "sig" : "(node)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when this item is deactivated",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.menu.BaseItem",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "DomElement",
+ "name" : "this",
+ "type" : "Roo.menu.BaseItem",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.htmleditor.BlockFigure" : {
- "props" : [
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) alignment for the block default le",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "left",
- "right"
- ]
- },
- {
- "name" : "caption",
- "type" : "String",
- "desc" : "the text to appear below (and in the alt tag)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "caption_display",
- "type" : "String",
- "desc" : "e) display or not the capti",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "block",
- "none"
- ]
- },
- {
- "name" : "image_height",
- "type" : "String|number",
- "desc" : "the height of the image number or %?",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "image_src",
- "type" : "String",
- "desc" : "the url for the image",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
},
{
- "name" : "image_width",
- "type" : "String|number",
- "desc" : "the width of the image number or %?",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
- {
- "name" : "toObject",
+ "name" : "destroy",
"type" : "function",
- "desc" : "create a DomHelper friendly object - for use with\nRoo.DomHelper.markup / overwrite / etc..",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.htmleditor.BlockTable" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "toObject",
+ "name" : "disable",
"type" : "function",
- "desc" : "create a DomHelper friendly object - for use with\nRoo.DomHelper.markup / overwrite / etc..\n?? should it be called with option to hide all editing features?",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.htmleditor.BlockTd" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "toObject",
+ "name" : "enable",
"type" : "function",
- "desc" : "create a DomHelper friendly object - for use with\nRoo.DomHelper.markup / overwrite / etc..\n?? should it be called with option to hide all editing features?",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.htmleditor.Filter" : {
- "props" : [
- {
- "name" : "node",
- "type" : "DomElement",
- "desc" : "The node to iterate and filter",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
},
{
- "name" : "tag",
- "type" : "boolean|String|Array",
- "desc" : "Tags to replace",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.htmleditor.FilterAttributes" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.htmleditor.FilterBlack" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.htmleditor.FilterBlock" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.htmleditor.FilterComment" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.htmleditor.FilterHashLink" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.htmleditor.FilterKeepChildren" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.htmleditor.FilterLongBr" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.htmleditor.FilterParagraph" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.htmleditor.FilterSpan" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.htmleditor.FilterStyleToTag" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.htmleditor.FilterTableWidth" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.htmleditor.FilterWord" : {
- "props" : [],
- "events" : [],
- "methods" : [
- {
- "name" : "replaceTag",
+ "name" : "hide",
"type" : "function",
- "desc" : "Clean up MS wordisms...",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.htmleditor.KeyEnter" : {
- "props" : [
- {
- "name" : "core",
- "type" : "Roo.HtmlEditorCore",
- "desc" : "the editor.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.htmleditor.TidyEntities" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "decode",
+ "name" : "render",
"type" : "function",
- "desc" : "Decodes the specified string, this will replace entities with raw UTF characters.",
- "sig" : "(text)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "text",
- "type" : "String",
- "desc" : "Text to entity decode.",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : "Entity decoded string."
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
- },
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
{
- "name" : "encodeAllRaw",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Encoded the specified text with both the attributes and text entities. This function will produce larger text contents\nsince it doesn't know if the context is within a attribute or text node. This was added for compatibility\nand is exposed as the DOMUtils.encode function.",
- "sig" : "(text)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "text",
- "type" : "String",
- "desc" : "Text to encode.",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "Entity encoded text."
- }
- ]
+ "returns" : []
},
{
- "name" : "encodeNamed",
- "type" : "function",
- "desc" : "Encodes the specified string using named entities. The core entities will be encoded\nas named ones but all non lower ascii characters will be encoded into named entities.",
- "sig" : "(text, attr, entities)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "text",
+ "name" : "eventName",
"type" : "String",
- "desc" : "Text to encode.",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "attr",
- "type" : "Boolean",
- "desc" : "Optional flag to specify if the text is attribute contents.",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "entities",
+ "name" : "scope",
"type" : "Object",
- "desc" : "Optional parameter with entities to use.",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "String",
- "desc" : "Entity encoded text."
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "encodeNumeric",
+ "name" : "capture",
"type" : "function",
- "desc" : "Encodes the specified string using numeric entities. The core entities will be\nencoded as named ones but all non lower ascii characters will be encoded into numeric entities.",
- "sig" : "(text, attr)",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
"static" : true,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "text",
- "type" : "String",
- "desc" : "Text to encode.",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "attr",
- "type" : "Boolean",
- "desc" : "Optional flag to specify if the text is attribute contents.",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "String",
- "desc" : "Entity encoded text."
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "encodeRaw",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Encodes the specified string using raw entities. This means only the required XML base entities will be encoded.",
- "sig" : "(text, attr)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "text",
- "type" : "String",
- "desc" : "Text to encode.",
- "isOptional" : false
- },
- {
- "name" : "attr",
- "type" : "Boolean",
- "desc" : "Optional flag to specify if the text is attribute contents.",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "Entity encoded text."
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "getEncodeFunc",
+ "name" : "disable",
"type" : "function",
- "desc" : "Returns an encode function based on the name(s) and it's optional entities.",
- "sig" : "(name, entities)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "name",
- "type" : "String",
- "desc" : "Comma separated list of encoders for example named,numeric.",
- "isOptional" : false
- },
- {
- "name" : "entities",
- "type" : "String",
- "desc" : "Optional parameter with entities to use instead of the built in set.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "function",
- "desc" : "Encode function to be used."
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "init",
+ "name" : "enable",
"type" : "function",
- "desc" : "initialize data..",
+ "desc" : "Enable this component.",
"sig" : "()\n{\n\n}",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.htmleditor.TidySerializer" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
{
- "name" : "inner",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "",
- "sig" : "(inner)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "inner",
- "type" : "boolean",
- "desc" : "do the inner of the node.",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "serialize",
+ "name" : "focus",
"type" : "function",
- "desc" : "Serializes the specified node into a string.",
- "sig" : "(node)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "example" : "new tinymce.html.Serializer().serialize(new tinymce.html.DomParser().parse('<p>text</p>'));",
+ "example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "DomElement",
- "desc" : "Node instance to serialize.",
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "String with HTML based on DOM tree."
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.htmleditor.TidyWriter" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "cdata",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Writes a cdata node such as <![CDATA[data]]>.",
- "sig" : "(text)",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "text",
- "type" : "String",
- "desc" : "String to write out inside the cdata.",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "comment",
+ "name" : "getId",
"type" : "function",
- "desc" : "Writes a comment node such as <!-- Comment -->.",
- "sig" : "(text)",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "text",
+ "name" : "",
"type" : "String",
- "desc" : "String to write out inside the comment.",
- "isOptional" : false
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "doctype",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Writes a doctype node such as <!DOCTYPE data>.",
- "sig" : "(text)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "text",
+ "name" : "eventName",
"type" : "String",
- "desc" : "String to write out inside the doctype.",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "end",
+ "name" : "hide",
"type" : "function",
- "desc" : "Writes the a end element such as </p>.",
- "sig" : "(name)",
+ "desc" : "Hide this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "name",
- "type" : "String",
- "desc" : "Name of the element.",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "getContent",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Returns the contents that got serialized.",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "HTML contents that got written down."
- }
- ]
+ "returns" : []
},
{
- "name" : "pi",
+ "name" : "on",
"type" : "function",
- "desc" : "Writes a PI node such as <?xml attr=\"value\" ?>.",
- "sig" : "(name, text)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "name",
+ "name" : "eventName",
"type" : "String",
- "desc" : "Name of the pi.",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "text",
- "type" : "String",
- "desc" : "String to write out inside the pi.",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "reset",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Resets the internal buffer if one wants to reuse the writer.",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "start",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Writes the a start element such as <p id=\"a\">.",
- "sig" : "(name, attrs, empty)",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "name",
+ "name" : "eventName",
"type" : "String",
- "desc" : "Name of the element.",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "attrs",
- "type" : "Array",
- "desc" : "Optional attribute array or undefined if it hasn't any.",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "empty",
- "type" : "Boolean",
- "desc" : "Optional empty state if the tag should end like <br />.",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "text",
+ "name" : "render",
"type" : "function",
- "desc" : "Writes a text node.\n\nIn pre - we should not mess with the contents.",
- "sig" : "(text, raw)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "text",
- "type" : "String",
- "desc" : "String to write out.",
- "isOptional" : false
- },
- {
- "name" : "raw",
- "type" : "Boolean",
- "desc" : "Optional raw state if true the contents wont get encoded.",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.lib" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.lib.Ajax" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "request",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "serializeForm",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "serialize a form",
- "sig" : "(form)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "form",
- "type" : "DomForm",
- "desc" : "element",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "urlencode form output."
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.lib.Color" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "getCSSHSL",
+ "name" : "show",
"type" : "function",
- "desc" : "getCSSHSL",
+ "desc" : "Show this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "a string representing this Color as a CSS HSL Color value - that\nis, a string of the form hsl(h,s%,l%) where h is in the range [0,100] and\ns and l are in the range [0,100]."
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getCSSHSLA",
+ "name" : "un",
"type" : "function",
- "desc" : "getCSSHSLA",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
+ "name" : "eventName",
"type" : "String",
- "desc" : "a string representing this Color as a CSS HSLA Color value - that\nis, a string of the form hsla(h,s%,l%,a) where h is in the range [0,100],\ns and l are in the range [0,100], and a is in the range [0,1]."
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.menu.DateMenu" : {
+ "props" : [
+ {
+ "name" : "allowOtherMenus",
+ "type" : "Boolean",
+ "desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)",
+ "memberOf" : "Roo.menu.Menu",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "getCSSHexadecimalRGB",
+ "name" : "defaultAlign",
+ "type" : "String",
+ "desc" : "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")",
+ "memberOf" : "Roo.menu.Menu",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minWidth",
+ "type" : "Number",
+ "desc" : "The minimum width of the menu in pixels (defaults to 120)",
+ "memberOf" : "Roo.menu.Menu",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "registerMenu",
+ "type" : "Boolean",
+ "desc" : "True (default) - means that clicking on screen etc. hides it.",
+ "memberOf" : "Roo.menu.Menu",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "shadow",
+ "type" : "Boolean/String",
+ "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")",
+ "memberOf" : "Roo.menu.Menu",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "subMenuAlign",
+ "type" : "String",
+ "desc" : "The {@link Roo.Element#alignTo} anchor position value to use for submenus of\nthis menu (defaults to \"tl-tr?\")",
+ "memberOf" : "Roo.menu.Menu",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforehide",
"type" : "function",
- "desc" : "getCSSHexadecimalRGB",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before this menu is hidden",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.menu.Menu",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : "a string representing this Color as a CSS hexadecimal RGB Color\nvalue - that is, a string of the form #RRGGBB where each of RR, GG, and BB\nare two-digit hexadecimal numbers."
+ "name" : "this",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getCSSIntegerRGB",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "getCSSIntegerRGB",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before this menu is displayed",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.menu.Menu",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : "a string representing this Color as a CSS integer RGB Color\nvalue - that is, a string of the form rgb(r,g,b) where each of r, g, and b\nare integers in the range [0,255]."
+ "name" : "this",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getCSSIntegerRGBA",
+ "name" : "click",
"type" : "function",
- "desc" : "getCSSIntegerRGBA",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)",
+ "sig" : "function (_self, menuItem, e)\n{\n\n}",
+ "memberOf" : "Roo.menu.Menu",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : "Returns a string representing this Color as a CSS integer RGBA Color\nvalue - that is, a string of the form rgba(r,g,b,a) where each of r, g, and\nb are integers in the range [0,255] and a is in the range [0,1]."
+ "name" : "this",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "menuItem",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was clicked",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getCSSPercentageRGB",
+ "name" : "hide",
"type" : "function",
- "desc" : "getCSSPercentageRGB",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after this menu is hidden",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.menu.Menu",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : "a string representing this Color as a CSS percentage RGB Color\nvalue - that is, a string of the form rgb(r%,g%,b%) where each of r, g, and\nb are in the range [0,100]."
+ "name" : "this",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getCSSPercentageRGBA",
+ "name" : "itemclick",
"type" : "function",
- "desc" : "getCSSPercentageRGBA",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a menu item contained in this menu is clicked",
+ "sig" : "function (baseItem, e)\n{\n\n}",
+ "memberOf" : "Roo.menu.Menu",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : "a string representing this Color as a CSS percentage RGBA Color\nvalue - that is, a string of the form rgba(r%,g%,b%,a) where each of r, g,\nand b are in the range [0,100] and a is in the range [0,1]."
+ "name" : "baseItem",
+ "type" : "Roo.menu.BaseItem",
+ "desc" : "The BaseItem that was clicked",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getHSL",
+ "name" : "mouseout",
"type" : "function",
- "desc" : "getHSL",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the mouse exits this menu",
+ "sig" : "function (_self, e, menuItem)\n{\n\n}",
+ "memberOf" : "Roo.menu.Menu",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Object",
- "desc" : "the HSL and alpha components of this Color as an object with h,\ns, l, and a properties. h is in the range [0,360), s and l are in the range\n[0,100], and a is in the range [0,1]."
+ "name" : "this",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "menuItem",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was clicked",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getHSV",
+ "name" : "mouseover",
"type" : "function",
- "desc" : "getHSV",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "desc" : "Fires when the mouse is hovering over this menu",
+ "sig" : "function (_self, e, menuItem)\n{\n\n}",
+ "memberOf" : "Roo.menu.Menu",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "menuItem",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was clicked",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "function (picker, date)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Object",
- "desc" : "the HSV and alpha components of this Color as an object with h,\ns, v, and a properties. h is in the range [0,360), s and v are in the range\n[0,100], and a is in the range [0,1]."
+ "name" : "picker",
+ "type" : "DatePicker",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "date",
+ "type" : "Date",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getIntegerRGB",
+ "name" : "show",
"type" : "function",
- "desc" : "getIntegerRGB",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires after this menu is displayed",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.menu.Menu",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "add",
+ "type" : "function",
+ "desc" : "Addds one or more items of any type supported by the Menu class, or that can be converted into menu items.\nAny of the following are valid:\n<ul>\n<li>Any menu item object based on {@link Roo.menu.Item}</li>\n<li>An HTMLElement object which will be converted to a menu item</li>\n<li>A menu item config object that will be created as a new menu item</li>\n<li>A string, which can either be '-' or 'separator' to add a menu separator, otherwise\nit will be converted into a {@link Roo.menu.TextItem} and added</li>\n</ul>\nUsage:\n<pre><code>\n// Create the menu\nvar menu = new Roo.menu.Menu();\n\n// Create a menu item to add by reference\nvar menuItem = new Roo.menu.Item({ text: 'New Item!' });\n\n// Add a bunch of items at once using different methods.\n// Only the last item added will be returned.\nvar item = menu.add(\n menuItem, // add existing item by ref\n 'Dynamic Item', // new TextItem\n '-', // new separator\n { text: 'Config Item' } // new item by config\n);\n</code></pre>",
+ "sig" : "(args)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.menu.Menu",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "args",
+ "type" : "Mixed",
+ "desc" : "One or more menu items, menu item configs or other objects that can be converted to menu items",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "an object representing the RGBA components of this Color. The red,\ngreen, and blue components are converted to integers in the range [0,255].\nThe alpha is a value in the range [0,1]."
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was added, or the last one if multiple items were added"
}
]
},
{
- "name" : "getPercentageRGB",
+ "name" : "addElement",
"type" : "function",
- "desc" : "getPercentageRGB",
- "sig" : "()\n{\n\n}",
+ "desc" : "Adds an {@link Roo.Element} object to the menu",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.menu.Menu",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element or DOM node to add, or its id",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "an object representing the RGBA components of this Color. The red,\ngreen, and blue components are converted to numbers in the range [0,100].\nThe alpha is a value in the range [0,1]."
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was added"
}
]
},
{
- "name" : "getRGB",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "getRGB",
- "sig" : "()\n{\n\n}",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
+ "name" : "object",
"type" : "Object",
- "desc" : "the RGB and alpha components of this Color as an object with r,\ng, b, and a properties. r, g, and b are in the range [0,255] and a is in\nthe range [0,1]."
+ "desc" : "The object with the events defined",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "setNodeBackgroundColor",
+ "name" : "addItem",
"type" : "function",
- "desc" : "Sets the background Color of the specified node to this Color. This\nfunctions sets the CSS 'background-color' property for the node. The\nparameter is:",
- "sig" : "(node)",
+ "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu",
+ "sig" : "(item)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.menu.Menu",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "DomElement",
- "desc" : "- the node whose background Color should be set",
+ "name" : "item",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item to add",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was added"
+ }
+ ]
},
{
- "name" : "setNodeColor",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Sets the Color of the specified node to this Color. This functions sets\nthe CSS 'color' property for the node. The parameter is:",
- "sig" : "(node)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "DomElement",
- "desc" : "- the node whose Color should be set",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.lib.HSLColor",
- "Roo.lib.HSVColor",
- "Roo.lib.RGBColor"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.lib.Dom" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
- "name" : "getDocumentHeight",
+ "name" : "addMenuItem",
"type" : "function",
- "desc" : "Get the Full Document height",
- "sig" : "()\n{\n\n}",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu",
+ "sig" : "(config)",
+ "static" : false,
+ "memberOf" : "Roo.menu.Menu",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "A MenuItem config object",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "The height"
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was added"
}
]
},
{
- "name" : "getDocumentWidth",
+ "name" : "addSeparator",
"type" : "function",
- "desc" : "Get the Full Document width",
+ "desc" : "Adds a separator bar to the menu",
"sig" : "()\n{\n\n}",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "static" : false,
+ "memberOf" : "Roo.menu.Menu",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "The width"
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was added"
}
]
},
{
- "name" : "getViewHeight",
+ "name" : "addText",
"type" : "function",
- "desc" : "Get the view height",
- "sig" : "(full)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu",
+ "sig" : "(text)",
+ "static" : false,
+ "memberOf" : "Roo.menu.Menu",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "full",
- "type" : "Boolean",
- "desc" : "True will get the full document, otherwise it's the view height",
+ "name" : "text",
+ "type" : "String",
+ "desc" : "The text to display in the menu item",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "The height"
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was added"
}
]
},
{
- "name" : "getViewWidth",
+ "name" : "capture",
"type" : "function",
- "desc" : "Get the view width",
- "sig" : "(full)",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
"static" : true,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "full",
- "type" : "Boolean",
- "desc" : "True will get the full document, otherwise it's the view width",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Number",
- "desc" : "The width"
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getViewportHeight",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Get the Window Viewport height",
- "sig" : "()\n{\n\n}",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Number",
- "desc" : "The height"
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "getViewportWidth",
- "type" : "function",
- "desc" : "Get the Window Viewport width",
- "sig" : "()\n{\n\n}",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ ],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "The width"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.lib.HSLColor" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "getCSSHSL",
+ "name" : "getEl",
"type" : "function",
- "desc" : "getCSSHSL",
+ "desc" : "Returns this menu's underlying {@link Roo.Element} object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.lib.Color",
+ "memberOf" : "Roo.menu.Menu",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "a string representing this Color as a CSS HSL Color value - that\nis, a string of the form hsl(h,s%,l%) where h is in the range [0,100] and\ns and l are in the range [0,100]."
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "getCSSHSLA",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "getCSSHSLA",
- "sig" : "()\n{\n\n}",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.lib.Color",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "a string representing this Color as a CSS HSLA Color value - that\nis, a string of the form hsla(h,s%,l%,a) where h is in the range [0,100],\ns and l are in the range [0,100], and a is in the range [0,1]."
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "getCSSHexadecimalRGB",
+ "name" : "hide",
"type" : "function",
- "desc" : "getCSSHexadecimalRGB",
- "sig" : "()\n{\n\n}",
+ "desc" : "Hides this menu and optionally all parent menus",
+ "sig" : "(deep)",
"static" : false,
- "memberOf" : "Roo.lib.Color",
+ "memberOf" : "Roo.menu.Menu",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : "a string representing this Color as a CSS hexadecimal RGB Color\nvalue - that is, a string of the form #RRGGBB where each of RR, GG, and BB\nare two-digit hexadecimal numbers."
+ "name" : "deep",
+ "type" : "Boolean",
+ "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getCSSIntegerRGB",
+ "name" : "insert",
"type" : "function",
- "desc" : "getCSSIntegerRGB",
- "sig" : "()\n{\n\n}",
+ "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index",
+ "sig" : "(index, item)",
"static" : false,
- "memberOf" : "Roo.lib.Color",
+ "memberOf" : "Roo.menu.Menu",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index in the menu's list of current items where the new item should be inserted",
+ "isOptional" : false
+ },
+ {
+ "name" : "item",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item to add",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "a string representing this Color as a CSS integer RGB Color\nvalue - that is, a string of the form rgb(r,g,b) where each of r, g, and b\nare integers in the range [0,255]."
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was added"
}
]
},
{
- "name" : "getCSSIntegerRGBA",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "getCSSIntegerRGBA",
+ "desc" : "Read-only. Returns true if the menu is currently displayed, else false.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.lib.Color",
+ "memberOf" : "Roo.menu.Menu",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "Returns a string representing this Color as a CSS integer RGBA Color\nvalue - that is, a string of the form rgba(r,g,b,a) where each of r, g, and\nb are integers in the range [0,255] and a is in the range [0,1]."
- }
- ]
+ "returns" : []
},
{
- "name" : "getCSSPercentageRGB",
+ "name" : "on",
"type" : "function",
- "desc" : "getCSSPercentageRGB",
- "sig" : "()\n{\n\n}",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.lib.Color",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
+ "name" : "eventName",
"type" : "String",
- "desc" : "a string representing this Color as a CSS percentage RGB Color\nvalue - that is, a string of the form rgb(r%,g%,b%) where each of r, g, and\nb are in the range [0,100]."
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getCSSPercentageRGBA",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "getCSSPercentageRGBA",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.lib.Color",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "a string representing this Color as a CSS percentage RGBA Color\nvalue - that is, a string of the form rgba(r%,g%,b%,a) where each of r, g,\nand b are in the range [0,100] and a is in the range [0,1]."
- }
- ]
+ "returns" : []
},
{
- "name" : "getHSL",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "getHSL",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.lib.Color",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Object",
- "desc" : "the HSL and alpha components of this Color as an object with h,\ns, l, and a properties. h is in the range [0,360), s and l are in the range\n[0,100], and a is in the range [0,1]."
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getHSV",
+ "name" : "remove",
"type" : "function",
- "desc" : "getHSV",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object",
+ "sig" : "(item)",
"static" : false,
- "memberOf" : "Roo.lib.Color",
+ "memberOf" : "Roo.menu.Menu",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Object",
- "desc" : "the HSV and alpha components of this Color as an object with h,\ns, v, and a properties. h is in the range [0,360), s and v are in the range\n[0,100], and a is in the range [0,1]."
+ "name" : "item",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item to remove",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getIntegerRGB",
+ "name" : "removeAll",
"type" : "function",
- "desc" : "getIntegerRGB",
+ "desc" : "Removes and destroys all items in the menu",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.lib.Color",
+ "memberOf" : "Roo.menu.Menu",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "an object representing the RGBA components of this Color. The red,\ngreen, and blue components are converted to integers in the range [0,255].\nThe alpha is a value in the range [0,1]."
- }
- ]
+ "returns" : []
},
{
- "name" : "getPercentageRGB",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "getPercentageRGB",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.lib.Color",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
"type" : "Object",
- "desc" : "an object representing the RGBA components of this Color. The red,\ngreen, and blue components are converted to numbers in the range [0,100].\nThe alpha is a value in the range [0,1]."
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getRGB",
+ "name" : "show",
"type" : "function",
- "desc" : "getRGB",
- "sig" : "()\n{\n\n}",
+ "desc" : "Displays this menu relative to another element",
+ "sig" : "(element, position, parentMenu)",
"static" : false,
- "memberOf" : "Roo.lib.Color",
+ "memberOf" : "Roo.menu.Menu",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Object",
- "desc" : "the RGB and alpha components of this Color as an object with r,\ng, b, and a properties. r, g, and b are in the range [0,255] and a is in\nthe range [0,1]."
+ "name" : "element",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element to align to",
+ "isOptional" : false
+ },
+ {
+ "name" : "position",
+ "type" : "String",
+ "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)",
+ "isOptional" : false
+ },
+ {
+ "name" : "parentMenu",
+ "type" : "Roo.menu.Menu",
+ "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "setNodeBackgroundColor",
+ "name" : "showAt",
"type" : "function",
- "desc" : "Sets the background Color of the specified node to this Color. This\nfunctions sets the CSS 'background-color' property for the node. The\nparameter is:",
- "sig" : "(node)",
+ "desc" : "Displays this menu at a specific xy position",
+ "sig" : "(xyPosition, parentMenu)",
"static" : false,
- "memberOf" : "Roo.lib.Color",
+ "memberOf" : "Roo.menu.Menu",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "DomElement",
- "desc" : "- the node whose background Color should be set",
+ "name" : "xyPosition",
+ "type" : "Array",
+ "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)",
+ "isOptional" : false
+ },
+ {
+ "name" : "parentMenu",
+ "type" : "Roo.menu.Menu",
+ "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setNodeColor",
+ "name" : "un",
"type" : "function",
- "desc" : "Sets the Color of the specified node to this Color. This functions sets\nthe CSS 'color' property for the node. The parameter is:",
- "sig" : "(node)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.lib.Color",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "DomElement",
- "desc" : "- the node whose Color should be set",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.lib.HSVColor" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ "Roo.menu.Item" : {
+ "props" : [
{
- "name" : "getCSSHSL",
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "activeClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")",
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "canActivate",
+ "type" : "Boolean",
+ "desc" : "True if this item can be visually activated (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "True to prevent creation of this menu item (defaults to false)",
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideDelay",
+ "type" : "Number",
+ "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "hideOnClick",
+ "type" : "Boolean",
+ "desc" : "True to hide the containing menu after this item is clicked (defaults to true)",
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "to render in menu\nThe text to show on the menu item (HTML version).",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "icon",
+ "type" : "String",
+ "desc" : "The path to an icon to display in this menu item (defaults to Roo.BLANK_IMAGE_URL)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "itemCls",
+ "type" : "String",
+ "desc" : "The default CSS class to use for menu items (defaults to \"x-menu-item\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "menu",
+ "type" : "Roo.menu.Menu",
+ "desc" : "A Sub menu",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "showDelay",
+ "type" : "Number",
+ "desc" : "Length of time in milliseconds to wait before showing this item (defaults to 200)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "The text to show on the menu item.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "activate",
"type" : "function",
- "desc" : "getCSSHSL",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.lib.Color",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when this item is activated",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.menu.BaseItem",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : "a string representing this Color as a CSS HSL Color value - that\nis, a string of the form hsl(h,s%,l%) where h is in the range [0,100] and\ns and l are in the range [0,100]."
+ "name" : "this",
+ "type" : "Roo.menu.BaseItem",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getCSSHSLA",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "getCSSHSLA",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.lib.Color",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : "a string representing this Color as a CSS HSLA Color value - that\nis, a string of the form hsla(h,s%,l%,a) where h is in the range [0,100],\ns and l are in the range [0,100], and a is in the range [0,1]."
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getCSSHexadecimalRGB",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "getCSSHexadecimalRGB",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.lib.Color",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : "a string representing this Color as a CSS hexadecimal RGB Color\nvalue - that is, a string of the form #RRGGBB where each of RR, GG, and BB\nare two-digit hexadecimal numbers."
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getCSSIntegerRGB",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "getCSSIntegerRGB",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.lib.Color",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : "a string representing this Color as a CSS integer RGB Color\nvalue - that is, a string of the form rgb(r,g,b) where each of r, g, and b\nare integers in the range [0,255]."
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getCSSIntegerRGBA",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "getCSSIntegerRGBA",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.lib.Color",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : "Returns a string representing this Color as a CSS integer RGBA Color\nvalue - that is, a string of the form rgba(r,g,b,a) where each of r, g, and\nb are integers in the range [0,255] and a is in the range [0,1]."
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getCSSPercentageRGB",
+ "name" : "click",
"type" : "function",
- "desc" : "getCSSPercentageRGB",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.lib.Color",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when this item is clicked",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.menu.BaseItem",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : "a string representing this Color as a CSS percentage RGB Color\nvalue - that is, a string of the form rgb(r%,g%,b%) where each of r, g, and\nb are in the range [0,100]."
+ "name" : "this",
+ "type" : "Roo.menu.BaseItem",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getCSSPercentageRGBA",
+ "name" : "deactivate",
"type" : "function",
- "desc" : "getCSSPercentageRGBA",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.lib.Color",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when this item is deactivated",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.menu.BaseItem",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : "a string representing this Color as a CSS percentage RGBA Color\nvalue - that is, a string of the form rgba(r%,g%,b%,a) where each of r, g,\nand b are in the range [0,100] and a is in the range [0,1]."
+ "name" : "this",
+ "type" : "Roo.menu.BaseItem",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getHSL",
+ "name" : "destroy",
"type" : "function",
- "desc" : "getHSL",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.lib.Color",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Object",
- "desc" : "the HSL and alpha components of this Color as an object with h,\ns, l, and a properties. h is in the range [0,360), s and l are in the range\n[0,100], and a is in the range [0,1]."
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getHSV",
+ "name" : "disable",
"type" : "function",
- "desc" : "getHSV",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.lib.Color",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Object",
- "desc" : "the HSV and alpha components of this Color as an object with h,\ns, v, and a properties. h is in the range [0,360), s and v are in the range\n[0,100], and a is in the range [0,1]."
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getIntegerRGB",
+ "name" : "enable",
"type" : "function",
- "desc" : "getIntegerRGB",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.lib.Color",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Object",
- "desc" : "an object representing the RGBA components of this Color. The red,\ngreen, and blue components are converted to integers in the range [0,255].\nThe alpha is a value in the range [0,1]."
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getPercentageRGB",
+ "name" : "hide",
"type" : "function",
- "desc" : "getPercentageRGB",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.lib.Color",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Object",
- "desc" : "an object representing the RGBA components of this Color. The red,\ngreen, and blue components are converted to numbers in the range [0,100].\nThe alpha is a value in the range [0,1]."
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getRGB",
+ "name" : "render",
"type" : "function",
- "desc" : "getRGB",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.lib.Color",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
+ "name" : "object",
"type" : "Object",
- "desc" : "the RGB and alpha components of this Color as an object with r,\ng, b, and a properties. r, g, and b are in the range [0,255] and a is in\nthe range [0,1]."
+ "desc" : "The object with the events defined",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "setNodeBackgroundColor",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Sets the background Color of the specified node to this Color. This\nfunctions sets the CSS 'background-color' property for the node. The\nparameter is:",
- "sig" : "(node)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.lib.Color",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "DomElement",
- "desc" : "- the node whose background Color should be set",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setNodeColor",
+ "name" : "capture",
"type" : "function",
- "desc" : "Sets the Color of the specified node to this Color. This functions sets\nthe CSS 'color' property for the node. The parameter is:",
- "sig" : "(node)",
- "static" : false,
- "memberOf" : "Roo.lib.Color",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "DomElement",
- "desc" : "- the node whose Color should be set",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.lib.RGBColor" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "getCSSHSL",
+ "name" : "destroy",
"type" : "function",
- "desc" : "getCSSHSL",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.lib.Color",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "a string representing this Color as a CSS HSL Color value - that\nis, a string of the form hsl(h,s%,l%) where h is in the range [0,100] and\ns and l are in the range [0,100]."
- }
- ]
+ "returns" : []
},
{
- "name" : "getCSSHSLA",
+ "name" : "disable",
"type" : "function",
- "desc" : "getCSSHSLA",
+ "desc" : "Disable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.lib.Color",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "a string representing this Color as a CSS HSLA Color value - that\nis, a string of the form hsla(h,s%,l%,a) where h is in the range [0,100],\ns and l are in the range [0,100], and a is in the range [0,1]."
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getCSSHexadecimalRGB",
+ "name" : "enable",
"type" : "function",
- "desc" : "getCSSHexadecimalRGB",
+ "desc" : "Enable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.lib.Color",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "a string representing this Color as a CSS hexadecimal RGB Color\nvalue - that is, a string of the form #RRGGBB where each of RR, GG, and BB\nare two-digit hexadecimal numbers."
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getCSSIntegerRGB",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "getCSSIntegerRGB",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.lib.Color",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "a string representing this Color as a CSS integer RGB Color\nvalue - that is, a string of the form rgb(r,g,b) where each of r, g, and b\nare integers in the range [0,255]."
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "getCSSIntegerRGBA",
+ "name" : "focus",
"type" : "function",
- "desc" : "getCSSIntegerRGBA",
- "sig" : "()\n{\n\n}",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.lib.Color",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "Returns a string representing this Color as a CSS integer RGBA Color\nvalue - that is, a string of the form rgba(r,g,b,a) where each of r, g, and\nb are integers in the range [0,255] and a is in the range [0,1]."
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getCSSPercentageRGB",
+ "name" : "getEl",
"type" : "function",
- "desc" : "getCSSPercentageRGB",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.lib.Color",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "a string representing this Color as a CSS percentage RGB Color\nvalue - that is, a string of the form rgb(r%,g%,b%) where each of r, g, and\nb are in the range [0,100]."
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "getCSSPercentageRGBA",
+ "name" : "getId",
"type" : "function",
- "desc" : "getCSSPercentageRGBA",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.lib.Color",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "String",
- "desc" : "a string representing this Color as a CSS percentage RGBA Color\nvalue - that is, a string of the form rgba(r%,g%,b%,a) where each of r, g,\nand b are in the range [0,100] and a is in the range [0,1]."
+ "desc" : ""
}
]
},
{
- "name" : "getHSL",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "getHSL",
- "sig" : "()\n{\n\n}",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.lib.Color",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "the HSL and alpha components of this Color as an object with h,\ns, l, and a properties. h is in the range [0,360), s and l are in the range\n[0,100], and a is in the range [0,1]."
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "getHSV",
+ "name" : "hide",
"type" : "function",
- "desc" : "getHSV",
+ "desc" : "Hide this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.lib.Color",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "the HSV and alpha components of this Color as an object with h,\ns, v, and a properties. h is in the range [0,360), s and v are in the range\n[0,100], and a is in the range [0,1]."
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getIntegerRGB",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "getIntegerRGB",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.lib.Color",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "an object representing the RGBA components of this Color. The red,\ngreen, and blue components are converted to integers in the range [0,255].\nThe alpha is a value in the range [0,1]."
- }
- ]
+ "returns" : []
},
{
- "name" : "getPercentageRGB",
+ "name" : "on",
"type" : "function",
- "desc" : "getPercentageRGB",
- "sig" : "()\n{\n\n}",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.lib.Color",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
"type" : "Object",
- "desc" : "an object representing the RGBA components of this Color. The red,\ngreen, and blue components are converted to numbers in the range [0,100].\nThe alpha is a value in the range [0,1]."
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getRGB",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "getRGB",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.lib.Color",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "the RGB and alpha components of this Color as an object with r,\ng, b, and a properties. r, g, and b are in the range [0,255] and a is in\nthe range [0,1]."
- }
- ]
+ "returns" : []
},
{
- "name" : "setNodeBackgroundColor",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Sets the background Color of the specified node to this Color. This\nfunctions sets the CSS 'background-color' property for the node. The\nparameter is:",
- "sig" : "(node)",
- "static" : false,
- "memberOf" : "Roo.lib.Color",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "DomElement",
- "desc" : "- the node whose background Color should be set",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setNodeColor",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Sets the Color of the specified node to this Color. This functions sets\nthe CSS 'color' property for the node. The parameter is:",
- "sig" : "(node)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.lib.Color",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "DomElement",
- "desc" : "- the node whose Color should be set",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.lib.Range" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "wrap",
+ "name" : "render",
"type" : "function",
- "desc" : "Wrap a Dom Range object, to give it new features...",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "the",
- "type" : "Range",
- "desc" : "range to wrap",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.lib.Selection" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "insertNode",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "insert node at selection",
- "sig" : "(node, cursor)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "DomElement|string",
+ "name" : "disabled",
+ "type" : "Boolean",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "cursor",
- "type" : "string",
- "desc" : "(after|in|none) where to place the cursor after inserting.",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "wrap",
+ "name" : "setText",
"type" : "function",
- "desc" : "Wrap a Dom Range object, to give it new features...",
- "sig" : "(the)",
- "static" : true,
+ "desc" : "Sets the text to display in this menu item",
+ "sig" : "(text, isHTML)",
+ "static" : false,
"memberOf" : "",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "the",
- "type" : "Range",
- "desc" : "range to wrap",
+ "name" : "text",
+ "type" : "String",
+ "desc" : "The text to display",
+ "isOptional" : false
+ },
+ {
+ "name" : "isHTML",
+ "type" : "Boolean",
+ "desc" : "true to indicate text is pure html.",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.lib.UndoManager" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "addEvent",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Manually add an event.\nNormall called without arguements - and it will just get added to the stack.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "reset",
+ "name" : "show",
"type" : "function",
- "desc" : "Reset the undo - probaly done on load to clear all history.",
+ "desc" : "Show this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "transact",
+ "name" : "un",
"type" : "function",
- "desc" : "To push and execute a transaction, the method undoManager.transact\nmust be called by passing a transaction object as the first argument, and a merge\nflag as the second argument. A transaction object has the following properties:\n\nUsage:\n<pre><code>\nundoManager.transact({\n label: 'Typing',\n execute: function() { ... },\n undo: function() { ... },\n // redo same as execute\n redo: function() { this.execute(); }\n}, false);\n\n// merge transaction\nundoManager.transact({\n label: 'Typing',\n execute: function() { ... }, // this will be run...\n undo: function() { ... }, // what to do when undo is run.\n // redo same as execute\n redo: function() { this.execute(); }\n}, true); \n</code></pre>",
- "sig" : "(transaction)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "transaction",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
"type" : "Object",
- "desc" : "The transaction to add to the stack.",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "The HTML fragment"
- }
- ]
+ "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.menu" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
+ "implementations" : [
+ "Roo.menu.CheckItem"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.menu.Adapter" : {
+ "Roo.menu.Menu" : {
"props" : [
{
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "activeClass",
- "type" : "String",
- "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")",
- "memberOf" : "Roo.menu.BaseItem",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "canActivate",
+ "name" : "allowOtherMenus",
"type" : "Boolean",
- "desc" : "True if this item can be visually activated (defaults to false)",
- "memberOf" : "Roo.menu.BaseItem",
+ "desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disableClass",
+ "name" : "defaultAlign",
"type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
- "memberOf" : "Roo.menu.BaseItem",
+ "desc" : "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "True to prevent creation of this menu item (defaults to false)",
- "memberOf" : "Roo.menu.BaseItem",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hideDelay",
+ "name" : "minWidth",
"type" : "Number",
- "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
- "memberOf" : "Roo.menu.BaseItem",
+ "desc" : "The minimum width of the menu in pixels (defaults to 120)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
- },
- {
- "name" : "hideOnClick",
+ "name" : "registerMenu",
"type" : "Boolean",
- "desc" : "True to hide the containing menu after this item is clicked (defaults to true)",
- "memberOf" : "Roo.menu.BaseItem",
+ "desc" : "True (default) - means that clicking on screen etc. hides it.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
+ "name" : "shadow",
+ "type" : "Boolean/String",
+ "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "style",
+ "name" : "subMenuAlign",
"type" : "String",
- "desc" : "css styles to add to component\neg. text-align:right;",
- "memberOf" : "Roo.Component",
+ "desc" : "The {@link Roo.Element#alignTo} anchor position value to use for submenus of\nthis menu (defaults to \"tl-tr?\")",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
{
- "name" : "activate",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Fires when this item is activated",
+ "desc" : "Fires before this menu is hidden",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.menu.BaseItem",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.BaseItem",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforedestroy",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "desc" : "Fires before this menu is displayed",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforehide",
+ "name" : "click",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)",
+ "sig" : "function (_self, menuItem, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "menuItem",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was clicked",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "desc" : "Fires after this menu is hidden",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "click",
+ "name" : "itemclick",
"type" : "function",
- "desc" : "Fires when this item is clicked",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.menu.BaseItem",
+ "desc" : "Fires when a menu item contained in this menu is clicked",
+ "sig" : "function (baseItem, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
+ "name" : "baseItem",
"type" : "Roo.menu.BaseItem",
- "desc" : "",
+ "desc" : "The BaseItem that was clicked",
"isOptional" : false
},
{
"returns" : []
},
{
- "name" : "deactivate",
+ "name" : "mouseout",
"type" : "function",
- "desc" : "Fires when this item is deactivated",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.menu.BaseItem",
+ "desc" : "Fires when the mouse exits this menu",
+ "sig" : "function (_self, e, menuItem)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.BaseItem",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "menuItem",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was clicked",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "mouseover",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when the mouse is hovering over this menu",
+ "sig" : "function (_self, e, menuItem)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "menuItem",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was clicked",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enable",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
+ "desc" : "Fires after this menu is displayed",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "hide",
+ "name" : "add",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Addds one or more items of any type supported by the Menu class, or that can be converted into menu items.\nAny of the following are valid:\n<ul>\n<li>Any menu item object based on {@link Roo.menu.Item}</li>\n<li>An HTMLElement object which will be converted to a menu item</li>\n<li>A menu item config object that will be created as a new menu item</li>\n<li>A string, which can either be '-' or 'separator' to add a menu separator, otherwise\nit will be converted into a {@link Roo.menu.TextItem} and added</li>\n</ul>\nUsage:\n<pre><code>\n// Create the menu\nvar menu = new Roo.menu.Menu();\n\n// Create a menu item to add by reference\nvar menuItem = new Roo.menu.Item({ text: 'New Item!' });\n\n// Add a bunch of items at once using different methods.\n// Only the last item added will be returned.\nvar item = menu.add(\n menuItem, // add existing item by ref\n 'Dynamic Item', // new TextItem\n '-', // new separator\n { text: 'Config Item' } // new item by config\n);\n</code></pre>",
+ "sig" : "(args)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "args",
+ "type" : "Mixed",
+ "desc" : "One or more menu items, menu item configs or other objects that can be converted to menu items",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was added, or the last one if multiple items were added"
+ }
+ ]
},
{
- "name" : "render",
+ "name" : "addElement",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Adds an {@link Roo.Element} object to the menu",
+ "sig" : "(el)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "el",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element or DOM node to add, or its id",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was added"
+ }
+ ]
},
{
- "name" : "show",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "addEvents",
+ "name" : "addItem",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu",
+ "sig" : "(item)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "item",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item to add",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was added"
+ }
+ ]
},
{
"name" : "addListener",
"returns" : []
},
{
- "name" : "capture",
+ "name" : "addMenuItem",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu",
+ "sig" : "(config)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
+ "name" : "config",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "desc" : "A MenuItem config object",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was added"
+ }
+ ]
},
{
- "name" : "destroy",
+ "name" : "addSeparator",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "desc" : "Adds a separator bar to the menu",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was added"
+ }
+ ]
},
{
- "name" : "disable",
+ "name" : "addText",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu",
+ "sig" : "(text)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "The text to display in the menu item",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was added"
}
]
},
{
- "name" : "enable",
+ "name" : "capture",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
"name" : "fireEvent",
}
]
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
{
"name" : "getEl",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Returns this menu's underlying {@link Roo.Element} object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
]
},
{
- "name" : "getId",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "hasListener",
+ "name" : "hide",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Hides this menu and optionally all parent menus",
+ "sig" : "(deep)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "deep",
+ "type" : "Boolean",
+ "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "hide",
+ "name" : "insert",
"type" : "function",
- "desc" : "Hide this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index",
+ "sig" : "(index, item)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index in the menu's list of current items where the new item should be inserted",
+ "isOptional" : false
+ },
+ {
+ "name" : "item",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item to add",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was added"
}
]
},
{
"name" : "isVisible",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
+ "desc" : "Read-only. Returns true if the menu is currently displayed, else false.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "remove",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object",
+ "sig" : "(item)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "item",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item to remove",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "removeAll",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Removes and destroys all items in the menu",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "show",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Displays this menu relative to another element",
+ "sig" : "(element, position, parentMenu)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "element",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element to align to",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "position",
+ "type" : "String",
+ "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)",
+ "isOptional" : false
+ },
+ {
+ "name" : "parentMenu",
+ "type" : "Roo.menu.Menu",
+ "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "show",
+ "name" : "showAt",
"type" : "function",
- "desc" : "Show this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Displays this menu at a specific xy position",
+ "sig" : "(xyPosition, parentMenu)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "xyPosition",
+ "type" : "Array",
+ "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)",
+ "isOptional" : false
+ },
+ {
+ "name" : "parentMenu",
+ "type" : "Roo.menu.Menu",
+ "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
"name" : "un",
"returns" : []
}
],
- "isAbstract" : true,
+ "isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [
- "Roo.menu.ColorItem",
- "Roo.menu.DateItem"
+ "Roo.menu.ColorMenu",
+ "Roo.menu.DateMenu"
],
+ "tree_children" : [
+ "Roo.menu.Item",
+ "Roo.menu.CheckItem",
+ "Roo.menu.Separator",
+ "Roo.menu.TextItem"
+ ],
+ "tree_parent" : []
+ },
+ "Roo.menu.MenuMgr" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "get",
+ "type" : "function",
+ "desc" : "Returns a {@link Roo.menu.Menu} object",
+ "sig" : "(menu)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "menu",
+ "type" : "String/Object",
+ "desc" : "The string menu id, an existing menu object reference, or a Menu config that will\nbe used to generate and return a new Menu instance.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hideAll",
+ "type" : "function",
+ "desc" : "Hides all menus that are currently visible",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.menu.BaseItem" : {
+ "Roo.menu.Separator" : {
"props" : [
{
"name" : "actionMode",
"name" : "activeClass",
"type" : "String",
"desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")",
- "memberOf" : "",
+ "memberOf" : "Roo.menu.BaseItem",
"isOptional" : false,
"optvals" : []
},
"name" : "canActivate",
"type" : "Boolean",
"desc" : "True if this item can be visually activated (defaults to false)",
- "memberOf" : "",
+ "memberOf" : "Roo.menu.BaseItem",
"isOptional" : false,
"optvals" : []
},
"name" : "handler",
"type" : "Function",
"desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
- "memberOf" : "",
+ "memberOf" : "Roo.menu.BaseItem",
"isOptional" : false,
"optvals" : []
},
"name" : "hidden",
"type" : "Boolean",
"desc" : "True to prevent creation of this menu item (defaults to false)",
- "memberOf" : "",
+ "memberOf" : "Roo.menu.BaseItem",
"isOptional" : false,
"optvals" : []
},
"name" : "hideDelay",
"type" : "Number",
"desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
- "memberOf" : "",
+ "memberOf" : "Roo.menu.BaseItem",
"isOptional" : false,
"optvals" : []
},
{
"name" : "hideOnClick",
"type" : "Boolean",
- "desc" : "True to hide the containing menu after this item is clicked (defaults to true)",
+ "desc" : "True to hide the containing menu after this item is clicked (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "itemCls",
+ "type" : "String",
+ "desc" : "The default CSS class to use for separators (defaults to \"x-menu-sep\")",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"type" : "function",
"desc" : "Fires when this item is activated",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.menu.BaseItem",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when this item is clicked",
"sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.menu.BaseItem",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when this item is deactivated",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.menu.BaseItem",
"example" : "",
"deprecated" : "",
"since" : "",
"returns" : []
}
],
- "isAbstract" : true,
+ "isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.menu.Adapter",
- "Roo.menu.CheckItem",
- "Roo.menu.ColorItem",
- "Roo.menu.DateItem",
- "Roo.menu.Item",
- "Roo.menu.Separator",
- "Roo.menu.TextItem"
- ],
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.menu.CheckItem" : {
+ "Roo.menu.TextItem" : {
"props" : [
{
"name" : "actionMode",
{
"name" : "canActivate",
"type" : "Boolean",
- "desc" : "True if this item can be visually activated (defaults to true)",
- "memberOf" : "Roo.menu.Item",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "checked",
- "type" : "Boolean",
- "desc" : "True to initialize this checkbox as checked (defaults to false). Note that\nif this checkbox is part of a radio group (group = true) only the last item in the group that is\ninitialized with checked = true will be rendered as checked.",
- "memberOf" : "",
+ "desc" : "True if this item can be visually activated (defaults to false)",
+ "memberOf" : "Roo.menu.BaseItem",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "group",
- "type" : "String",
- "desc" : "All check items with the same group name will automatically be grouped into a single-select\nradio button group (defaults to '')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "groupClass",
- "type" : "String",
- "desc" : "The default CSS class to use for radio group check items (defaults to \"x-menu-group-item\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "handler",
"type" : "Function",
{
"name" : "hideOnClick",
"type" : "Boolean",
- "desc" : "True to hide the containing menu after this item is clicked (defaults to true)",
- "memberOf" : "Roo.menu.BaseItem",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "html",
- "type" : "String",
- "desc" : "to render in menu\nThe text to show on the menu item (HTML version).",
- "memberOf" : "Roo.menu.Item",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "icon",
- "type" : "String",
- "desc" : "The path to an icon to display in this menu item (defaults to Roo.BLANK_IMAGE_URL)",
- "memberOf" : "Roo.menu.Item",
+ "desc" : "True to hide the containing menu after this item is clicked (defaults to false)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
"name" : "itemCls",
"type" : "String",
- "desc" : "The default CSS class to use for check items (defaults to \"x-menu-item x-menu-check-item\")",
+ "desc" : "The default CSS class to use for text items (defaults to \"x-menu-text\")",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "menu",
- "type" : "Roo.menu.Menu",
- "desc" : "A Sub menu",
- "memberOf" : "Roo.menu.Item",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "showDelay",
- "type" : "Number",
- "desc" : "Length of time in milliseconds to wait before showing this item (defaults to 200)",
- "memberOf" : "Roo.menu.Item",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "style",
"type" : "String",
{
"name" : "text",
"type" : "String",
- "desc" : "The text to show on the menu item.",
- "memberOf" : "Roo.menu.Item",
+ "desc" : "Text to show on item.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
}
],
"returns" : []
},
- {
- "name" : "beforecheckchange",
- "type" : "function",
- "desc" : "Fires before the checked value is set, providing an opportunity to cancel if needed",
- "sig" : "function (_self, checked)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.CheckItem",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "checked",
- "type" : "Boolean",
- "desc" : "The new checked value that will be set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "checkchange",
- "type" : "function",
- "desc" : "Fires after the checked value has been set",
- "sig" : "function (_self, checked)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.CheckItem",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "checked",
- "type" : "Boolean",
- "desc" : "The checked value that was set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "click",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setChecked",
- "type" : "function",
- "desc" : "Set the checked state of this item",
- "sig" : "(checked, suppressEvent)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "checked",
- "type" : "Boolean",
- "desc" : "The new checked value",
- "isOptional" : false
- },
- {
- "name" : "suppressEvent",
- "type" : "Boolean",
- "desc" : "(optional) True to prevent the checkchange event from firing (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setText",
- "type" : "function",
- "desc" : "Sets the text to display in this menu item",
- "sig" : "(text, isHTML)",
- "static" : false,
- "memberOf" : "Roo.menu.Item",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "text",
- "type" : "String",
- "desc" : "The text to display",
- "isOptional" : false
- },
- {
- "name" : "isHTML",
- "type" : "Boolean",
- "desc" : "true to indicate text is pure html.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisible",
"type" : "function",
"tree_children" : [],
"tree_parent" : []
},
- "Roo.menu.ColorItem" : {
+ "Roo.panel" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.panel.Calendar" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "activeClass",
- "type" : "String",
- "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")",
- "memberOf" : "Roo.menu.BaseItem",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "canActivate",
- "type" : "Boolean",
- "desc" : "True if this item can be visually activated (defaults to false)",
- "memberOf" : "Roo.menu.BaseItem",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "disableClass",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
- "memberOf" : "Roo.menu.BaseItem",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "True to prevent creation of this menu item (defaults to false)",
- "memberOf" : "Roo.menu.BaseItem",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideDelay",
- "type" : "Number",
- "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
- "memberOf" : "Roo.menu.BaseItem",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "hideMode",
"type" : "String",
"visibility"
]
},
- {
- "name" : "hideOnClick",
- "type" : "Boolean",
- "desc" : "True to hide the containing menu after this item is clicked (defaults to true)",
- "memberOf" : "Roo.menu.BaseItem",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
}
],
"events" : [
- {
- "name" : "activate",
- "type" : "function",
- "desc" : "Fires when this item is activated",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.menu.BaseItem",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.BaseItem",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "Fires when this item is clicked",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.menu.BaseItem",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.BaseItem",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "deactivate",
- "type" : "function",
- "desc" : "Fires when this item is deactivated",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.menu.BaseItem",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.BaseItem",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "eventclick",
+ "type" : "function",
+ "desc" : "Fires when the mouse click an",
+ "sig" : "function (_self, )\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Calendar",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "",
+ "type" : "event",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "evententer",
+ "type" : "function",
+ "desc" : "Fires when mouse over an event",
+ "sig" : "function (_self, Event)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Calendar",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "Event",
+ "type" : "event",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "eventleave",
+ "type" : "function",
+ "desc" : "Fires when the mouse leaves an",
+ "sig" : "function (_self, )\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Calendar",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "",
+ "type" : "event",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "monthchange",
+ "type" : "function",
+ "desc" : "Fires when the displayed month changes",
+ "sig" : "function (_self, date)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "DatePicker",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "date",
+ "type" : "Date",
+ "desc" : "The selected month",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "rendered",
+ "type" : "function",
+ "desc" : "Fires when the grid is rendered",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Calendar",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "Fires when a date is selected",
+ "sig" : "function (_self, date)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "DatePicker",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "date",
+ "type" : "Date",
+ "desc" : "The selected date",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
"tree_children" : [],
"tree_parent" : []
},
- "Roo.menu.ColorMenu" : {
+ "Roo.panel.Content" : {
"props" : [
{
- "name" : "allowOtherMenus",
+ "name" : "adjustments",
+ "type" : "Array",
+ "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoCreate",
+ "type" : "Boolean|Object",
+ "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoScroll",
"type" : "Boolean",
- "desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)",
- "memberOf" : "Roo.menu.Menu",
+ "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "defaultAlign",
+ "name" : "background",
+ "type" : "Boolean",
+ "desc" : "True if the panel should not be activated when it is added (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "closable",
+ "type" : "Boolean",
+ "desc" : "True if the panel can be closed/removed",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "content",
"type" : "String",
- "desc" : "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")",
- "memberOf" : "Roo.menu.Menu",
+ "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fitContainer",
+ "type" : "Boolean",
+ "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fitToFrame",
+ "type" : "Boolean",
+ "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "minWidth",
- "type" : "Number",
- "desc" : "The minimum width of the menu in pixels (defaults to 120)",
- "memberOf" : "Roo.menu.Menu",
+ "name" : "loadOnce",
+ "type" : "Boolean",
+ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "menu",
+ "type" : "Roo.menu.Menu",
+ "desc" : "popup menu",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "params",
+ "type" : "String|Object",
+ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "region",
+ "type" : "String",
+ "desc" : "t) which region to put this panel on (when used with xtype constructor",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "center",
+ "north",
+ "south",
+ "east",
+ "west"
+ ]
+ },
+ {
+ "name" : "resizeEl",
+ "type" : "String|HTMLElement|Element",
+ "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "Extra style to add to the content panel",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "registerMenu",
- "type" : "Boolean",
- "desc" : "True (default) - means that clicking on screen etc. hides it.",
- "memberOf" : "Roo.menu.Menu",
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title for this panel",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "shadow",
- "type" : "Boolean/String",
- "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")",
- "memberOf" : "Roo.menu.Menu",
+ "name" : "toolbar",
+ "type" : "Roo.Toolbar",
+ "desc" : "A toolbar for this panel",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "subMenuAlign",
+ "name" : "url",
"type" : "String",
- "desc" : "The {@link Roo.Element#alignTo} anchor position value to use for submenus of\nthis menu (defaults to \"tl-tr?\")",
- "memberOf" : "Roo.menu.Menu",
+ "desc" : "Calls {@link #setUrl} with this value",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
{
- "name" : "beforehide",
+ "name" : "activate",
"type" : "function",
- "desc" : "Fires before this menu is hidden",
+ "desc" : "Fires when this panel is activated.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.menu.Menu",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.Menu",
+ "type" : "Roo.panel.Content",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "deactivate",
"type" : "function",
- "desc" : "Fires before this menu is displayed",
+ "desc" : "Fires when this panel is activated.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.menu.Menu",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.Menu",
+ "type" : "Roo.panel.Content",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "click",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)",
- "sig" : "function (_self, menuItem, e)\n{\n\n}",
- "memberOf" : "Roo.menu.Menu",
+ "desc" : "Fires when this tab is created",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "menuItem",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was clicked",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.panel.Content",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "hide",
+ "name" : "resize",
"type" : "function",
- "desc" : "Fires after this menu is hidden",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.menu.Menu",
+ "desc" : "Fires when this panel is resized if fitToFrame is true.",
+ "sig" : "function (_self, width, height)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.Menu",
+ "type" : "Roo.panel.Content",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The width after any component adjustments",
+ "isOptional" : false
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The height after any component adjustments",
+ "isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "itemclick",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Fires when a menu item contained in this menu is clicked",
- "sig" : "function (baseItem, e)\n{\n\n}",
- "memberOf" : "Roo.menu.Menu",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "baseItem",
- "type" : "Roo.menu.BaseItem",
- "desc" : "The BaseItem that was clicked",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "mouseout",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Fires when the mouse exits this menu",
- "sig" : "function (_self, e, menuItem)\n{\n\n}",
- "memberOf" : "Roo.menu.Menu",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "menuItem",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was clicked",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "mouseover",
+ "name" : "addxtype",
"type" : "function",
- "desc" : "Fires when the mouse is hovering over this menu",
- "sig" : "function (_self, e, menuItem)\n{\n\n}",
- "memberOf" : "Roo.menu.Menu",
+ "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'Form',\n items: [ .... ]\n }\n);\n\n</code></pre>",
+ "sig" : "(cfg)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "menuItem",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was clicked",
+ "name" : "cfg",
+ "type" : "Object",
+ "desc" : "Xtype definition of item to add.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "select",
+ "name" : "capture",
"type" : "function",
- "desc" : "",
- "sig" : "function (palette, color)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "palette",
- "type" : "ColorPalette",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "color",
- "type" : "String",
- "desc" : "",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires after this menu is displayed",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.menu.Menu",
+ "desc" : "Destroys this panel",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "add",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Addds one or more items of any type supported by the Menu class, or that can be converted into menu items.\nAny of the following are valid:\n<ul>\n<li>Any menu item object based on {@link Roo.menu.Item}</li>\n<li>An HTMLElement object which will be converted to a menu item</li>\n<li>A menu item config object that will be created as a new menu item</li>\n<li>A string, which can either be '-' or 'separator' to add a menu separator, otherwise\nit will be converted into a {@link Roo.menu.TextItem} and added</li>\n</ul>\nUsage:\n<pre><code>\n// Create the menu\nvar menu = new Roo.menu.Menu();\n\n// Create a menu item to add by reference\nvar menuItem = new Roo.menu.Item({ text: 'New Item!' });\n\n// Add a bunch of items at once using different methods.\n// Only the last item added will be returned.\nvar item = menu.add(\n menuItem, // add existing item by ref\n 'Dynamic Item', // new TextItem\n '-', // new separator\n { text: 'Config Item' } // new item by config\n);\n</code></pre>",
- "sig" : "(args)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.menu.Menu",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
{
"name" : "args",
- "type" : "Mixed",
- "desc" : "One or more menu items, menu item configs or other objects that can be converted to menu items",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was added, or the last one if multiple items were added"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "addElement",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Adds an {@link Roo.Element} object to the menu",
- "sig" : "(el)",
+ "desc" : "Returns this panel's element - used by regiosn to add.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.menu.Menu",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The element or DOM node to add, or its id",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was added"
+ "type" : "Roo.Element",
+ "desc" : ""
}
]
},
{
- "name" : "addEvents",
+ "name" : "getId",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Returns this panel's id",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "addItem",
+ "name" : "getTitle",
"type" : "function",
- "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu",
- "sig" : "(item)",
+ "desc" : "Returns this panel's title",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.menu.Menu",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "item",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item to add",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
}
- ],
+ ]
+ },
+ {
+ "name" : "getToolbar",
+ "type" : "function",
+ "desc" : "Returns the toolbar for this Panel if one was configured.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was added"
+ "type" : "Roo.Toolbar",
+ "desc" : ""
}
]
},
{
- "name" : "addListener",
+ "name" : "getUpdateManager",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.UpdateManager",
+ "desc" : "The UpdateManager"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "addMenuItem",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu",
- "sig" : "(config)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.menu.Menu",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "config",
- "type" : "Object",
- "desc" : "A MenuItem config object",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was added"
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "addSeparator",
+ "name" : "isClosable",
"type" : "function",
- "desc" : "Adds a separator bar to the menu",
+ "desc" : "Returns true is this panel was configured to be closable",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.menu.Menu",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was added"
+ "type" : "Boolean",
+ "desc" : ""
}
]
},
{
- "name" : "addText",
+ "name" : "load",
"type" : "function",
- "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu",
- "sig" : "(text)",
+ "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.",
+ "sig" : "(url, params, callback, discardUrl)",
"static" : false,
- "memberOf" : "Roo.menu.Menu",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "text",
- "type" : "String",
- "desc" : "The text to display in the menu item",
+ "name" : "url",
+ "type" : "Object/String/Function",
+ "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\npanel.load({\n url: \"your-url.php\",\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n callback: yourFunction,\n scope: yourObject, //(optional scope)\n discardUrl: false,\n nocache: false,\n text: \"Loading...\",\n timeout: 30,\n scripts: false\n});\n</code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
+ "isOptional" : false
+ },
+ {
+ "name" : "discardUrl",
+ "type" : "Boolean",
+ "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was added"
+ "type" : "Roo.panel.Content",
+ "desc" : "this"
}
]
},
{
- "name" : "capture",
+ "name" : "on",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
"memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "fn",
+ "name" : "handler",
"type" : "Function",
- "desc" : "The function to call",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "getEl",
+ "name" : "refresh",
"type" : "function",
- "desc" : "Returns this menu's underlying {@link Roo.Element} object",
+ "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.menu.Menu",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The name of the event to check for",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hide",
+ "name" : "setContent",
"type" : "function",
- "desc" : "Hides this menu and optionally all parent menus",
- "sig" : "(deep)",
+ "desc" : "Updates this panel's element",
+ "sig" : "(content, loadScripts)",
"static" : false,
- "memberOf" : "Roo.menu.Menu",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "deep",
+ "name" : "content",
+ "type" : "String",
+ "desc" : "The new content",
+ "isOptional" : false
+ },
+ {
+ "name" : "loadScripts",
"type" : "Boolean",
- "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)",
+ "desc" : "(optional) true to look for and process scripts",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "insert",
+ "name" : "setTitle",
"type" : "function",
- "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index",
- "sig" : "(index, item)",
+ "desc" : "Set this panel's title",
+ "sig" : "(title)",
"static" : false,
- "memberOf" : "Roo.menu.Menu",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The index in the menu's list of current items where the new item should be inserted",
- "isOptional" : false
- },
- {
- "name" : "item",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item to add",
+ "name" : "title",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was added"
- }
- ]
+ "returns" : []
},
{
- "name" : "isVisible",
+ "name" : "setUrl",
"type" : "function",
- "desc" : "Read-only. Returns true if the menu is currently displayed, else false.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
+ "sig" : "(url, params, loadOnce)",
"static" : false,
- "memberOf" : "Roo.menu.Menu",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "url",
+ "type" : "String/Function",
+ "desc" : "The URL to load the content from or a function to call to get the URL",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
+ "isOptional" : false
+ },
+ {
+ "name" : "loadOnce",
+ "type" : "Boolean",
+ "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.UpdateManager",
+ "desc" : "The UpdateManager"
+ }
+ ]
},
{
- "name" : "on",
+ "name" : "un",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.panel.Grid",
+ "Roo.panel.NestedLayout",
+ "Roo.panel.Tree"
+ ],
+ "tree_children" : [
+ "Roo.form.Form",
+ "Roo.JsonView",
+ "Roo.View",
+ "Roo.JsonView"
+ ],
+ "tree_parent" : [
+ "Roo.layout.Border",
+ "Roo.LayoutDialog",
+ "builder"
+ ]
+ },
+ "Roo.panel.Cropbox" : {
+ "props" : [
+ {
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "buttons",
+ "type" : "Array",
+ "desc" : "default ['rotateLeft', 'pictureBtn', 'rotateRight']",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "emptyText",
+ "type" : "String",
+ "desc" : "show when image has been loaded",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "errorTimeout",
+ "type" : "Number",
+ "desc" : "default 3000",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "height (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "isDocument",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "e) default tr",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "loadingText",
+ "type" : "Boolean",
+ "desc" : "default 'Loading...'",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "method",
+ "type" : "String",
+ "desc" : "default POST",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minHeight",
+ "type" : "Number",
+ "desc" : "default 300",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minWidth",
+ "type" : "Number",
+ "desc" : "default 300",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "outputMaxWidth",
+ "type" : "Number",
+ "desc" : "default 1200",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "paramName",
+ "type" : "String",
+ "desc" : "default 'imageUpload'",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "rotateNotify",
+ "type" : "String",
+ "desc" : "show when image too small to rotate",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "url",
+ "type" : "String",
+ "desc" : "action url",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "width (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "windowSize",
+ "type" : "Number",
+ "desc" : "default 300",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "arrange",
+ "type" : "function",
+ "desc" : "Fire when arrange the file data",
+ "sig" : "function (_self, formData)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.panel.Cropbox",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "options",
+ "name" : "formData",
"type" : "Object",
- "desc" : "(optional)",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "beforeloadcanvas",
"type" : "function",
- "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object",
- "sig" : "(item)",
- "static" : false,
- "memberOf" : "Roo.menu.Menu",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fire before load the canvas",
+ "sig" : "function (_self, src)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.panel.Cropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "src",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforerender",
+ "type" : "function",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeselectfile",
+ "type" : "function",
+ "desc" : "Fire before select file",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.panel.Cropbox",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "crop",
+ "type" : "function",
+ "desc" : "Fire after initEvent",
+ "sig" : "function (_self, data)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "item",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item to remove",
+ "name" : "this",
+ "type" : "Roo.panel.Cropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeAll",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Removes and destroys all items in the menu",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.menu.Menu",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "disable",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "download",
"type" : "function",
- "desc" : "Displays this menu relative to another element",
- "sig" : "(element, position, parentMenu)",
- "static" : false,
- "memberOf" : "Roo.menu.Menu",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fire when download the image",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "element",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The element to align to",
- "isOptional" : false
- },
- {
- "name" : "position",
- "type" : "String",
- "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)",
- "isOptional" : false
- },
- {
- "name" : "parentMenu",
- "type" : "Roo.menu.Menu",
- "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
+ "name" : "this",
+ "type" : "Roo.panel.Cropbox",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "showAt",
+ "name" : "enable",
"type" : "function",
- "desc" : "Displays this menu at a specific xy position",
- "sig" : "(xyPosition, parentMenu)",
- "static" : false,
- "memberOf" : "Roo.menu.Menu",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "xyPosition",
- "type" : "Array",
- "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)",
- "isOptional" : false
- },
- {
- "name" : "parentMenu",
- "type" : "Roo.menu.Menu",
- "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "un",
+ "name" : "exception",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fire when get exception",
+ "sig" : "function (_self, xhr)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "this",
+ "type" : "Roo.panel.Cropbox",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "xhr",
+ "type" : "XMLHttpRequest",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.menu.DateItem" : {
- "props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "activeClass",
- "type" : "String",
- "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")",
- "memberOf" : "Roo.menu.BaseItem",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "canActivate",
- "type" : "Boolean",
- "desc" : "True if this item can be visually activated (defaults to false)",
- "memberOf" : "Roo.menu.BaseItem",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
- "memberOf" : "Roo.menu.BaseItem",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "True to prevent creation of this menu item (defaults to false)",
- "memberOf" : "Roo.menu.BaseItem",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideDelay",
- "type" : "Number",
- "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
- "memberOf" : "Roo.menu.BaseItem",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
- },
- {
- "name" : "hideOnClick",
- "type" : "Boolean",
- "desc" : "True to hide the containing menu after this item is clicked (defaults to true)",
- "memberOf" : "Roo.menu.BaseItem",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "css styles to add to component\neg. text-align:right;",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "activate",
+ "name" : "footerbuttonclick",
"type" : "function",
- "desc" : "Fires when this item is activated",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.menu.BaseItem",
+ "desc" : "Fire when footerbuttonclick",
+ "sig" : "function (_self, type)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.BaseItem",
+ "type" : "Roo.panel.Cropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "type",
+ "type" : "String",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforedestroy",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "beforehide",
+ "name" : "initial",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "desc" : "Fire after initEvent",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.panel.Cropbox",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "inspect",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fire when inspect the file",
+ "sig" : "function (_self, file)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.panel.Cropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "file",
+ "type" : "Object",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "loadcanvas",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fire after load the canvas",
+ "sig" : "function (, imgEl)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "",
+ "type" : "Roo.panel.Cropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "imgEl",
+ "type" : "Object",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "click",
+ "name" : "move",
"type" : "function",
- "desc" : "Fires when this item is clicked",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.menu.BaseItem",
+ "desc" : "Fires after the component is moved.",
+ "sig" : "function (_self, x, y)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.BaseItem",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "deactivate",
+ "name" : "prepare",
"type" : "function",
- "desc" : "Fires when this item is deactivated",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.menu.BaseItem",
+ "desc" : "Fire when preparing the file data",
+ "sig" : "function (_self, file)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.BaseItem",
+ "type" : "Roo.panel.Cropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "file",
+ "type" : "Object",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
+ "desc" : "Fires after the component is rendered.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "disable",
+ "name" : "resize",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
+ "desc" : "Fire when resize",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.panel.Cropbox",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "enable",
+ "name" : "rotate",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fire when rotate the image",
+ "sig" : "function (_self, pos)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.panel.Cropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "pos",
+ "type" : "String",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "hide",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "render",
+ "name" : "trash",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
+ "desc" : "Fire when trash image",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.panel.Cropbox",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "show",
+ "name" : "upload",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fire when xhr upload the file",
+ "sig" : "function (_self, data)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.panel.Cropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
"desc" : "",
"isOptional" : false
}
}
]
},
+ {
+ "name" : "getBox",
+ "type" : "function",
+ "desc" : "Gets the current box measurements of the component's underlying element.",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "getEl",
"type" : "function",
}
]
},
+ {
+ "name" : "getPosition",
+ "type" : "function",
+ "desc" : "Gets the current XY position of the component's underlying element.",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "The XY position of the element (e.g., [100, 200])"
+ }
+ ]
+ },
+ {
+ "name" : "getSize",
+ "type" : "function",
+ "desc" : "Gets the current size of the component's underlying element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
+ }
+ ]
+ },
{
"name" : "hasListener",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "onPosition",
+ "type" : "function",
+ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
+ "sig" : "(x, y)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "onResize",
+ "type" : "function",
+ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
+ "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "purgeListeners",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setPagePosition",
+ "type" : "function",
+ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
+ "sig" : "(x, y)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setPosition",
+ "type" : "function",
+ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
+ "sig" : "(left, top)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "left",
+ "type" : "Number",
+ "desc" : "The new left",
+ "isOptional" : false
+ },
+ {
+ "name" : "top",
+ "type" : "Number",
+ "desc" : "The new top",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setSize",
+ "type" : "function",
+ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
+ "sig" : "(width, height)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "width",
+ "type" : "Number/Object",
+ "desc" : "The new width to set, or a size object in the format {width, height}",
+ "isOptional" : false
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height to set (not required if a size object is passed as the first arg)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.BoxComponent",
+ "desc" : "this"
+ }
+ ]
+ },
{
"name" : "setVisible",
"type" : "function",
}
]
},
+ {
+ "name" : "syncSize",
+ "type" : "function",
+ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "un",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "updateBox",
+ "type" : "function",
+ "desc" : "Sets the current box measurements of the component's underlying element.",
+ "sig" : "(box)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "box",
+ "type" : "Object",
+ "desc" : "An object in the format {x, y, width, height}",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.menu.DateMenu" : {
+ "Roo.panel.Grid" : {
"props" : [
{
- "name" : "allowOtherMenus",
+ "name" : "adjustments",
+ "type" : "Array",
+ "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
+ "memberOf" : "Roo.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoCreate",
+ "type" : "Boolean|Object",
+ "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
+ "memberOf" : "Roo.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoScroll",
"type" : "Boolean",
- "desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)",
- "memberOf" : "Roo.menu.Menu",
+ "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "defaultAlign",
+ "name" : "background",
+ "type" : "Boolean",
+ "desc" : "True if the panel should not be activated when it is added (defaults to false)",
+ "memberOf" : "Roo.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "closable",
+ "type" : "Boolean",
+ "desc" : "True if the panel can be closed/removed",
+ "memberOf" : "Roo.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "content",
"type" : "String",
- "desc" : "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")",
- "memberOf" : "Roo.menu.Menu",
+ "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
+ "memberOf" : "Roo.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fitContainer",
+ "type" : "Boolean",
+ "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
+ "memberOf" : "Roo.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fitToFrame",
+ "type" : "Boolean",
+ "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
+ "memberOf" : "Roo.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "grid",
+ "type" : "Roo.grid.Grid",
+ "desc" : "The grid for this panel",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "minWidth",
- "type" : "Number",
- "desc" : "The minimum width of the menu in pixels (defaults to 120)",
- "memberOf" : "Roo.menu.Menu",
+ "name" : "loadOnce",
+ "type" : "Boolean",
+ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "registerMenu",
- "type" : "Boolean",
- "desc" : "True (default) - means that clicking on screen etc. hides it.",
- "memberOf" : "Roo.menu.Menu",
+ "name" : "menu",
+ "type" : "Roo.menu.Menu",
+ "desc" : "popup menu",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "shadow",
- "type" : "Boolean/String",
- "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")",
- "memberOf" : "Roo.menu.Menu",
+ "name" : "params",
+ "type" : "String|Object",
+ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "subMenuAlign",
+ "name" : "region",
"type" : "String",
- "desc" : "The {@link Roo.Element#alignTo} anchor position value to use for submenus of\nthis menu (defaults to \"tl-tr?\")",
- "memberOf" : "Roo.menu.Menu",
+ "desc" : "t) which region to put this panel on (when used with xtype constructor",
+ "memberOf" : "Roo.panel.Content",
+ "isOptional" : false,
+ "optvals" : [
+ "center",
+ "north",
+ "south",
+ "east",
+ "west"
+ ]
+ },
+ {
+ "name" : "resizeEl",
+ "type" : "String|HTMLElement|Element",
+ "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
- }
- ],
- "events" : [
+ },
{
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before this menu is hidden",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.menu.Menu",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "style",
+ "type" : "String",
+ "desc" : "Extra style to add to the content panel",
+ "memberOf" : "Roo.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before this menu is displayed",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.menu.Menu",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title for this panel",
+ "memberOf" : "Roo.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "click",
- "type" : "function",
- "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)",
- "sig" : "function (_self, menuItem, e)\n{\n\n}",
- "memberOf" : "Roo.menu.Menu",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "menuItem",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was clicked",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "toolbar",
+ "type" : "Roo.Toolbar",
+ "desc" : "A toolbar for this panel",
+ "memberOf" : "Roo.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "hide",
+ "name" : "url",
+ "type" : "String",
+ "desc" : "Calls {@link #setUrl} with this value",
+ "memberOf" : "Roo.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "activate",
"type" : "function",
- "desc" : "Fires after this menu is hidden",
+ "desc" : "Fires when this panel is activated.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.menu.Menu",
+ "memberOf" : "Roo.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.Menu",
+ "type" : "Roo.panel.Content",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "itemclick",
+ "name" : "deactivate",
"type" : "function",
- "desc" : "Fires when a menu item contained in this menu is clicked",
- "sig" : "function (baseItem, e)\n{\n\n}",
- "memberOf" : "Roo.menu.Menu",
+ "desc" : "Fires when this panel is activated.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "baseItem",
- "type" : "Roo.menu.BaseItem",
- "desc" : "The BaseItem that was clicked",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.panel.Content",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "mouseout",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires when the mouse exits this menu",
- "sig" : "function (_self, e, menuItem)\n{\n\n}",
- "memberOf" : "Roo.menu.Menu",
+ "desc" : "Fires when this tab is created",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.Menu",
+ "type" : "Roo.panel.Content",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "menuItem",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was clicked",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "mouseover",
+ "name" : "resize",
"type" : "function",
- "desc" : "Fires when the mouse is hovering over this menu",
- "sig" : "function (_self, e, menuItem)\n{\n\n}",
- "memberOf" : "Roo.menu.Menu",
+ "desc" : "Fires when this panel is resized if fitToFrame is true.",
+ "sig" : "function (_self, width, height)\n{\n\n}",
+ "memberOf" : "Roo.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.panel.Content",
"desc" : "",
"isOptional" : false
},
{
- "name" : "menuItem",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was clicked",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "select",
- "type" : "function",
- "desc" : "",
- "sig" : "function (picker, date)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "picker",
- "type" : "DatePicker",
- "desc" : "",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The width after any component adjustments",
"isOptional" : false
},
{
- "name" : "date",
- "type" : "Date",
- "desc" : "",
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The height after any component adjustments",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "show",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Fires after this menu is displayed",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.menu.Menu",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
+ {
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "add",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Addds one or more items of any type supported by the Menu class, or that can be converted into menu items.\nAny of the following are valid:\n<ul>\n<li>Any menu item object based on {@link Roo.menu.Item}</li>\n<li>An HTMLElement object which will be converted to a menu item</li>\n<li>A menu item config object that will be created as a new menu item</li>\n<li>A string, which can either be '-' or 'separator' to add a menu separator, otherwise\nit will be converted into a {@link Roo.menu.TextItem} and added</li>\n</ul>\nUsage:\n<pre><code>\n// Create the menu\nvar menu = new Roo.menu.Menu();\n\n// Create a menu item to add by reference\nvar menuItem = new Roo.menu.Item({ text: 'New Item!' });\n\n// Add a bunch of items at once using different methods.\n// Only the last item added will be returned.\nvar item = menu.add(\n menuItem, // add existing item by ref\n 'Dynamic Item', // new TextItem\n '-', // new separator\n { text: 'Config Item' } // new item by config\n);\n</code></pre>",
- "sig" : "(args)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.menu.Menu",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "args",
- "type" : "Mixed",
- "desc" : "One or more menu items, menu item configs or other objects that can be converted to menu items",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was added, or the last one if multiple items were added"
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "addElement",
+ "name" : "addxtype",
"type" : "function",
- "desc" : "Adds an {@link Roo.Element} object to the menu",
- "sig" : "(el)",
+ "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'Form',\n items: [ .... ]\n }\n);\n\n</code></pre>",
+ "sig" : "(cfg)",
"static" : false,
- "memberOf" : "Roo.menu.Menu",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The element or DOM node to add, or its id",
+ "name" : "cfg",
+ "type" : "Object",
+ "desc" : "Xtype definition of item to add.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was added"
- }
- ]
+ "returns" : []
},
{
- "name" : "addEvents",
+ "name" : "capture",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
"memberOf" : "Roo.util.Observable",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "object",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
"type" : "Object",
- "desc" : "The object with the events defined",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addItem",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu",
- "sig" : "(item)",
+ "desc" : "Destroys this panel",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.menu.Menu",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "item",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item to add",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was added"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "addListener",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "addMenuItem",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu",
- "sig" : "(config)",
+ "desc" : "Returns this panel's element - used by regiosn to add.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.menu.Menu",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "config",
- "type" : "Object",
- "desc" : "A MenuItem config object",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was added"
+ "type" : "Roo.Element",
+ "desc" : ""
}
]
},
{
- "name" : "addSeparator",
+ "name" : "getGrid",
"type" : "function",
- "desc" : "Adds a separator bar to the menu",
+ "desc" : "Returns the grid for this panel",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.menu.Menu",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was added"
+ "type" : "Roo.grid.Grid",
+ "desc" : ""
}
]
},
{
- "name" : "addText",
+ "name" : "getId",
"type" : "function",
- "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu",
- "sig" : "(text)",
+ "desc" : "Returns this panel's id",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.menu.Menu",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "text",
- "type" : "String",
- "desc" : "The text to display in the menu item",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was added"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "capture",
+ "name" : "getTitle",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Returns this panel's title",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.panel.Content",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "fireEvent",
+ "name" : "getToolbar",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Returns the toolbar for this Panel if one was configured.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "Roo.Toolbar",
+ "desc" : ""
}
]
},
{
- "name" : "getEl",
+ "name" : "getUpdateManager",
"type" : "function",
- "desc" : "Returns this menu's underlying {@link Roo.Element} object",
+ "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.menu.Menu",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "Roo.UpdateManager",
+ "desc" : "The UpdateManager"
}
]
},
]
},
{
- "name" : "hide",
+ "name" : "isClosable",
"type" : "function",
- "desc" : "Hides this menu and optionally all parent menus",
- "sig" : "(deep)",
+ "desc" : "Returns true is this panel was configured to be closable",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.menu.Menu",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "deep",
+ "name" : "",
"type" : "Boolean",
- "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)",
- "isOptional" : false
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "insert",
+ "name" : "load",
"type" : "function",
- "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index",
- "sig" : "(index, item)",
+ "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.",
+ "sig" : "(url, params, callback, discardUrl)",
"static" : false,
- "memberOf" : "Roo.menu.Menu",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The index in the menu's list of current items where the new item should be inserted",
+ "name" : "url",
+ "type" : "Object/String/Function",
+ "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\npanel.load({\n url: \"your-url.php\",\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n callback: yourFunction,\n scope: yourObject, //(optional scope)\n discardUrl: false,\n nocache: false,\n text: \"Loading...\",\n timeout: 30,\n scripts: false\n});\n</code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.",
"isOptional" : false
},
{
- "name" : "item",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item to add",
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
+ "isOptional" : false
+ },
+ {
+ "name" : "discardUrl",
+ "type" : "Boolean",
+ "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was added"
+ "type" : "Roo.panel.Content",
+ "desc" : "this"
}
]
},
- {
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Read-only. Returns true if the menu is currently displayed, else false.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.menu.Menu",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "refresh",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.panel.Content",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object",
- "sig" : "(item)",
- "static" : false,
- "memberOf" : "Roo.menu.Menu",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "item",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item to remove",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "removeAll",
- "type" : "function",
- "desc" : "Removes and destroys all items in the menu",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.menu.Menu",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "removeListener",
"type" : "function",
"returns" : []
},
{
- "name" : "show",
+ "name" : "setContent",
"type" : "function",
- "desc" : "Displays this menu relative to another element",
- "sig" : "(element, position, parentMenu)",
+ "desc" : "Updates this panel's element",
+ "sig" : "(content, loadScripts)",
"static" : false,
- "memberOf" : "Roo.menu.Menu",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "element",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The element to align to",
+ "name" : "content",
+ "type" : "String",
+ "desc" : "The new content",
"isOptional" : false
},
{
- "name" : "position",
- "type" : "String",
- "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)",
+ "name" : "loadScripts",
+ "type" : "Boolean",
+ "desc" : "(optional) true to look for and process scripts",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setTitle",
+ "type" : "function",
+ "desc" : "Set this panel's title",
+ "sig" : "(title)",
+ "static" : false,
+ "memberOf" : "Roo.panel.Content",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "parentMenu",
- "type" : "Roo.menu.Menu",
- "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
+ "name" : "title",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "showAt",
+ "name" : "setUrl",
"type" : "function",
- "desc" : "Displays this menu at a specific xy position",
- "sig" : "(xyPosition, parentMenu)",
+ "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
+ "sig" : "(url, params, loadOnce)",
"static" : false,
- "memberOf" : "Roo.menu.Menu",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "xyPosition",
- "type" : "Array",
- "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)",
+ "name" : "url",
+ "type" : "String/Function",
+ "desc" : "The URL to load the content from or a function to call to get the URL",
"isOptional" : false
},
{
- "name" : "parentMenu",
- "type" : "Roo.menu.Menu",
- "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
+ "isOptional" : false
+ },
+ {
+ "name" : "loadOnce",
+ "type" : "Boolean",
+ "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.UpdateManager",
+ "desc" : "The UpdateManager"
+ }
+ ]
},
{
"name" : "un",
"isBuilderTop" : false,
"implementations" : [],
"tree_children" : [],
- "tree_parent" : []
+ "tree_parent" : [
+ "Roo.layout.Border",
+ "Roo.LayoutDialog",
+ "builder"
+ ]
},
- "Roo.menu.Item" : {
+ "Roo.panel.NestedLayout" : {
"props" : [
{
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
+ "name" : "adjustments",
+ "type" : "Array",
+ "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "activeClass",
- "type" : "String",
- "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")",
- "memberOf" : "Roo.menu.BaseItem",
+ "name" : "autoCreate",
+ "type" : "Boolean|Object",
+ "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "allowDomMove",
+ "name" : "autoScroll",
"type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
+ "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "canActivate",
+ "name" : "background",
"type" : "Boolean",
- "desc" : "True if this item can be visually activated (defaults to true)",
- "memberOf" : "",
+ "desc" : "True if the panel should not be activated when it is added (defaults to false)",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disableClass",
+ "name" : "closable",
+ "type" : "Boolean",
+ "desc" : "True if the panel can be closed/removed",
+ "memberOf" : "Roo.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "content",
"type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
+ "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
- "memberOf" : "Roo.menu.BaseItem",
+ "name" : "fitContainer",
+ "type" : "Boolean",
+ "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hidden",
+ "name" : "fitToFrame",
"type" : "Boolean",
- "desc" : "True to prevent creation of this menu item (defaults to false)",
- "memberOf" : "Roo.menu.BaseItem",
+ "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hideDelay",
- "type" : "Number",
- "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
- "memberOf" : "Roo.menu.BaseItem",
+ "name" : "layout",
+ "type" : "Roo.layout.Border",
+ "desc" : "The layout for this panel",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
"isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
+ "optvals" : []
},
{
- "name" : "hideOnClick",
+ "name" : "loadOnce",
"type" : "Boolean",
- "desc" : "True to hide the containing menu after this item is clicked (defaults to true)",
- "memberOf" : "Roo.menu.BaseItem",
+ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "html",
- "type" : "String",
- "desc" : "to render in menu\nThe text to show on the menu item (HTML version).",
- "memberOf" : "",
+ "name" : "menu",
+ "type" : "Roo.menu.Menu",
+ "desc" : "popup menu",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "icon",
- "type" : "String",
- "desc" : "The path to an icon to display in this menu item (defaults to Roo.BLANK_IMAGE_URL)",
- "memberOf" : "",
+ "name" : "params",
+ "type" : "String|Object",
+ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "itemCls",
+ "name" : "region",
"type" : "String",
- "desc" : "The default CSS class to use for menu items (defaults to \"x-menu-item\")",
- "memberOf" : "",
+ "desc" : "t) which region to put this panel on (when used with xtype constructor",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "center",
+ "north",
+ "south",
+ "east",
+ "west"
+ ]
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
+ "name" : "resizeEl",
+ "type" : "String|HTMLElement|Element",
+ "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "menu",
- "type" : "Roo.menu.Menu",
- "desc" : "A Sub menu",
- "memberOf" : "",
+ "name" : "style",
+ "type" : "String",
+ "desc" : "Extra style to add to the content panel",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "showDelay",
- "type" : "Number",
- "desc" : "Length of time in milliseconds to wait before showing this item (defaults to 200)",
- "memberOf" : "",
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title for this panel",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "css styles to add to component\neg. text-align:right;",
- "memberOf" : "Roo.Component",
+ "name" : "toolbar",
+ "type" : "Roo.Toolbar",
+ "desc" : "A toolbar for this panel",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "text",
+ "name" : "url",
"type" : "String",
- "desc" : "The text to show on the menu item.",
- "memberOf" : "",
+ "desc" : "Calls {@link #setUrl} with this value",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
}
{
"name" : "activate",
"type" : "function",
- "desc" : "Fires when this item is activated",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.menu.BaseItem",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.BaseItem",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "desc" : "Fires when this panel is activated.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "click",
- "type" : "function",
- "desc" : "Fires when this item is clicked",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.menu.BaseItem",
+ "memberOf" : "Roo.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.BaseItem",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.panel.Content",
"desc" : "",
"isOptional" : false
}
{
"name" : "deactivate",
"type" : "function",
- "desc" : "Fires when this item is deactivated",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.menu.BaseItem",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.BaseItem",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
+ "desc" : "Fires when this panel is activated.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.panel.Content",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "enable",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
+ "desc" : "Fires when this tab is created",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.panel.Content",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "hide",
+ "name" : "resize",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when this panel is resized if fitToFrame is true.",
+ "sig" : "function (_self, width, height)\n{\n\n}",
+ "memberOf" : "Roo.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.panel.Content",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The width after any component adjustments",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The height after any component adjustments",
"isOptional" : false
}
],
],
"returns" : []
},
+ {
+ "name" : "addxtype",
+ "type" : "function",
+ "desc" : "Adds a xtype elements to the layout of the nested panel\n<pre><code>\n\npanel.addxtype({\n xtype : 'ContentPanel',\n region: 'west',\n items: [ .... ]\n }\n);\n\npanel.addxtype({\n xtype : 'panel.NestedLayout',\n region: 'west',\n layout: {\n center: { },\n west: { } \n },\n items : [ ... list of content panels or nested layout panels.. ]\n }\n);\n</code></pre>",
+ "sig" : "(cfg)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "cfg",
+ "type" : "Object",
+ "desc" : "Xtype definition of item to add.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
{
"name" : "destroy",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "desc" : "Destroys this panel",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "disable",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "enable",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Enable this component.",
+ "desc" : "Returns this panel's element - used by regiosn to add.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.Element",
+ "desc" : ""
}
]
},
{
- "name" : "fireEvent",
+ "name" : "getId",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Returns this panel's id",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "eventName",
+ "name" : "",
"type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
+ "desc" : ""
}
- ],
+ ]
+ },
+ {
+ "name" : "getLayout",
+ "type" : "function",
+ "desc" : "Returns the nested BorderLayout for this panel",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "Roo.layout.Border",
+ "desc" : ""
}
]
},
{
- "name" : "focus",
+ "name" : "getTitle",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Returns this panel's title",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getEl",
+ "name" : "getToolbar",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Returns the toolbar for this Panel if one was configured.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "Roo.Toolbar",
+ "desc" : ""
}
]
},
{
- "name" : "getId",
+ "name" : "getUpdateManager",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Roo.UpdateManager",
+ "desc" : "The UpdateManager"
}
]
},
]
},
{
- "name" : "hide",
+ "name" : "isClosable",
"type" : "function",
- "desc" : "Hide this component.",
+ "desc" : "Returns true is this panel was configured to be closable",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : ""
}
]
},
{
- "name" : "isVisible",
+ "name" : "load",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.",
+ "sig" : "(url, params, callback, discardUrl)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "url",
+ "type" : "Object/String/Function",
+ "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\npanel.load({\n url: \"your-url.php\",\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n callback: yourFunction,\n scope: yourObject, //(optional scope)\n discardUrl: false,\n nocache: false,\n text: \"Loading...\",\n timeout: 30,\n scripts: false\n});\n</code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
+ "isOptional" : false
+ },
+ {
+ "name" : "discardUrl",
+ "type" : "Boolean",
+ "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.panel.Content",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "on",
"params" : [],
"returns" : []
},
+ {
+ "name" : "refresh",
+ "type" : "function",
+ "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.panel.Content",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "releaseCapture",
"type" : "function",
"returns" : []
},
{
- "name" : "render",
+ "name" : "setContent",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Updates this panel's element",
+ "sig" : "(content, loadScripts)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "content",
+ "type" : "String",
+ "desc" : "The new content",
+ "isOptional" : false
+ },
+ {
+ "name" : "loadScripts",
+ "type" : "Boolean",
+ "desc" : "(optional) true to look for and process scripts",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "setTitle",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Set this panel's title",
+ "sig" : "(title)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
+ "name" : "title",
+ "type" : "String",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "setText",
+ "name" : "setUrl",
"type" : "function",
- "desc" : "Sets the text to display in this menu item",
- "sig" : "(text, isHTML)",
+ "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
+ "sig" : "(url, params, loadOnce)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "text",
- "type" : "String",
- "desc" : "The text to display",
+ "name" : "url",
+ "type" : "String/Function",
+ "desc" : "The URL to load the content from or a function to call to get the URL",
"isOptional" : false
},
{
- "name" : "isHTML",
- "type" : "Boolean",
- "desc" : "true to indicate text is pure html.",
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "visible",
+ "name" : "loadOnce",
"type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.UpdateManager",
+ "desc" : "The UpdateManager"
}
]
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.menu.CheckItem"
- ],
+ "implementations" : [],
"tree_children" : [],
- "tree_parent" : []
+ "tree_parent" : [
+ "Roo.layout.Border",
+ "Roo.LayoutDialog",
+ "builder"
+ ]
},
- "Roo.menu.Menu" : {
+ "Roo.panel.Tab" : {
"props" : [
- {
- "name" : "allowOtherMenus",
- "type" : "Boolean",
- "desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "defaultAlign",
- "type" : "String",
- "desc" : "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
"memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
- },
- {
- "name" : "minWidth",
- "type" : "Number",
- "desc" : "The minimum width of the menu in pixels (defaults to 120)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "registerMenu",
- "type" : "Boolean",
- "desc" : "True (default) - means that clicking on screen etc. hides it.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "shadow",
- "type" : "Boolean/String",
- "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "subMenuAlign",
- "type" : "String",
- "desc" : "The {@link Roo.Element#alignTo} anchor position value to use for submenus of\nthis menu (defaults to \"tl-tr?\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
}
],
"events" : [
{
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before this menu is hidden",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before this menu is displayed",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "click",
- "type" : "function",
- "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)",
- "sig" : "function (_self, menuItem, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "menuItem",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was clicked",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after this menu is hidden",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "itemclick",
- "type" : "function",
- "desc" : "Fires when a menu item contained in this menu is clicked",
- "sig" : "function (baseItem, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "baseItem",
- "type" : "Roo.menu.BaseItem",
- "desc" : "The BaseItem that was clicked",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "mouseout",
+ "name" : "beforetabchange",
"type" : "function",
- "desc" : "Fires when the mouse exits this menu",
- "sig" : "function (_self, e, menuItem)\n{\n\n}",
+ "desc" : "Fires before the active tab changes, set cancel to true on the \"e\" parameter to cancel the change",
+ "sig" : "function (_self, e, tab)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.Menu",
+ "type" : "Roo.panel.Tab",
"desc" : "",
"isOptional" : false
},
{
"name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "type" : "Object",
+ "desc" : "Set cancel to true on this object to cancel the tab change",
"isOptional" : false
},
{
- "name" : "menuItem",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was clicked",
+ "name" : "tab",
+ "type" : "Roo.panel.TabItem",
+ "desc" : "The tab being changed to",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "mouseover",
+ "name" : "tabchange",
"type" : "function",
- "desc" : "Fires when the mouse is hovering over this menu",
- "sig" : "function (_self, e, menuItem)\n{\n\n}",
+ "desc" : "Fires when the active tab changes",
+ "sig" : "function (_self, activePanel)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.panel.Tab",
"desc" : "",
"isOptional" : false
},
{
- "name" : "menuItem",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was clicked",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after this menu is displayed",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
+ "name" : "activePanel",
+ "type" : "Roo.panel.TabItem",
+ "desc" : "The new active tab",
"isOptional" : false
}
],
],
"methods" : [
{
- "name" : "add",
- "type" : "function",
- "desc" : "Addds one or more items of any type supported by the Menu class, or that can be converted into menu items.\nAny of the following are valid:\n<ul>\n<li>Any menu item object based on {@link Roo.menu.Item}</li>\n<li>An HTMLElement object which will be converted to a menu item</li>\n<li>A menu item config object that will be created as a new menu item</li>\n<li>A string, which can either be '-' or 'separator' to add a menu separator, otherwise\nit will be converted into a {@link Roo.menu.TextItem} and added</li>\n</ul>\nUsage:\n<pre><code>\n// Create the menu\nvar menu = new Roo.menu.Menu();\n\n// Create a menu item to add by reference\nvar menuItem = new Roo.menu.Item({ text: 'New Item!' });\n\n// Add a bunch of items at once using different methods.\n// Only the last item added will be returned.\nvar item = menu.add(\n menuItem, // add existing item by ref\n 'Dynamic Item', // new TextItem\n '-', // new separator\n { text: 'Config Item' } // new item by config\n);\n</code></pre>",
- "sig" : "(args)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "args",
- "type" : "Mixed",
- "desc" : "One or more menu items, menu item configs or other objects that can be converted to menu items",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was added, or the last one if multiple items were added"
- }
- ]
- },
- {
- "name" : "addElement",
+ "name" : "activate",
"type" : "function",
- "desc" : "Adds an {@link Roo.Element} object to the menu",
- "sig" : "(el)",
+ "desc" : "Activates a {@link Roo.panel.TabItem}. The currently active one will be deactivated.",
+ "sig" : "(id)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The element or DOM node to add, or its id",
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to activate.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was added"
+ "type" : "Roo.panel.TabItem",
+ "desc" : "The TabPanelItem."
}
]
},
],
"returns" : []
},
- {
- "name" : "addItem",
- "type" : "function",
- "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu",
- "sig" : "(item)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "item",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item to add",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was added"
- }
- ]
- },
{
"name" : "addListener",
"type" : "function",
"returns" : []
},
{
- "name" : "addMenuItem",
- "type" : "function",
- "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu",
- "sig" : "(config)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "config",
- "type" : "Object",
- "desc" : "A MenuItem config object",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was added"
- }
- ]
- },
- {
- "name" : "addSeparator",
- "type" : "function",
- "desc" : "Adds a separator bar to the menu",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was added"
- }
- ]
- },
- {
- "name" : "addText",
+ "name" : "addTab",
"type" : "function",
- "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu",
- "sig" : "(text)",
+ "desc" : "Creates a new {@link Roo.panel.TabItem} by looking for an existing element with the provided id -- if it's not found it creates one.",
+ "sig" : "(id, text, content, closable)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "text",
+ "name" : "id",
"type" : "String",
- "desc" : "The text to display in the menu item",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was added"
- }
- ]
- },
- {
- "name" : "capture",
- "type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
+ "desc" : "The id of the div to use <b>or create</b>",
"isOptional" : false
},
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "text",
+ "type" : "String",
+ "desc" : "The text for the tab",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "fireEvent",
- "type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
+ "name" : "content",
"type" : "String",
- "desc" : "",
+ "desc" : "(optional) Content to put in the TabPanelItem body",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
+ "name" : "closable",
"type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
- },
- {
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns this menu's underlying {@link Roo.Element} object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
- }
- ]
- },
- {
- "name" : "hasListener",
- "type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "desc" : "(optional) True to create a close icon on the tab",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "Roo.panel.TabItem",
+ "desc" : "The created TabPanelItem"
}
]
},
{
- "name" : "hide",
+ "name" : "addTabItem",
"type" : "function",
- "desc" : "Hides this menu and optionally all parent menus",
- "sig" : "(deep)",
+ "desc" : "Adds an existing {@link Roo.panel.TabItem}.",
+ "sig" : "(item)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "deep",
- "type" : "Boolean",
- "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)",
+ "name" : "item",
+ "type" : "Roo.panel.TabItem",
+ "desc" : "The TabPanelItem to add",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "insert",
+ "name" : "autoSizeTabs",
"type" : "function",
- "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index",
- "sig" : "(index, item)",
+ "desc" : "Manual call to resize the tabs (if {@link #resizeTabs} is false this does nothing)",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index in the menu's list of current items where the new item should be inserted",
- "isOptional" : false
- },
- {
- "name" : "item",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item to add",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was added"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "isVisible",
+ "name" : "beginUpdate",
"type" : "function",
- "desc" : "Read-only. Returns true if the menu is currently displayed, else false.",
+ "desc" : "Disables tab resizing while tabs are being added (if {@link #resizeTabs} is false this does nothing)",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : []
},
{
- "name" : "on",
+ "name" : "capture",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
"memberOf" : "Roo.util.Observable",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "handler",
+ "name" : "fn",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The function to call",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Destroys this TabPanel",
+ "sig" : "(removeEl)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "removeEl",
+ "type" : "Boolean",
+ "desc" : "(optional) True to remove the element from the DOM as well (defaults to undefined)",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "disableTab",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Disables a {@link Roo.panel.TabItem}. It cannot be the active tab, if it is this call is ignored.",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to disable.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "enableTab",
"type" : "function",
- "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object",
- "sig" : "(item)",
+ "desc" : "Enables a {@link Roo.panel.TabItem} that is disabled.",
+ "sig" : "(id)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "item",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item to remove",
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to enable.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeAll",
+ "name" : "endUpdate",
"type" : "function",
- "desc" : "Removes and destroys all items in the menu",
+ "desc" : "Stops an update and resizes the tabs (if {@link #resizeTabs} is false this does nothing)",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Displays this menu relative to another element",
- "sig" : "(element, position, parentMenu)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "element",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The element to align to",
- "isOptional" : false
- },
- {
- "name" : "position",
- "type" : "String",
- "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)",
- "isOptional" : false
- },
+ "returns" : [
{
- "name" : "parentMenu",
- "type" : "Roo.menu.Menu",
- "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "showAt",
+ "name" : "getActiveTab",
"type" : "function",
- "desc" : "Displays this menu at a specific xy position",
- "sig" : "(xyPosition, parentMenu)",
+ "desc" : "Gets the active {@link Roo.panel.TabItem}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "xyPosition",
- "type" : "Array",
- "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "parentMenu",
- "type" : "Roo.menu.Menu",
- "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.panel.TabItem",
+ "desc" : "The active TabPanelItem or null if none are active."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.menu.ColorMenu",
- "Roo.menu.DateMenu"
- ],
- "tree_children" : [
- "Roo.menu.Item",
- "Roo.menu.CheckItem",
- "Roo.menu.Separator",
- "Roo.menu.TextItem"
- ],
- "tree_parent" : []
- },
- "Roo.menu.MenuMgr" : {
- "props" : [],
- "events" : [],
- "methods" : [
- {
- "name" : "get",
+ "name" : "getCount",
"type" : "function",
- "desc" : "Returns a {@link Roo.menu.Menu} object",
- "sig" : "(menu)",
+ "desc" : "Returns the number of tabs in this TabPanel.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "menu",
- "type" : "String/Object",
- "desc" : "The string menu id, an existing menu object reference, or a Menu config that will\nbe used to generate and return a new Menu instance.",
- "isOptional" : false
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "hideAll",
+ "name" : "getTab",
"type" : "function",
- "desc" : "Hides all menus that are currently visible",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the {@link Roo.panel.TabItem} with the specified id/index",
+ "sig" : "(id)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.menu.Separator" : {
- "props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "activeClass",
- "type" : "String",
- "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")",
- "memberOf" : "Roo.menu.BaseItem",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "canActivate",
- "type" : "Boolean",
- "desc" : "True if this item can be visually activated (defaults to false)",
- "memberOf" : "Roo.menu.BaseItem",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
- "memberOf" : "Roo.menu.BaseItem",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "True to prevent creation of this menu item (defaults to false)",
- "memberOf" : "Roo.menu.BaseItem",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideDelay",
- "type" : "Number",
- "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
- "memberOf" : "Roo.menu.BaseItem",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
- },
- {
- "name" : "hideOnClick",
- "type" : "Boolean",
- "desc" : "True to hide the containing menu after this item is clicked (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "itemCls",
- "type" : "String",
- "desc" : "The default CSS class to use for separators (defaults to \"x-menu-sep\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to fetch.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.panel.TabItem",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "name" : "hasListener",
+ "type" : "function",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
"memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "css styles to add to component\neg. text-align:right;",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "activate",
+ "name" : "hideTab",
"type" : "function",
- "desc" : "Fires when this item is activated",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.menu.BaseItem",
+ "desc" : "Hides the {@link Roo.panel.TabItem} with the specified id/index",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.menu.BaseItem",
- "desc" : "",
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to hide.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforedestroy",
+ "name" : "on",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforehide",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "removeTab",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Removes a {@link Roo.panel.TabItem}.",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to remove.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "click",
+ "name" : "setTabWidth",
"type" : "function",
- "desc" : "Fires when this item is clicked",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.menu.BaseItem",
+ "desc" : "Resizes all the tabs to the passed width",
+ "sig" : "(The)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.menu.BaseItem",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "The",
+ "type" : "Number",
+ "desc" : "new width",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "deactivate",
+ "name" : "syncHeight",
"type" : "function",
- "desc" : "Fires when this item is deactivated",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.menu.BaseItem",
+ "desc" : "Updates the tab body element to fit the height of the container element\nfor overflow scrolling",
+ "sig" : "(targetHeight)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.menu.BaseItem",
- "desc" : "",
+ "name" : "targetHeight",
+ "type" : "Number",
+ "desc" : "(optional) Override the starting height from the elements height",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "un",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "unhideTab",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "\"Unhides\" the {@link Roo.panel.TabItem} with the specified id/index.",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to unhide.",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.panel.TabItem" : {
+ "props" : [
{
- "name" : "enable",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "activate",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when this tab becomes the active tab.",
+ "sig" : "function (tabPanel, _self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "tabPanel",
+ "type" : "Roo.panel.Tab",
+ "desc" : "The parent TabPanel",
+ "isOptional" : false
+ },
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.panel.TabItem",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "hide",
+ "name" : "beforeclose",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires before this tab is closed. To cancel the close, set cancel to true on e (e.cancel = true).",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.panel.TabItem",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "Set cancel to true on this object to cancel the close.",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "close",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
+ "desc" : "Fires when this tab is closed.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.panel.TabItem",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "show",
+ "name" : "deactivate",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when this tab is no longer the active tab.",
+ "sig" : "function (tabPanel, _self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "tabPanel",
+ "type" : "Roo.panel.Tab",
+ "desc" : "The parent TabPanel",
+ "isOptional" : false
+ },
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.panel.TabItem",
"desc" : "",
"isOptional" : false
}
}
],
"methods" : [
+ {
+ "name" : "activate",
+ "type" : "function",
+ "desc" : "Activates this TabPanelItem -- this <b>does</b> deactivate the currently active TabPanelItem.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "addEvents",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "disable",
"type" : "function",
- "desc" : "Disable this component.",
+ "desc" : "Disables this TabPanelItem -- this does nothing if this is the active TabPanelItem.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
"name" : "enable",
"type" : "function",
- "desc" : "Enable this component.",
+ "desc" : "Enables this TabPanelItem if it was previously disabled.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
"name" : "fireEvent",
]
},
{
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "getEl",
+ "name" : "getText",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Returns the text for this tab",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getId",
+ "name" : "getUpdateManager",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Gets the {@link Roo.UpdateManager} for the body of this TabPanelItem. Enables you to perform Ajax updates.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Roo.UpdateManager",
+ "desc" : "The UpdateManager"
}
]
},
{
"name" : "hide",
"type" : "function",
- "desc" : "Hide this component.",
+ "desc" : "Hides this TabPanelItem -- if you don't activate another TabPanelItem this could look odd.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isActive",
+ "type" : "function",
+ "desc" : "Returns true if this tab is the active tab.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : ""
}
]
},
{
- "name" : "isVisible",
+ "name" : "isHidden",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
+ "desc" : "Returns true if this tab is \"hidden\"",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
"name" : "on",
"params" : [],
"returns" : []
},
+ {
+ "name" : "refresh",
+ "type" : "function",
+ "desc" : "Forces a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the setUrl method has not been called.\n This does not activate the panel, just updates its content.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "releaseCapture",
"type" : "function",
"returns" : []
},
{
- "name" : "render",
+ "name" : "setContent",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Sets the content for this TabPanelItem.",
+ "sig" : "(content, loadScripts)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "content",
+ "type" : "String",
+ "desc" : "The content",
+ "isOptional" : false
+ },
+ {
+ "name" : "loadScripts",
+ "type" : "Boolean",
+ "desc" : "true to look for and load scripts",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "setHidden",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Show or hide the tab",
+ "sig" : "(hidden)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
+ "name" : "hidden",
"type" : "Boolean",
- "desc" : "",
+ "desc" : "True to hide or false to show.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "setText",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Sets the text for the tab (Note: this also sets the tooltip text)",
+ "sig" : "(text)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
+ "name" : "text",
+ "type" : "String",
+ "desc" : "The tab's text and tooltip",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setTooltip",
+ "type" : "function",
+ "desc" : "Set the tooltip for the tab.",
+ "sig" : "(tooltip)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "tooltip",
+ "type" : "String",
+ "desc" : "The tab's tooltip",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setUrl",
+ "type" : "function",
+ "desc" : "Set a URL to be used to load the content for this TabPanelItem.",
+ "sig" : "(url, params, loadOnce)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "url",
+ "type" : "String/Function",
+ "desc" : "The URL to load the content from, or a function to call to get the URL",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
+ "isOptional" : false
+ },
+ {
+ "name" : "loadOnce",
"type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this TabPanelItem is activated. (Defaults to false)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.UpdateManager",
+ "desc" : "The UpdateManager"
}
]
},
{
"name" : "show",
"type" : "function",
- "desc" : "Show this component.",
+ "desc" : "Shows this TabPanelItem -- this <b>does not</b> deactivate the currently active TabPanelItem.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
"name" : "un",
"tree_children" : [],
"tree_parent" : []
},
- "Roo.menu.TextItem" : {
+ "Roo.panel.Tree" : {
"props" : [
{
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component",
+ "name" : "adjustments",
+ "type" : "Array",
+ "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "activeClass",
- "type" : "String",
- "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")",
- "memberOf" : "Roo.menu.BaseItem",
+ "name" : "autoCreate",
+ "type" : "Boolean|Object",
+ "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "allowDomMove",
+ "name" : "autoScroll",
"type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
+ "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "canActivate",
+ "name" : "background",
"type" : "Boolean",
- "desc" : "True if this item can be visually activated (defaults to false)",
- "memberOf" : "Roo.menu.BaseItem",
+ "desc" : "True if the panel should not be activated when it is added (defaults to false)",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disableClass",
+ "name" : "closable",
+ "type" : "Boolean",
+ "desc" : "True if the panel can be closed/removed",
+ "memberOf" : "Roo.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "content",
"type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
+ "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
- "memberOf" : "Roo.menu.BaseItem",
+ "name" : "fitContainer",
+ "type" : "Boolean",
+ "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hidden",
+ "name" : "fitToFrame",
"type" : "Boolean",
- "desc" : "True to prevent creation of this menu item (defaults to false)",
- "memberOf" : "Roo.menu.BaseItem",
+ "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hideDelay",
- "type" : "Number",
- "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
- "memberOf" : "Roo.menu.BaseItem",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hideMode",
+ "name" : "loadOnce",
+ "type" : "Boolean",
+ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf" : "Roo.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "menu",
+ "type" : "Roo.menu.Menu",
+ "desc" : "popup menu",
+ "memberOf" : "Roo.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "params",
+ "type" : "String|Object",
+ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf" : "Roo.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "region",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
- "memberOf" : "Roo.Component",
+ "desc" : "t) which region to put this panel on (when used with xtype constructor",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : [
- "display",
- "visibility"
+ "center",
+ "north",
+ "south",
+ "east",
+ "west"
]
},
{
- "name" : "hideOnClick",
- "type" : "Boolean",
- "desc" : "True to hide the containing menu after this item is clicked (defaults to false)",
- "memberOf" : "",
+ "name" : "resizeEl",
+ "type" : "String|HTMLElement|Element",
+ "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "itemCls",
+ "name" : "style",
"type" : "String",
- "desc" : "The default CSS class to use for text items (defaults to \"x-menu-text\")",
- "memberOf" : "",
+ "desc" : "Extra style to add to the content panel",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title for this panel",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "css styles to add to component\neg. text-align:right;",
- "memberOf" : "Roo.Component",
+ "name" : "toolbar",
+ "type" : "Roo.Toolbar",
+ "desc" : "A toolbar for this panel",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "text",
+ "name" : "url",
"type" : "String",
- "desc" : "Text to show on item.",
- "memberOf" : "",
+ "desc" : "Calls {@link #setUrl} with this value",
+ "memberOf" : "Roo.panel.Content",
"isOptional" : false,
"optvals" : []
}
{
"name" : "activate",
"type" : "function",
- "desc" : "Fires when this item is activated",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.menu.BaseItem",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.BaseItem",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "desc" : "Fires when this panel is activated.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "click",
- "type" : "function",
- "desc" : "Fires when this item is clicked",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.menu.BaseItem",
+ "memberOf" : "Roo.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.BaseItem",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.panel.Content",
"desc" : "",
"isOptional" : false
}
{
"name" : "deactivate",
"type" : "function",
- "desc" : "Fires when this item is deactivated",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.menu.BaseItem",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.BaseItem",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
+ "desc" : "Fires when this panel is activated.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.panel.Content",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "enable",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
+ "desc" : "Fires when this tab is created",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.panel.Content",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "hide",
+ "name" : "resize",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when this panel is resized if fitToFrame is true.",
+ "sig" : "function (_self, width, height)\n{\n\n}",
+ "memberOf" : "Roo.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.panel.Content",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The width after any component adjustments",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The height after any component adjustments",
"isOptional" : false
}
],
],
"returns" : []
},
+ {
+ "name" : "addxtype",
+ "type" : "function",
+ "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'Form',\n items: [ .... ]\n }\n);\n\n</code></pre>",
+ "sig" : "(cfg)",
+ "static" : false,
+ "memberOf" : "Roo.panel.Content",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "cfg",
+ "type" : "Object",
+ "desc" : "Xtype definition of item to add.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
{
"name" : "destroy",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "desc" : "Destroys this panel",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "disable",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "enable",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Enable this component.",
+ "desc" : "Returns this panel's element - used by regiosn to add.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.Element",
+ "desc" : ""
}
]
},
{
- "name" : "fireEvent",
+ "name" : "getId",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Returns this panel's id",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "focus",
+ "name" : "getTitle",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Returns this panel's title",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getEl",
+ "name" : "getToolbar",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Returns the toolbar for this Panel if one was configured.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "Roo.Toolbar",
+ "desc" : ""
}
]
},
{
- "name" : "getId",
+ "name" : "getUpdateManager",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Roo.UpdateManager",
+ "desc" : "The UpdateManager"
}
]
},
]
},
{
- "name" : "hide",
+ "name" : "isClosable",
"type" : "function",
- "desc" : "Hide this component.",
+ "desc" : "Returns true is this panel was configured to be closable",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : ""
}
]
},
{
- "name" : "isVisible",
+ "name" : "load",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.",
+ "sig" : "(url, params, callback, discardUrl)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "url",
+ "type" : "Object/String/Function",
+ "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\npanel.load({\n url: \"your-url.php\",\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n callback: yourFunction,\n scope: yourObject, //(optional scope)\n discardUrl: false,\n nocache: false,\n text: \"Loading...\",\n timeout: 30,\n scripts: false\n});\n</code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
+ "isOptional" : false
+ },
+ {
+ "name" : "discardUrl",
+ "type" : "Boolean",
+ "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.panel.Content",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "on",
"params" : [],
"returns" : []
},
+ {
+ "name" : "refresh",
+ "type" : "function",
+ "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.panel.Content",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "releaseCapture",
"type" : "function",
"returns" : []
},
{
- "name" : "render",
+ "name" : "setContent",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Updates this panel's element",
+ "sig" : "(content, loadScripts)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "content",
+ "type" : "String",
+ "desc" : "The new content",
+ "isOptional" : false
+ },
+ {
+ "name" : "loadScripts",
+ "type" : "Boolean",
+ "desc" : "(optional) true to look for and process scripts",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "setTitle",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Set this panel's title",
+ "sig" : "(title)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
+ "name" : "title",
+ "type" : "String",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "setUrl",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
+ "sig" : "(url, params, loadOnce)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
+ "name" : "url",
+ "type" : "String/Function",
+ "desc" : "The URL to load the content from or a function to call to get the URL",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
+ "isOptional" : false
+ },
+ {
+ "name" : "loadOnce",
"type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.UpdateManager",
+ "desc" : "The UpdateManager"
}
]
},
"isBuilderTop" : false,
"implementations" : [],
"tree_children" : [],
- "tree_parent" : []
+ "tree_parent" : [
+ "Roo.layout.Border",
+ "Roo.LayoutDialog",
+ "builder"
+ ]
},
"Roo.rtf" : {
"props" : [],
"implementations" : [
"Roo.Ajax",
"Roo.BasicDialog",
- "Roo.BasicLayoutRegion",
- "Roo.BorderLayout",
"Roo.BoxComponent",
"Roo.Button",
- "Roo.CalendarPanel",
"Roo.ColorPalette",
"Roo.Component",
- "Roo.ContentPanel",
"Roo.DatePicker",
"Roo.Document",
"Roo.Editor",
- "Roo.GridPanel",
"Roo.HtmlEditorCore",
"Roo.JsonView",
"Roo.LayoutDialog",
- "Roo.LayoutManager",
- "Roo.LayoutRegion",
- "Roo.NestedLayoutPanel",
- "Roo.ReaderLayout",
"Roo.Resizable",
"Roo.SplitBar",
"Roo.SplitButton",
- "Roo.SplitLayoutRegion",
- "Roo.TabPanel",
- "Roo.TabPanelItem",
"Roo.Toolbar.Button",
"Roo.Toolbar.SplitButton",
- "Roo.TreePanel",
"Roo.UpdateManager",
"Roo.View",
"Roo.XComponent",
"Roo.dd.DragZone",
"Roo.dd.DropTarget",
"Roo.dd.DropZone",
- "Roo.dialog.UploadCropbox",
"Roo.form.BasicForm",
"Roo.form.Checkbox",
"Roo.form.Column",
"Roo.grid.PropertyGrid",
"Roo.grid.RowSelectionModel",
"Roo.grid.SplitDragZone",
+ "Roo.layout.BasicRegion",
+ "Roo.layout.Border",
+ "Roo.layout.Manager",
+ "Roo.layout.Reader",
+ "Roo.layout.Region",
+ "Roo.layout.SplitRegion",
"Roo.menu.Adapter",
"Roo.menu.BaseItem",
"Roo.menu.CheckItem",
"Roo.menu.Menu",
"Roo.menu.Separator",
"Roo.menu.TextItem",
+ "Roo.panel.Calendar",
+ "Roo.panel.Content",
+ "Roo.panel.Cropbox",
+ "Roo.panel.Grid",
+ "Roo.panel.NestedLayout",
+ "Roo.panel.Tab",
+ "Roo.panel.TabItem",
+ "Roo.panel.Tree",
"Roo.tree.AsyncTreeNode",
"Roo.tree.ColumnTree",
"Roo.tree.DefaultSelectionModel",
projects / roojs1 / blobdiff