X-Git-Url: http://git.roojs.org/?a=blobdiff_plain;f=docs%2Fjson%2Froodata.json;h=6a609964f56fc95f07bfc231281d343ccc0bf944;hb=b059ce97695e99e0dba875dfc29b3400789cf51d;hp=c953c69d332167c90dfceb8281fa8c6d70c3b91a;hpb=58086923568ba2a17618e03fa4bd1f193094f812;p=roojs1 diff --git a/docs/json/roodata.json b/docs/json/roodata.json index c953c69d33..6a609964f5 100644 --- a/docs/json/roodata.json +++ b/docs/json/roodata.json @@ -48087,6 +48087,12 @@ }, "Roo.doc.Example": { "props": [ + { + "name": "title", + "type": "String", + "desc": "short title describing example", + "memberOf": "" + }, { "name": "lang", "type": "String", @@ -48100,12 +48106,318 @@ { "name": "code", "type": "String", - "desc": "", + "desc": "example code", "memberOf": "" + }, + { + "name": "output", + "type": "String", + "desc": "The expected output from the code", + "memberOf": "" + }, + { + "name": "cls", + "type": "String", + "desc": "css class", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "style", + "type": "String", + "desc": "any extra css", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "xattr", + "type": "Object", + "desc": "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "can_build_overlaid", + "type": "Boolean", + "desc": "True if element can be rebuild from a HTML page", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "dataId", + "type": "string", + "desc": "cutomer id", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "name", + "type": "string", + "desc": "Specifies name attribute", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "tooltip", + "type": "string", + "desc": "Text for the tooltip", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "container_method", + "type": "string", + "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "disableClass", + "type": "String", + "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf": "Roo.Component" + }, + { + "name": "allowDomMove", + "type": "Boolean", + "desc": "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf": "Roo.Component" + }, + { + "name": "hideMode", + "type": "String", + "desc": "How 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", + "optvals": [ + "display", + "visibility" + ] + }, + { + "name": "actionMode", + "type": "String", + "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf": "Roo.Component" + }, + { + "name": "listeners", + "type": "Object", + "desc": "list of events and functions to call for this object, \nFor example :\n
\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n
",
+ "memberOf": "Roo.util.Observable"
}
],
- "events": [],
- "methods": []
+ "events": [
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "childrenrendered",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the children have been rendered.."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ }
+ ],
+ "methods": [
+ {
+ "name": "addEvents",
+ "sig": "(Object object)",
+ "type": "function",
+ "desc": "Used to define events on this Observable"
+ },
+ {
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this component"
+ },
+ {
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
+ "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\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire."
+ },
+ {
+ "name": "destroy",
+ "sig": "()",
+ "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}."
+ },
+ {
+ "name": "disable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Disable this component."
+ },
+ {
+ "name": "enable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Enable this component."
+ },
+ {
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ },
+ {
+ "name": "focus",
+ "sig": "(Boolean selectText)",
+ "type": "function",
+ "desc": "Try to focus this component."
+ },
+ {
+ "name": "getChildContainer",
+ "sig": "()",
+ "type": "function",
+ "desc": "Fetch the element to add children to"
+ },
+ {
+ "name": "getEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the underlying {@link Roo.Element}."
+ },
+ {
+ "name": "getId",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the id of this component."
+ },
+ {
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
+ },
+ {
+ "name": "hide",
+ "sig": "()",
+ "type": "function",
+ "desc": "Hide a component - adds 'hidden' class"
+ },
+ {
+ "name": "initEvents",
+ "sig": "()",
+ "type": "function",
+ "desc": "Initialize Events for the element"
+ },
+ {
+ "name": "isVisible",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if this component is visible."
+ },
+ {
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
+ },
+ {
+ "name": "purgeListeners",
+ "sig": "()",
+ "type": "function",
+ "desc": "Removes all listeners for this object"
+ },
+ {
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes all added captures from the Observable."
+ },
+ {
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
+ },
+ {
+ "name": "render",
+ "sig": "(String/HTMLElement/Element container)",
+ "type": "function",
+ "desc": "If this is a lazy rendering component, render it to its container element."
+ },
+ {
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
+ "type": "function",
+ "desc": "Convenience function for setting disabled/enabled by boolean."
+ },
+ {
+ "name": "setVisible",
+ "sig": "(Boolean visible)",
+ "type": "function",
+ "desc": "Convenience function to hide or show this component by boolean."
+ },
+ {
+ "name": "show",
+ "sig": "()",
+ "type": "function",
+ "desc": "Show a component - removes 'hidden' class"
+ },
+ {
+ "name": "tooltipEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Fetch the element to display the tooltip on."
+ },
+ {
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
},
"Roo.doc.Para": {
"props": [
@@ -48424,7 +48736,7 @@
{
"name": "is_optional",
"type": "bool",
- "desc": "",
+ "desc": "is the argument optional",
"memberOf": ""
},
{
@@ -48436,7 +48748,7 @@
{
"name": "name",
"type": "String",
- "desc": "",
+ "desc": "name of the parameter",
"memberOf": ""
},
{
@@ -49092,6 +49404,18 @@
"constant"
]
},
+ {
+ "name": "memberof",
+ "type": "String",
+ "desc": "class name",
+ "memberOf": ""
+ },
+ {
+ "name": "is_static",
+ "type": "bool",
+ "desc": "is a static member",
+ "memberOf": ""
+ },
{
"name": "cls",
"type": "String",