"type": "function",
"desc": "Returns true if the passed value is null, undefined or an empty string (optional)."
},
- {
- "name": "log",
- "sig": "(String|Object string)",
- "type": "function",
- "desc": "Logs to console if it can."
- },
{
"name": "namespace",
"sig": "(String namespace1, String namespace2, String etc)",
}
],
"events": [
+ {
+ "name": "beforecollapse",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this region before collapse."
+ },
{
"name": "beforeremove",
"sig": "function (_self, panel, e)\n{\n\n}",
}
]
},
+ "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"
+ }
+ ],
+ "events": [],
+ "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\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire."
+ },
+ {
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ },
+ {
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
+ },
+ {
+ "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 <b>all</b> added captures from the Observable."
+ },
+ {
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
+ },
+ {
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
"Roo.DomHelper": {
"props": [],
"events": [],
}
],
"events": [
+ {
+ "name": "beforecollapse",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this region before collapse."
+ },
{
"name": "beforeremove",
"sig": "function (_self, panel, e)\n{\n\n}",
}
],
"events": [
+ {
+ "name": "beforecollapse",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this region before collapse."
+ },
{
"name": "beforeremove",
"sig": "function (_self, panel, e)\n{\n\n}",
}
]
},
- "Roo.bootstrap.Button": {
+ "Roo.bootstrap.Brick": {
"props": [
{
- "name": "html",
- "type": "String",
- "desc": "The button content",
- "memberOf": ""
- },
- {
- "name": "weight",
- "type": "String",
- "desc": "default",
- "memberOf": "",
- "optvals": [
- "primary",
- "success",
- "info",
- "warning",
- "danger",
- "link"
- ]
- },
- {
- "name": "size",
- "type": "String",
- "desc": "",
- "memberOf": "",
- "optvals": [
- "lg",
- "sm",
- "xs"
- ]
- },
- {
- "name": "tag",
+ "name": "title",
"type": "String",
"desc": "",
- "memberOf": "",
- "optvals": [
- "a",
- "input",
- "submit"
- ]
- },
- {
- "name": "href",
- "type": "String",
- "desc": "empty or href",
"memberOf": ""
},
{
- "name": "disabled",
- "type": "Boolean",
- "desc": "default false;",
- "memberOf": ""
- },
- {
- "name": "isClose",
- "type": "Boolean",
- "desc": "default false;",
- "memberOf": ""
- },
- {
- "name": "glyphicon",
+ "name": "html",
"type": "String",
"desc": "",
- "memberOf": "",
- "optvals": [
- "",
- "adjust",
- "align-center",
- "align-justify",
- "align-left",
- "align-right",
- "arrow-down",
- "arrow-left",
- "arrow-right",
- "arrow-up",
- "asterisk",
- "backward",
- "ban-circle",
- "barcode",
- "bell",
- "bold",
- "book",
- "bookmark",
- "briefcase",
- "bullhorn",
- "calendar",
- "camera",
- "certificate",
- "check",
- "chevron-down",
- "chevron-left",
- "chevron-right",
- "chevron-up",
- "circle-arrow-down",
- "circle-arrow-left",
- "circle-arrow-right",
- "circle-arrow-up",
- "cloud",
- "cloud-download",
- "cloud-upload",
- "cog",
- "collapse-down",
- "collapse-up",
- "comment",
- "compressed",
- "copyright-mark",
- "credit-card",
- "cutlery",
- "dashboard",
- "download",
- "download-alt",
- "earphone",
- "edit",
- "eject",
- "envelope",
- "euro",
- "exclamation-sign",
- "expand",
- "export",
- "eye-close",
- "eye-open",
- "facetime-video",
- "fast-backward",
- "fast-forward",
- "file",
- "film",
- "filter",
- "fire",
- "flag",
- "flash",
- "floppy-disk",
- "floppy-open",
- "floppy-remove",
- "floppy-save",
- "floppy-saved",
- "folder-close",
- "folder-open",
- "font",
- "forward",
- "fullscreen",
- "gbp",
- "gift",
- "glass",
- "globe",
- "hand-down",
- "hand-left",
- "hand-right",
- "hand-up",
- "hd-video",
- "hdd",
- "header",
- "headphones",
- "heart",
- "heart-empty",
- "home",
- "import",
- "inbox",
- "indent-left",
- "indent-right",
- "info-sign",
- "italic",
- "leaf",
- "link",
- "list",
- "list-alt",
- "lock",
- "log-in",
- "log-out",
- "magnet",
- "map-marker",
- "minus",
- "minus-sign",
- "move",
- "music",
- "new-window",
- "off",
- "ok",
- "ok-circle",
- "ok-sign",
- "open",
- "paperclip",
- "pause",
- "pencil",
- "phone",
- "phone-alt",
- "picture",
- "plane",
- "play",
- "play-circle",
- "plus",
- "plus-sign",
- "print",
- "pushpin",
- "qrcode",
- "question-sign",
- "random",
- "record",
- "refresh",
- "registration-mark",
- "remove",
- "remove-circle",
- "remove-sign",
- "repeat",
- "resize-full",
- "resize-horizontal",
- "resize-small",
- "resize-vertical",
- "retweet",
- "road",
- "save",
- "saved",
- "screenshot",
- "sd-video",
- "search",
- "send",
- "share",
- "share-alt",
- "shopping-cart",
- "signal",
- "sort",
- "sort-by-alphabet",
- "sort-by-alphabet-alt",
- "sort-by-attributes",
- "sort-by-attributes-alt",
- "sort-by-order",
- "sort-by-order-alt",
- "sound-5-1",
- "sound-6-1",
- "sound-7-1",
- "sound-dolby",
- "sound-stereo",
- "star",
- "star-empty",
- "stats",
- "step-backward",
- "step-forward",
- "stop",
- "subtitles",
- "tag",
- "tags",
- "tasks",
- "text-height",
- "text-width",
- "th",
- "th-large",
- "th-list",
- "thumbs-down",
- "thumbs-up",
- "time",
- "tint",
- "tower",
- "transfer",
- "trash",
- "tree-conifer",
- "tree-deciduous",
- "unchecked",
- "upload",
- "usd",
- "user",
- "volume-down",
- "volume-off",
- "volume-up",
- "warning-sign",
- "wrench",
- "zoom-in",
- "zoom-out"
- ]
- },
- {
- "name": "badge",
- "type": "String",
- "desc": "text for badge",
"memberOf": ""
},
{
- "name": "theme",
+ "name": "bgimage",
"type": "String",
- "desc": "default",
- "memberOf": ""
- },
- {
- "name": "inverse",
- "type": "Boolean",
"desc": "",
"memberOf": ""
},
{
- "name": "toggle",
- "type": "Boolean",
+ "name": "cls",
+ "type": "String",
"desc": "",
"memberOf": ""
},
{
- "name": "ontext",
+ "name": "href",
"type": "String",
- "desc": "text for on toggle state",
+ "desc": "",
"memberOf": ""
},
{
- "name": "offtext",
+ "name": "video",
"type": "String",
- "desc": "text for off toggle state",
- "memberOf": ""
- },
- {
- "name": "defaulton",
- "type": "Boolean",
"desc": "",
"memberOf": ""
},
{
- "name": "preventDefault",
+ "name": "square",
"type": "Boolean",
- "desc": "default true",
- "memberOf": ""
- },
- {
- "name": "removeClass",
- "type": "Boolean",
- "desc": "remove the standard class..",
- "memberOf": ""
- },
- {
- "name": "target",
- "type": "String",
- "desc": "target for a href. (_self|_blank|_parent|_top| other)",
+ "desc": "",
"memberOf": ""
},
- {
- "name": "cls",
- "type": "String",
- "desc": "css class",
- "memberOf": "Roo.bootstrap.Component"
- },
{
"name": "style",
"type": "String",
"name": "click",
"sig": "function (_self, e)\n{\n\n}",
"type": "function",
- "desc": "When a butotn is pressed"
+ "desc": "When a Brick is click"
},
{
"name": "destroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is shown."
- },
- {
- "name": "toggle",
- "sig": "function (e, pressed)\n{\n\n}",
- "type": "function",
- "desc": "After the button has been toggles"
}
],
"methods": [
"name": "disable",
"sig": "()",
"type": "function",
- "desc": "Disable this button"
+ "desc": "Disable this component."
},
{
"name": "enable",
"sig": "()",
"type": "function",
- "desc": "Enables this button"
+ "desc": "Enable this component."
},
{
"name": "fireEvent",
"type": "function",
"desc": "If this is a lazy rendering component, render it to its container element."
},
- {
- "name": "setActive",
- "sig": "(Boolean state)",
- "type": "function",
- "desc": "sets the active state on/off,"
- },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
"type": "function",
"desc": "Show a component - removes 'hidden' class"
},
- {
- "name": "toggleActive",
- "sig": "()",
- "type": "function",
- "desc": "toggles the current active state"
- },
{
"name": "tooltipEl",
"sig": "()",
}
]
},
- "Roo.bootstrap.ButtonGroup": {
+ "Roo.bootstrap.Button": {
"props": [
+ {
+ "name": "html",
+ "type": "String",
+ "desc": "The button content",
+ "memberOf": ""
+ },
+ {
+ "name": "weight",
+ "type": "String",
+ "desc": "default",
+ "memberOf": "",
+ "optvals": [
+ "default",
+ "primary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "link"
+ ]
+ },
{
"name": "size",
"type": "String",
- "desc": "lg | sm | xs (default empty normal)",
+ "desc": "",
+ "memberOf": "",
+ "optvals": [
+ "lg",
+ "sm",
+ "xs"
+ ]
+ },
+ {
+ "name": "tag",
+ "type": "String",
+ "desc": "",
+ "memberOf": "",
+ "optvals": [
+ "a",
+ "input",
+ "submit"
+ ]
+ },
+ {
+ "name": "href",
+ "type": "String",
+ "desc": "empty or href",
"memberOf": ""
},
{
- "name": "align",
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "default false;",
+ "memberOf": ""
+ },
+ {
+ "name": "isClose",
+ "type": "Boolean",
+ "desc": "default false;",
+ "memberOf": ""
+ },
+ {
+ "name": "glyphicon",
"type": "String",
- "desc": "vertical | justified (default none)",
+ "desc": "",
+ "memberOf": "",
+ "optvals": [
+ "",
+ "adjust",
+ "align-center",
+ "align-justify",
+ "align-left",
+ "align-right",
+ "arrow-down",
+ "arrow-left",
+ "arrow-right",
+ "arrow-up",
+ "asterisk",
+ "backward",
+ "ban-circle",
+ "barcode",
+ "bell",
+ "bold",
+ "book",
+ "bookmark",
+ "briefcase",
+ "bullhorn",
+ "calendar",
+ "camera",
+ "certificate",
+ "check",
+ "chevron-down",
+ "chevron-left",
+ "chevron-right",
+ "chevron-up",
+ "circle-arrow-down",
+ "circle-arrow-left",
+ "circle-arrow-right",
+ "circle-arrow-up",
+ "cloud",
+ "cloud-download",
+ "cloud-upload",
+ "cog",
+ "collapse-down",
+ "collapse-up",
+ "comment",
+ "compressed",
+ "copyright-mark",
+ "credit-card",
+ "cutlery",
+ "dashboard",
+ "download",
+ "download-alt",
+ "earphone",
+ "edit",
+ "eject",
+ "envelope",
+ "euro",
+ "exclamation-sign",
+ "expand",
+ "export",
+ "eye-close",
+ "eye-open",
+ "facetime-video",
+ "fast-backward",
+ "fast-forward",
+ "file",
+ "film",
+ "filter",
+ "fire",
+ "flag",
+ "flash",
+ "floppy-disk",
+ "floppy-open",
+ "floppy-remove",
+ "floppy-save",
+ "floppy-saved",
+ "folder-close",
+ "folder-open",
+ "font",
+ "forward",
+ "fullscreen",
+ "gbp",
+ "gift",
+ "glass",
+ "globe",
+ "hand-down",
+ "hand-left",
+ "hand-right",
+ "hand-up",
+ "hd-video",
+ "hdd",
+ "header",
+ "headphones",
+ "heart",
+ "heart-empty",
+ "home",
+ "import",
+ "inbox",
+ "indent-left",
+ "indent-right",
+ "info-sign",
+ "italic",
+ "leaf",
+ "link",
+ "list",
+ "list-alt",
+ "lock",
+ "log-in",
+ "log-out",
+ "magnet",
+ "map-marker",
+ "minus",
+ "minus-sign",
+ "move",
+ "music",
+ "new-window",
+ "off",
+ "ok",
+ "ok-circle",
+ "ok-sign",
+ "open",
+ "paperclip",
+ "pause",
+ "pencil",
+ "phone",
+ "phone-alt",
+ "picture",
+ "plane",
+ "play",
+ "play-circle",
+ "plus",
+ "plus-sign",
+ "print",
+ "pushpin",
+ "qrcode",
+ "question-sign",
+ "random",
+ "record",
+ "refresh",
+ "registration-mark",
+ "remove",
+ "remove-circle",
+ "remove-sign",
+ "repeat",
+ "resize-full",
+ "resize-horizontal",
+ "resize-small",
+ "resize-vertical",
+ "retweet",
+ "road",
+ "save",
+ "saved",
+ "screenshot",
+ "sd-video",
+ "search",
+ "send",
+ "share",
+ "share-alt",
+ "shopping-cart",
+ "signal",
+ "sort",
+ "sort-by-alphabet",
+ "sort-by-alphabet-alt",
+ "sort-by-attributes",
+ "sort-by-attributes-alt",
+ "sort-by-order",
+ "sort-by-order-alt",
+ "sound-5-1",
+ "sound-6-1",
+ "sound-7-1",
+ "sound-dolby",
+ "sound-stereo",
+ "star",
+ "star-empty",
+ "stats",
+ "step-backward",
+ "step-forward",
+ "stop",
+ "subtitles",
+ "tag",
+ "tags",
+ "tasks",
+ "text-height",
+ "text-width",
+ "th",
+ "th-large",
+ "th-list",
+ "thumbs-down",
+ "thumbs-up",
+ "time",
+ "tint",
+ "tower",
+ "transfer",
+ "trash",
+ "tree-conifer",
+ "tree-deciduous",
+ "unchecked",
+ "upload",
+ "usd",
+ "user",
+ "volume-down",
+ "volume-off",
+ "volume-up",
+ "warning-sign",
+ "wrench",
+ "zoom-in",
+ "zoom-out"
+ ]
+ },
+ {
+ "name": "badge",
+ "type": "String",
+ "desc": "text for badge",
"memberOf": ""
},
{
- "name": "direction",
+ "name": "theme",
"type": "String",
- "desc": "up | down (default down)",
+ "desc": "default",
"memberOf": ""
},
{
- "name": "toolbar",
+ "name": "inverse",
"type": "Boolean",
- "desc": "false | true",
+ "desc": "",
"memberOf": ""
},
{
- "name": "btn",
+ "name": "toggle",
"type": "Boolean",
- "desc": "true | false",
+ "desc": "",
+ "memberOf": ""
+ },
+ {
+ "name": "ontext",
+ "type": "String",
+ "desc": "text for on toggle state",
+ "memberOf": ""
+ },
+ {
+ "name": "offtext",
+ "type": "String",
+ "desc": "text for off toggle state",
+ "memberOf": ""
+ },
+ {
+ "name": "defaulton",
+ "type": "Boolean",
+ "desc": "",
+ "memberOf": ""
+ },
+ {
+ "name": "preventDefault",
+ "type": "Boolean",
+ "desc": "default true",
+ "memberOf": ""
+ },
+ {
+ "name": "removeClass",
+ "type": "Boolean",
+ "desc": "remove the standard class..",
+ "memberOf": ""
+ },
+ {
+ "name": "target",
+ "type": "String",
+ "desc": "target for a href. (_self|_blank|_parent|_top| other)",
"memberOf": ""
},
{
"type": "function",
"desc": "Fires when the children have been rendered.."
},
+ {
+ "name": "click",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "When a butotn is pressed"
+ },
{
"name": "destroy",
"sig": "function (_self)\n{\n\n}",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is shown."
+ },
+ {
+ "name": "toggle",
+ "sig": "function (e, pressed)\n{\n\n}",
+ "type": "function",
+ "desc": "After the button has been toggles"
}
],
"methods": [
"name": "disable",
"sig": "()",
"type": "function",
- "desc": "Disable this component."
+ "desc": "Disable this button"
},
{
"name": "enable",
"sig": "()",
"type": "function",
- "desc": "Enable this component."
+ "desc": "Enables this button"
},
{
"name": "fireEvent",
"type": "function",
"desc": "If this is a lazy rendering component, render it to its container element."
},
+ {
+ "name": "setActive",
+ "sig": "(Boolean state)",
+ "type": "function",
+ "desc": "sets the active state on/off,"
+ },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
"type": "function",
"desc": "Show a component - removes 'hidden' class"
},
+ {
+ "name": "toggleActive",
+ "sig": "()",
+ "type": "function",
+ "desc": "toggles the current active state"
+ },
{
"name": "tooltipEl",
"sig": "()",
}
]
},
- "Roo.bootstrap.Calendar": {
+ "Roo.bootstrap.ButtonGroup": {
"props": [
{
- "name": "loadMask",
- "type": "Boolean",
- "desc": "default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "name": "size",
+ "type": "String",
+ "desc": "lg | sm | xs (default empty normal)",
+ "memberOf": ""
},
{
- "name": "header",
- "type": "Object",
- "desc": "generate the user specific header of the calendar, default false",
+ "name": "align",
+ "type": "String",
+ "desc": "vertical | justified (default none)",
"memberOf": ""
},
{
- "name": "startDay",
- "type": "Number",
- "desc": "Day index at which the week should begin, 0-based (defaults to 0, which is Sunday)",
+ "name": "direction",
+ "type": "String",
+ "desc": "up | down (default down)",
+ "memberOf": ""
+ },
+ {
+ "name": "toolbar",
+ "type": "Boolean",
+ "desc": "false | true",
+ "memberOf": ""
+ },
+ {
+ "name": "btn",
+ "type": "Boolean",
+ "desc": "true | false",
"memberOf": ""
},
{
"type": "function",
"desc": "Fires after the component is enabled."
},
- {
- "name": "eventclick",
- "sig": "function (_self, )\n{\n\n}",
- "type": "function",
- "desc": "Fires when the mouse click an"
- },
- {
- "name": "evententer",
- "sig": "function (_self, Event)\n{\n\n}",
- "type": "function",
- "desc": "Fires when mouse over an event"
- },
- {
- "name": "eventleave",
- "sig": "function (_self, )\n{\n\n}",
- "type": "function",
- "desc": "Fires when the mouse leaves an"
- },
{
"name": "hide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is hidden."
},
- {
- "name": "monthchange",
- "sig": "function (_self, date)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the displayed month changes"
- },
{
"name": "render",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is rendered."
},
- {
- "name": "select",
- "sig": "function (_self, date)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a date is selected"
- },
+ {
+ "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\n<b>before</b> 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 <b>all</b> 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.bootstrap.Calendar": {
+ "props": [
+ {
+ "name": "loadMask",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "header",
+ "type": "Object",
+ "desc": "generate the user specific header of the calendar, default false",
+ "memberOf": ""
+ },
+ {
+ "name": "startDay",
+ "type": "Number",
+ "desc": "Day index at which the week should begin, 0-based (defaults to 0, which is Sunday)",
+ "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<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "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": "eventclick",
+ "sig": "function (_self, )\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the mouse click an"
+ },
+ {
+ "name": "evententer",
+ "sig": "function (_self, Event)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when mouse over an event"
+ },
+ {
+ "name": "eventleave",
+ "sig": "function (_self, )\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the mouse leaves an"
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "monthchange",
+ "sig": "function (_self, date)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the displayed month changes"
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "select",
+ "sig": "function (_self, date)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a date is selected"
+ },
{
"name": "show",
"sig": "function (_self)\n{\n\n}",
"desc": "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
"memberOf": "Roo.bootstrap.Input"
},
+ {
+ "name": "indicatorpos",
+ "type": "String",
+ "desc": "default left",
+ "memberOf": "Roo.bootstrap.Input",
+ "optvals": [
+ "left",
+ "right"
+ ]
+ },
{
"name": "align",
"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": ""
},
+ {
+ "name": "modalTitle",
+ "type": "String",
+ "desc": "The title of the dialog that pops up on mobile views.",
+ "memberOf": ""
+ },
{
"name": "hiddenName",
"type": "String",
"false"
]
},
+ {
+ "name": "useNativeIOS",
+ "type": "Boolean",
+ "desc": "render it as classic select for ios, not support dynamic load data (default false)",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
{
"name": "triggerClass",
"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.Input"
},
+ {
+ "name": "indicatorpos",
+ "type": "String",
+ "desc": "default left",
+ "memberOf": "Roo.bootstrap.Input",
+ "optvals": [
+ "left",
+ "right"
+ ]
+ },
{
"name": "align",
"type": "String",
"type": "function",
"desc": "Fires when the 'add' icon is pressed (add a listener to enable add button)"
},
+ {
+ "name": "afterremove",
+ "sig": "function (combo)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the remove value from the combobox array"
+ },
{
"name": "beforedestroy",
"sig": "function (_self)\n{\n\n}",
"desc": "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
"memberOf": "Roo.bootstrap.Input"
},
+ {
+ "name": "indicatorpos",
+ "type": "String",
+ "desc": "default left",
+ "memberOf": "Roo.bootstrap.Input",
+ "optvals": [
+ "left",
+ "right"
+ ]
+ },
{
"name": "align",
"type": "String",
"desc": "default 'imageUpload'",
"memberOf": ""
},
+ {
+ "name": "toolTipName",
+ "type": "String",
+ "desc": "default 'filename'",
+ "memberOf": ""
+ },
{
"name": "method",
"type": "String",
}
],
"events": [
+ {
+ "name": "afterupload",
+ "sig": "function (_self, xhr)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire when xhr load exception"
+ },
{
"name": "beforedestroy",
"sig": "function (_self)\n{\n\n}",
}
]
},
- "Roo.bootstrap.DocumentViewer": {
+ "Roo.bootstrap.DocumentSlider": {
"props": [
{
"name": "cls",
"desc": "Fires after the component is shown."
},
{
- "name": "trash",
+ "name": "update",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fire after trash button"
+ "desc": "Fire after update"
}
],
"methods": [
}
]
},
- "Roo.bootstrap.Element": {
+ "Roo.bootstrap.DocumentViewer": {
"props": [
{
- "name": "html",
- "type": "String",
- "desc": "contents of the element",
- "memberOf": ""
- },
- {
- "name": "tag",
- "type": "String",
- "desc": "tag of the element",
- "memberOf": ""
- },
- {
- "name": "cls",
- "type": "String",
- "desc": "class of the element",
- "memberOf": ""
- },
- {
- "name": "preventDefault",
+ "name": "showDownload",
"type": "Boolean",
- "desc": "default false",
+ "desc": "show download button (default true)",
"memberOf": "",
"optvals": [
"true",
]
},
{
- "name": "clickable",
+ "name": "showTrash",
"type": "Boolean",
- "desc": "default false",
+ "desc": "show trash button (default true)",
"memberOf": "",
"optvals": [
"true",
"false"
]
},
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
+ },
{
"name": "style",
"type": "String",
},
{
"name": "click",
- "sig": "function (_self, e)\n{\n\n}",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "When a element is chick"
+ "desc": "Fire after click"
},
{
"name": "destroy",
"type": "function",
"desc": "Fires after the component is disabled."
},
+ {
+ "name": "download",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire after download button"
+ },
{
"name": "enable",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is hidden."
},
+ {
+ "name": "initial",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire after initEvent"
+ },
{
"name": "render",
"sig": "function (_self)\n{\n\n}",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is shown."
+ },
+ {
+ "name": "trash",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire after trash button"
}
],
"methods": [
}
]
},
- "Roo.bootstrap.FieldLabel": {
+ "Roo.bootstrap.Element": {
"props": [
{
"name": "html",
{
"name": "tag",
"type": "String",
- "desc": "tag of the element default label",
+ "desc": "tag of the element",
"memberOf": ""
},
{
"memberOf": ""
},
{
- "name": "target",
- "type": "String",
- "desc": "label target",
- "memberOf": ""
- },
- {
- "name": "allowBlank",
+ "name": "preventDefault",
"type": "Boolean",
- "desc": "target allowBlank default true",
+ "desc": "default false",
"memberOf": "",
"optvals": [
"true",
]
},
{
- "name": "invalidClass",
- "type": "String",
- "desc": "default \"text-danger fa fa-lg fa-exclamation-triangle\"",
- "memberOf": ""
- },
- {
- "name": "validClass",
- "type": "String",
- "desc": "default \"text-success fa fa-lg fa-check\"",
- "memberOf": ""
- },
- {
- "name": "iconTooltip",
- "type": "String",
- "desc": "default \"This field is required\"",
- "memberOf": ""
+ "name": "clickable",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
"name": "style",
"type": "function",
"desc": "Fires when the children have been rendered.."
},
+ {
+ "name": "click",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "When a element is chick"
+ },
{
"name": "destroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is hidden."
},
- {
- "name": "invalid",
- "sig": "function (_self, msg)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the field has been marked as invalid."
- },
{
"name": "render",
"sig": "function (_self)\n{\n\n}",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is shown."
- },
- {
- "name": "valid",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the field has been validated with no errors."
}
],
"methods": [
"type": "function",
"desc": "Try to focus this component."
},
- {
- "name": "get",
- "sig": "(string target)",
- "type": "function",
- "desc": "fetch a FieldLabel Group based on the target"
- },
{
"name": "getChildContainer",
"sig": "()",
"type": "function",
"desc": "Returns true if this component is visible."
},
- {
- "name": "markInvalid",
- "sig": "(String msg)",
- "type": "function",
- "desc": "Mark this field as invalid"
- },
- {
- "name": "markValid",
- "sig": "()",
- "type": "function",
- "desc": "Mark this field as valid"
- },
{
"name": "on",
"sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
"desc": "Removes all listeners for this object"
},
- {
- "name": "register",
- "sig": "(Roo.bootstrap.FieldLabel the)",
- "type": "function",
- "desc": "register a FieldLabel Group"
- },
{
"name": "releaseCapture",
"sig": "(Observable o)",
}
]
},
- "Roo.bootstrap.Form": {
+ "Roo.bootstrap.FieldLabel": {
"props": [
{
- "name": "method",
+ "name": "html",
"type": "String",
- "desc": "GET | POST (default POST)",
+ "desc": "contents of the element",
"memberOf": ""
},
{
- "name": "labelAlign",
+ "name": "tag",
"type": "String",
- "desc": "top | left (default top)",
+ "desc": "tag of the element default label",
"memberOf": ""
},
{
- "name": "align",
+ "name": "cls",
"type": "String",
- "desc": "left | right - for navbars",
- "memberOf": ""
- },
- {
- "name": "loadMask",
- "type": "Boolean",
- "desc": "load mask when submit (default true)",
+ "desc": "class of the element",
"memberOf": ""
},
{
- "name": "url",
+ "name": "target",
"type": "String",
- "desc": "The URL to use for form actions if one isn't supplied in the action options.",
+ "desc": "label target",
"memberOf": ""
},
{
- "name": "fileUpload",
+ "name": "allowBlank",
"type": "Boolean",
- "desc": "Set to true if this form is a file upload.",
- "memberOf": ""
+ "desc": "target allowBlank default true",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
- "name": "baseParams",
- "type": "Object",
- "desc": "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
+ "name": "invalidClass",
+ "type": "String",
+ "desc": "default \"text-danger fa fa-lg fa-exclamation-triangle\"",
"memberOf": ""
},
{
- "name": "timeout",
- "type": "Number",
- "desc": "Timeout for form actions in seconds (default is 30 seconds).",
+ "name": "validClass",
+ "type": "String",
+ "desc": "default \"text-success fa fa-lg fa-check\"",
"memberOf": ""
},
{
- "name": "cls",
+ "name": "iconTooltip",
"type": "String",
- "desc": "css class",
- "memberOf": "Roo.bootstrap.Component"
+ "desc": "default \"This field is required\"",
+ "memberOf": ""
},
{
"name": "style",
}
],
"events": [
- {
- "name": "actioncomplete",
- "sig": "function (_self, action)\n{\n\n}",
- "type": "function",
- "desc": "Fires when an action is completed."
- },
- {
- "name": "actionfailed",
- "sig": "function (_self, action)\n{\n\n}",
- "type": "function",
- "desc": "Fires when an action fails."
- },
- {
- "name": "beforeaction",
- "sig": "function (_self, action)\n{\n\n}",
- "type": "function",
- "desc": "Fires before any action is performed. Return false to cancel the action."
- },
{
"name": "beforedestroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires when the children have been rendered.."
},
- {
- "name": "clientvalidation",
- "sig": "function (_self, valid)\n{\n\n}",
- "type": "function",
- "desc": "If the monitorValid config option is true, this event fires repetitively to notify of valid state"
- },
{
"name": "destroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is hidden."
},
+ {
+ "name": "invalid",
+ "sig": "function (_self, msg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been marked as invalid."
+ },
{
"name": "render",
"sig": "function (_self)\n{\n\n}",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is shown."
+ },
+ {
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been validated with no errors."
}
],
"methods": [
"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."
},
- {
- "name": "clearInvalid",
- "sig": "()",
- "type": "function",
- "desc": "Clears all invalid messages in this form."
- },
{
"name": "destroy",
"sig": "()",
"type": "function",
"desc": "Disable this component."
},
- {
- "name": "doAction",
- "sig": "(String actionName, Object options)",
- "type": "function",
- "desc": "Performs a predefined action (submit or load) or custom actions you define on this form."
- },
{
"name": "enable",
"sig": "()",
"type": "function",
"desc": "Enable this component."
},
- {
- "name": "findField",
- "sig": "(String id)",
- "type": "function",
- "desc": "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName"
- },
{
"name": "fireEvent",
"sig": "(String eventName, Object... args)",
"type": "function",
"desc": "Try to focus this component."
},
+ {
+ "name": "get",
+ "sig": "(string target)",
+ "type": "function",
+ "desc": "fetch a FieldLabel Group based on the target"
+ },
{
"name": "getChildContainer",
"sig": "()",
"type": "function",
"desc": "Returns the underlying {@link Roo.Element}."
},
- {
- "name": "getFieldValues",
- "sig": "()",
- "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."
- },
{
"name": "getId",
"sig": "()",
"type": "function",
"desc": "Returns the id of this component."
},
- {
- "name": "getValues",
- "sig": "(Boolean asString)",
- "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."
- },
{
"name": "hasListener",
"sig": "(String eventName)",
"desc": "Initialize Events for the element"
},
{
- "name": "isDirty",
+ "name": "isVisible",
"sig": "()",
"type": "function",
- "desc": "Returns true if any fields in this form have changed since their original load."
+ "desc": "Returns true if this component is visible."
},
{
- "name": "isValid",
- "sig": "()",
+ "name": "markInvalid",
+ "sig": "(String msg)",
"type": "function",
- "desc": "Returns true if client-side validation on the form is successful."
+ "desc": "Mark this field as invalid"
},
{
- "name": "isVisible",
+ "name": "markValid",
"sig": "()",
"type": "function",
- "desc": "Returns true if this component is visible."
- },
- {
- "name": "markInvalid",
- "sig": "(Array/Object errors)",
- "type": "function",
- "desc": "Mark fields in this form invalid in bulk."
+ "desc": "Mark this field as valid"
},
{
"name": "on",
"type": "function",
"desc": "Removes all listeners for this object"
},
+ {
+ "name": "register",
+ "sig": "(Roo.bootstrap.FieldLabel the)",
+ "type": "function",
+ "desc": "register a FieldLabel Group"
+ },
{
"name": "releaseCapture",
"sig": "(Observable o)",
"type": "function",
"desc": "If this is a lazy rendering component, render it to its container element."
},
- {
- "name": "reset",
- "sig": "()",
- "type": "function",
- "desc": "Resets this form."
- },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
"type": "function",
"desc": "Convenience function for setting disabled/enabled by boolean."
},
- {
- "name": "setValues",
- "sig": "(Array/Object values)",
- "type": "function",
- "desc": "Set values for fields in this form in bulk."
- },
{
"name": "setVisible",
"sig": "(Boolean visible)",
}
]
},
- "Roo.bootstrap.Graph": {
+ "Roo.bootstrap.Form": {
"props": [
{
- "name": "graphtype",
+ "name": "method",
"type": "String",
- "desc": "bar | vbar | pie",
+ "desc": "GET | POST (default POST)",
"memberOf": ""
},
{
- "name": "g_x",
- "type": "number",
- "desc": "coodinator | centre x (pie)",
+ "name": "labelAlign",
+ "type": "String",
+ "desc": "top | left (default top)",
"memberOf": ""
},
{
- "name": "g_y",
- "type": "number",
- "desc": "coodinator | centre y (pie)",
+ "name": "align",
+ "type": "String",
+ "desc": "left | right - for navbars",
"memberOf": ""
},
{
- "name": "g_r",
- "type": "number",
- "desc": "radius (pie)",
+ "name": "loadMask",
+ "type": "Boolean",
+ "desc": "load mask when submit (default true)",
"memberOf": ""
},
{
- "name": "g_height",
- "type": "number",
- "desc": "height of the chart (respected by all elements in the set)",
+ "name": "url",
+ "type": "String",
+ "desc": "The URL to use for form actions if one isn't supplied in the action options.",
"memberOf": ""
},
{
- "name": "g_width",
- "type": "number",
- "desc": "width of the chart (respected by all elements in the set)",
+ "name": "fileUpload",
+ "type": "Boolean",
+ "desc": "Set to true if this form is a file upload.",
"memberOf": ""
},
{
- "name": "title",
+ "name": "baseParams",
"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 }",
+ "desc": "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
+ "memberOf": ""
+ },
+ {
+ "name": "timeout",
+ "type": "Number",
+ "desc": "Timeout for form actions in seconds (default is 30 seconds).",
"memberOf": ""
},
{
}
],
"events": [
+ {
+ "name": "actioncomplete",
+ "sig": "function (_self, action)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when an action is completed."
+ },
+ {
+ "name": "actionfailed",
+ "sig": "function (_self, action)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when an action fails."
+ },
+ {
+ "name": "beforeaction",
+ "sig": "function (_self, action)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before any action is performed. Return false to cancel the action."
+ },
{
"name": "beforedestroy",
"sig": "function (_self)\n{\n\n}",
"desc": "Fires when the children have been rendered.."
},
{
- "name": "click",
- "sig": "function (e)\n{\n\n}",
+ "name": "clientvalidation",
+ "sig": "function (_self, valid)\n{\n\n}",
"type": "function",
- "desc": "The img click event for the img."
+ "desc": "If the monitorValid config option is true, this event fires repetitively to notify of valid state"
},
{
"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."
},
+ {
+ "name": "clearInvalid",
+ "sig": "()",
+ "type": "function",
+ "desc": "Clears all invalid messages in this form."
+ },
{
"name": "destroy",
"sig": "()",
"type": "function",
"desc": "Disable this component."
},
+ {
+ "name": "doAction",
+ "sig": "(String actionName, Object options)",
+ "type": "function",
+ "desc": "Performs a predefined action (submit or load) or custom actions you define on this form."
+ },
{
"name": "enable",
"sig": "()",
"type": "function",
"desc": "Enable this component."
},
+ {
+ "name": "findField",
+ "sig": "(String id)",
+ "type": "function",
+ "desc": "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName"
+ },
{
"name": "fireEvent",
"sig": "(String eventName, Object... args)",
"type": "function",
"desc": "Returns the underlying {@link Roo.Element}."
},
+ {
+ "name": "getFieldValues",
+ "sig": "()",
+ "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."
+ },
{
"name": "getId",
"sig": "()",
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getValues",
+ "sig": "(Boolean asString)",
+ "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."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"type": "function",
"desc": "Initialize Events for the element"
},
+ {
+ "name": "isDirty",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if any fields in this form have changed since their original load."
+ },
+ {
+ "name": "isValid",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if client-side validation on the form is successful."
+ },
{
"name": "isVisible",
"sig": "()",
"type": "function",
"desc": "Returns true if this component is visible."
},
+ {
+ "name": "markInvalid",
+ "sig": "(Array/Object errors)",
+ "type": "function",
+ "desc": "Mark fields in this form invalid in bulk."
+ },
{
"name": "on",
"sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
"desc": "If this is a lazy rendering component, render it to its container element."
},
+ {
+ "name": "reset",
+ "sig": "()",
+ "type": "function",
+ "desc": "Resets this form."
+ },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
"type": "function",
"desc": "Convenience function for setting disabled/enabled by boolean."
},
+ {
+ "name": "setValues",
+ "sig": "(Array/Object values)",
+ "type": "function",
+ "desc": "Set values for fields in this form in bulk."
+ },
{
"name": "setVisible",
"sig": "(Boolean visible)",
}
]
},
- "Roo.bootstrap.Header": {
+ "Roo.bootstrap.Graph": {
"props": [
{
- "name": "html",
+ "name": "graphtype",
"type": "String",
- "desc": "content of header",
+ "desc": "bar | vbar | pie",
"memberOf": ""
},
{
- "name": "level",
- "type": "Number",
- "desc": "default 1",
- "memberOf": "",
- "optvals": [
- "1",
- "2",
- "3",
- "4",
- "5",
- "6"
- ]
+ "name": "g_x",
+ "type": "number",
+ "desc": "coodinator | centre x (pie)",
+ "memberOf": ""
+ },
+ {
+ "name": "g_y",
+ "type": "number",
+ "desc": "coodinator | centre y (pie)",
+ "memberOf": ""
+ },
+ {
+ "name": "g_r",
+ "type": "number",
+ "desc": "radius (pie)",
+ "memberOf": ""
+ },
+ {
+ "name": "g_height",
+ "type": "number",
+ "desc": "height of the chart (respected by all elements in the set)",
+ "memberOf": ""
+ },
+ {
+ "name": "g_width",
+ "type": "number",
+ "desc": "width of the chart (respected by all elements in the set)",
+ "memberOf": ""
+ },
+ {
+ "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": ""
+ },
+ {
+ "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<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "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": "click",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The img click event for the img."
+ },
+ {
+ "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\n<b>before</b> 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 <b>all</b> 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.bootstrap.Header": {
+ "props": [
+ {
+ "name": "html",
+ "type": "String",
+ "desc": "content of header",
+ "memberOf": ""
+ },
+ {
+ "name": "level",
+ "type": "Number",
+ "desc": "default 1",
+ "memberOf": "",
+ "optvals": [
+ "1",
+ "2",
+ "3",
+ "4",
+ "5",
+ "6"
+ ]
},
{
"name": "cls",
"desc": "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
"memberOf": "Roo.bootstrap.Input"
},
+ {
+ "name": "indicatorpos",
+ "type": "String",
+ "desc": "default left",
+ "memberOf": "Roo.bootstrap.Input",
+ "optvals": [
+ "left",
+ "right"
+ ]
+ },
{
"name": "align",
"type": "String",
"type": "function",
"desc": "Convenience function for setting disabled/enabled by boolean."
},
+ {
+ "name": "setSrc",
+ "sig": "(String url)",
+ "type": "function",
+ "desc": "Sets the url of the image - used to update it"
+ },
{
"name": "setVisible",
"sig": "(Boolean visible)",
"desc": "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
"memberOf": ""
},
+ {
+ "name": "indicatorpos",
+ "type": "String",
+ "desc": "default left",
+ "memberOf": "",
+ "optvals": [
+ "left",
+ "right"
+ ]
+ },
{
"name": "align",
"type": "String",
"Roo.bootstrap.LayoutMasonry": {
"props": [
{
- "name": "isFitWidth",
- "type": "Boolean",
- "desc": "- resize the width..",
- "memberOf": ""
- },
- {
- "name": "isOriginLeft",
+ "name": "isLayoutInstant",
"type": "Boolean",
- "desc": "= left align?",
+ "desc": "= no animation?",
"memberOf": ""
},
{
- "name": "isOriginTop",
- "type": "Boolean",
- "desc": "= top align?",
+ "name": "boxWidth",
+ "type": "Number",
+ "desc": "width of the columns",
"memberOf": ""
},
{
- "name": "isLayoutInstant",
- "type": "Boolean",
- "desc": "= no animation?",
+ "name": "boxHeight",
+ "type": "Number",
+ "desc": "- 0 for square, or fix it at a certian height",
"memberOf": ""
},
{
- "name": "isResizingContainer",
- "type": "Boolean",
- "desc": "= not sure if this is used..",
+ "name": "padWidth",
+ "type": "Number",
+ "desc": "padding below box..",
"memberOf": ""
},
{
- "name": "columnWidth",
+ "name": "gutter",
"type": "Number",
- "desc": "width of the columns",
+ "desc": "gutter width..",
"memberOf": ""
},
{
- "name": "padHeight",
+ "name": "maxCols",
"type": "Number",
- "desc": "padding below box..",
+ "desc": "maximum number of columns",
"memberOf": ""
},
{
"desc": "defalut true",
"memberOf": ""
},
+ {
+ "name": "isHorizontal",
+ "type": "Boolean",
+ "desc": "defalut false",
+ "memberOf": ""
+ },
+ {
+ "name": "alternativePadWidth",
+ "type": "Number",
+ "desc": "padding below box..",
+ "memberOf": ""
+ },
{
"name": "cls",
"type": "String",
}
]
},
- "Roo.bootstrap.Link": {
+ "Roo.bootstrap.LayoutMasonryAuto": {
"props": [
{
- "name": "alt",
- "type": "String",
- "desc": "image alternative text",
+ "name": "isFitWidth",
+ "type": "Boolean",
+ "desc": "- resize the width..",
"memberOf": ""
},
{
- "name": "href",
- "type": "String",
- "desc": "a tag href",
+ "name": "isOriginLeft",
+ "type": "Boolean",
+ "desc": "= left align?",
"memberOf": ""
},
{
- "name": "target",
- "type": "String",
- "desc": "target for a href.",
- "memberOf": "",
- "optvals": [
- "_self",
- "_blank",
- "_parent",
- "_top"
- ]
+ "name": "isOriginTop",
+ "type": "Boolean",
+ "desc": "= top align?",
+ "memberOf": ""
},
{
- "name": "html",
- "type": "String",
- "desc": "the content of the link.",
+ "name": "isLayoutInstant",
+ "type": "Boolean",
+ "desc": "= no animation?",
"memberOf": ""
},
{
- "name": "anchor",
- "type": "String",
- "desc": "name for the anchor link",
+ "name": "isResizingContainer",
+ "type": "Boolean",
+ "desc": "= not sure if this is used..",
"memberOf": ""
},
{
- "name": "preventDefault",
+ "name": "columnWidth",
+ "type": "Number",
+ "desc": "width of the columns",
+ "memberOf": ""
+ },
+ {
+ "name": "maxCols",
+ "type": "Number",
+ "desc": "maximum number of columns",
+ "memberOf": ""
+ },
+ {
+ "name": "padHeight",
+ "type": "Number",
+ "desc": "padding below box..",
+ "memberOf": ""
+ },
+ {
+ "name": "isAutoInitial",
"type": "Boolean",
- "desc": "default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "desc": "defalut true",
+ "memberOf": ""
},
{
"name": "cls",
"type": "function",
"desc": "Fires when the children have been rendered.."
},
- {
- "name": "click",
- "sig": "function (e)\n{\n\n}",
- "type": "function",
- "desc": "The img click event for the img."
- },
{
"name": "destroy",
"sig": "function (_self)\n{\n\n}",
}
]
},
- "Roo.bootstrap.LocationPicker": {
+ "Roo.bootstrap.Link": {
"props": [
{
- "name": "latitude",
- "type": "Number",
- "desc": "Position when init default 0",
- "memberOf": ""
- },
- {
- "name": "longitude",
- "type": "Number",
- "desc": "Position when init default 0",
- "memberOf": ""
- },
- {
- "name": "zoom",
- "type": "Number",
- "desc": "default 15",
- "memberOf": ""
- },
- {
- "name": "mapTypeId",
+ "name": "alt",
"type": "String",
- "desc": "default google.maps.MapTypeId.ROADMAP",
- "memberOf": ""
- },
- {
- "name": "mapTypeControl",
- "type": "Boolean",
- "desc": "default false",
- "memberOf": ""
- },
- {
- "name": "disableDoubleClickZoom",
- "type": "Boolean",
- "desc": "default false",
+ "desc": "image alternative text",
"memberOf": ""
},
{
- "name": "scrollwheel",
- "type": "Boolean",
- "desc": "default true",
+ "name": "href",
+ "type": "String",
+ "desc": "a tag href",
"memberOf": ""
},
{
- "name": "streetViewControl",
- "type": "Boolean",
- "desc": "default false",
- "memberOf": ""
+ "name": "target",
+ "type": "String",
+ "desc": "target for a href.",
+ "memberOf": "",
+ "optvals": [
+ "_self",
+ "_blank",
+ "_parent",
+ "_top"
+ ]
},
{
- "name": "radius",
- "type": "Number",
- "desc": "default 0",
+ "name": "html",
+ "type": "String",
+ "desc": "the content of the link.",
"memberOf": ""
},
{
- "name": "locationName",
+ "name": "anchor",
"type": "String",
- "desc": "",
+ "desc": "name for the anchor link",
"memberOf": ""
},
{
- "name": "draggable",
- "type": "Boolean",
- "desc": "default true",
+ "name": "fa",
+ "type": "String",
+ "desc": "- favicon",
"memberOf": ""
},
{
- "name": "enableAutocomplete",
+ "name": "preventDefault",
"type": "Boolean",
"desc": "default false",
- "memberOf": ""
- },
- {
- "name": "enableReverseGeocode",
- "type": "Boolean",
- "desc": "default true",
- "memberOf": ""
- },
- {
- "name": "markerTitle",
- "type": "String",
- "desc": "",
- "memberOf": ""
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
"name": "cls",
}
],
"events": [
- {
- "name": "OverlayViewDraw",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when OverlayView Draw"
- },
- {
- "name": "OverlayViewHide",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when OverlayView Draw"
- },
- {
- "name": "OverlayViewOnAdd",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when OverlayView Draw"
- },
- {
- "name": "OverlayViewOnRemove",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when OverlayView Draw"
- },
- {
- "name": "OverlayViewShow",
- "sig": "function (_self, cpx)\n{\n\n}",
- "type": "function",
- "desc": "Fires when OverlayView Draw"
- },
{
"name": "beforedestroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires when the children have been rendered.."
},
+ {
+ "name": "click",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The img click event for the img."
+ },
{
"name": "destroy",
"sig": "function (_self)\n{\n\n}",
"name": "hide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the map hide."
- },
- {
- "name": "initial",
- "sig": "function (_self, location)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the picker initialized."
- },
- {
- "name": "loadexception",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when load google lib failed."
- },
- {
- "name": "mapClick",
- "sig": "function (_self, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires when click the map."
- },
- {
- "name": "mapRightClick",
- "sig": "function (_self, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires when right click the map."
- },
- {
- "name": "markerClick",
- "sig": "function (_self, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires when click the marker."
- },
- {
- "name": "markerRightClick",
- "sig": "function (_self, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires when right click the marker."
- },
- {
- "name": "positionchanged",
- "sig": "function (_self, location)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the picker position changed."
+ "desc": "Fires after the component is hidden."
},
{
"name": "render",
"type": "function",
"desc": "Fires after the component is rendered."
},
- {
- "name": "resize",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the map resize."
- },
{
"name": "show",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the map show."
+ "desc": "Fires after the component is shown."
}
],
"methods": [
}
]
},
- "Roo.bootstrap.Menu": {
+ "Roo.bootstrap.LocationPicker": {
"props": [
{
- "name": "type",
+ "name": "latitude",
+ "type": "Number",
+ "desc": "Position when init default 0",
+ "memberOf": ""
+ },
+ {
+ "name": "longitude",
+ "type": "Number",
+ "desc": "Position when init default 0",
+ "memberOf": ""
+ },
+ {
+ "name": "zoom",
+ "type": "Number",
+ "desc": "default 15",
+ "memberOf": ""
+ },
+ {
+ "name": "mapTypeId",
"type": "String",
- "desc": "type of menu",
- "memberOf": "",
- "optvals": [
- "dropdown",
- "treeview",
- "submenu"
- ]
+ "desc": "default google.maps.MapTypeId.ROADMAP",
+ "memberOf": ""
},
{
- "name": "registerMenu",
+ "name": "mapTypeControl",
"type": "Boolean",
- "desc": "True (default) - means that clicking on screen etc. hides it.",
+ "desc": "default false",
+ "memberOf": ""
+ },
+ {
+ "name": "disableDoubleClickZoom",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": ""
+ },
+ {
+ "name": "scrollwheel",
+ "type": "Boolean",
+ "desc": "default true",
+ "memberOf": ""
+ },
+ {
+ "name": "streetViewControl",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": ""
+ },
+ {
+ "name": "radius",
+ "type": "Number",
+ "desc": "default 0",
+ "memberOf": ""
+ },
+ {
+ "name": "locationName",
+ "type": "String",
+ "desc": "",
+ "memberOf": ""
+ },
+ {
+ "name": "draggable",
+ "type": "Boolean",
+ "desc": "default true",
+ "memberOf": ""
+ },
+ {
+ "name": "enableAutocomplete",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": ""
+ },
+ {
+ "name": "enableReverseGeocode",
+ "type": "Boolean",
+ "desc": "default true",
+ "memberOf": ""
+ },
+ {
+ "name": "markerTitle",
+ "type": "String",
+ "desc": "",
"memberOf": ""
},
{
}
],
"events": [
+ {
+ "name": "OverlayViewDraw",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when OverlayView Draw"
+ },
+ {
+ "name": "OverlayViewHide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when OverlayView Draw"
+ },
+ {
+ "name": "OverlayViewOnAdd",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when OverlayView Draw"
+ },
+ {
+ "name": "OverlayViewOnRemove",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when OverlayView Draw"
+ },
+ {
+ "name": "OverlayViewShow",
+ "sig": "function (_self, cpx)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when OverlayView Draw"
+ },
{
"name": "beforedestroy",
"sig": "function (_self)\n{\n\n}",
"name": "beforehide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires before this menu is hidden"
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
},
{
"name": "beforerender",
"name": "beforeshow",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires before this menu is displayed"
+ "desc": "Fires before the component is shown. Return false to stop the show."
},
{
"name": "childrenrendered",
"type": "function",
"desc": "Fires when the children have been rendered.."
},
- {
- "name": "click",
- "sig": "function (_self, menuItem, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires when this menu is clicked (or when the enter key is pressed while it is active)"
- },
{
"name": "destroy",
"sig": "function (_self)\n{\n\n}",
"name": "hide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after this menu is hidden"
+ "desc": "Fires when the map hide."
},
{
- "name": "itemclick",
- "sig": "function (baseItem, e)\n{\n\n}",
+ "name": "initial",
+ "sig": "function (_self, location)\n{\n\n}",
"type": "function",
- "desc": "Fires when a menu item contained in this menu is clicked"
+ "desc": "Fires when the picker initialized."
},
{
- "name": "mouseout",
- "sig": "function (_self, e, menuItem)\n{\n\n}",
+ "name": "loadexception",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the mouse exits this menu"
+ "desc": "Fires when load google lib failed."
},
{
- "name": "mouseover",
- "sig": "function (_self, e, menuItem)\n{\n\n}",
+ "name": "mapClick",
+ "sig": "function (_self, e)\n{\n\n}",
"type": "function",
- "desc": "Fires when the mouse is hovering over this menu"
+ "desc": "Fires when click the map."
+ },
+ {
+ "name": "mapRightClick",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when right click the map."
+ },
+ {
+ "name": "markerClick",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when click the marker."
+ },
+ {
+ "name": "markerRightClick",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when right click the marker."
+ },
+ {
+ "name": "positionchanged",
+ "sig": "function (_self, location)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the picker position changed."
},
{
"name": "render",
"type": "function",
"desc": "Fires after the component is rendered."
},
+ {
+ "name": "resize",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the map resize."
+ },
{
"name": "show",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after this menu is displayed"
+ "desc": "Fires when the map show."
}
],
"methods": [
},
{
"name": "hide",
- "sig": "(Boolean deep)",
+ "sig": "()",
"type": "function",
- "desc": "Hides this menu and optionally all parent menus"
+ "desc": "Hide a component - adds 'hidden' class"
},
{
"name": "initEvents",
},
{
"name": "show",
- "sig": "(String/HTMLElement/Roo.Element element, String position, Roo.menu.Menu parentMenu)",
- "type": "function",
- "desc": "Displays this menu relative to another element"
- },
- {
- "name": "showAt",
- "sig": "(Array xyPosition, Roo.menu.Menu parentMenu)",
+ "sig": "()",
"type": "function",
- "desc": "Displays this menu at a specific xy position"
+ "desc": "Show a component - removes 'hidden' class"
},
{
"name": "tooltipEl",
}
]
},
- "Roo.bootstrap.MenuItem": {
+ "Roo.bootstrap.MasonryBrick": {
"props": [
+ {
+ "name": "title",
+ "type": "String",
+ "desc": "",
+ "memberOf": ""
+ },
{
"name": "html",
"type": "String",
- "desc": "the menu label",
+ "desc": "",
+ "memberOf": ""
+ },
+ {
+ "name": "bgimage",
+ "type": "String",
+ "desc": "",
+ "memberOf": ""
+ },
+ {
+ "name": "videourl",
+ "type": "String",
+ "desc": "",
+ "memberOf": ""
+ },
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "",
"memberOf": ""
},
{
"name": "href",
"type": "String",
- "desc": "the link",
+ "desc": "",
"memberOf": ""
},
{
- "name": "preventDefault",
- "type": "Boolean",
- "desc": "default true",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "name": "(xs|sm|md|md-left|md-right|tall|wide)",
+ "type": "String",
+ "desc": "size",
+ "memberOf": ""
},
{
- "name": "isContainer",
+ "name": "(center|bottom)",
+ "type": "String",
+ "desc": "placetitle",
+ "memberOf": ""
+ },
+ {
+ "name": "isFitContainer",
"type": "Boolean",
- "desc": "default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "desc": "defalut true",
+ "memberOf": ""
},
{
- "name": "cls",
- "type": "String",
- "desc": "css class",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "preventDefault",
+ "type": "Boolean",
+ "desc": "defalut false",
+ "memberOf": ""
},
{
"name": "style",
"name": "click",
"sig": "function (_self, e)\n{\n\n}",
"type": "function",
- "desc": "The raw click event for the entire grid."
+ "desc": "When a MasonryBrick is clcik"
},
{
"name": "destroy",
}
]
},
- "Roo.bootstrap.MenuMgr": {
- "props": [],
- "events": [],
- "methods": [
+ "Roo.bootstrap.Menu": {
+ "props": [
{
- "name": "get",
- "sig": "(String/Object menu)",
- "type": "function",
- "desc": "Returns a {@link Roo.menu.Menu} object"
+ "name": "type",
+ "type": "String",
+ "desc": "type of menu",
+ "memberOf": "",
+ "optvals": [
+ "dropdown",
+ "treeview",
+ "submenu"
+ ]
},
{
- "name": "hideAll",
- "sig": "()",
- "type": "function",
- "desc": "Hides all menus that are currently visible"
- }
- ]
- },
- "Roo.bootstrap.MenuSeparator": {
- "props": [
+ "name": "hidden",
+ "type": "bool",
+ "desc": "if the menu should be hidden when rendered.",
+ "memberOf": ""
+ },
+ {
+ "name": "stopEvent",
+ "type": "bool",
+ "desc": "Stop event after trigger press (default true)",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "isLink",
+ "type": "bool",
+ "desc": "the menu has link disable auto expand and collaspe (default false)",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "registerMenu",
+ "type": "Boolean",
+ "desc": "True (default) - means that clicking on screen etc. hides it.",
+ "memberOf": ""
+ },
{
"name": "cls",
"type": "String",
"name": "beforehide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires before the component is hidden. Return false to stop the hide."
+ "desc": "Fires before this menu is hidden"
},
{
"name": "beforerender",
"name": "beforeshow",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires before the component is shown. Return false to stop the show."
+ "desc": "Fires before this menu is displayed"
},
{
"name": "childrenrendered",
"type": "function",
"desc": "Fires when the children have been rendered.."
},
+ {
+ "name": "click",
+ "sig": "function (_self, menuItem, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this menu is clicked (or when the enter key is pressed while it is active)"
+ },
{
"name": "destroy",
"sig": "function (_self)\n{\n\n}",
"name": "hide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is hidden."
+ "desc": "Fires after this menu is hidden"
+ },
+ {
+ "name": "itemclick",
+ "sig": "function (baseItem, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a menu item contained in this menu is clicked"
+ },
+ {
+ "name": "mouseout",
+ "sig": "function (_self, e, menuItem)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the mouse exits this menu"
+ },
+ {
+ "name": "mouseover",
+ "sig": "function (_self, e, menuItem)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the mouse is hovering over this menu"
},
{
"name": "render",
"name": "show",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is shown."
+ "desc": "Fires after this menu is displayed"
}
],
"methods": [
},
{
"name": "hide",
- "sig": "()",
+ "sig": "(Boolean deep)",
"type": "function",
- "desc": "Hide a component - adds 'hidden' class"
+ "desc": "Hides this menu and optionally all parent menus"
},
{
"name": "initEvents",
},
{
"name": "show",
- "sig": "()",
+ "sig": "(String/HTMLElement/Roo.Element element, String position, Roo.menu.Menu parentMenu)",
"type": "function",
- "desc": "Show a component - removes 'hidden' class"
+ "desc": "Displays this menu relative to another element"
+ },
+ {
+ "name": "showAt",
+ "sig": "(Array xyPosition, Roo.menu.Menu parentMenu)",
+ "type": "function",
+ "desc": "Displays this menu at a specific xy position"
},
{
"name": "tooltipEl",
}
]
},
- "Roo.bootstrap.MessageBar": {
+ "Roo.bootstrap.MenuItem": {
"props": [
{
"name": "html",
"type": "String",
- "desc": "contents of the MessageBar",
+ "desc": "the menu label",
"memberOf": ""
},
{
- "name": "weight",
+ "name": "href",
"type": "String",
- "desc": "default info",
- "memberOf": "",
- "optvals": [
- "info",
- "success",
- "warning",
- "danger"
- ]
+ "desc": "the link",
+ "memberOf": ""
},
{
- "name": "beforeClass",
- "type": "String",
- "desc": "insert the bar before the given class",
+ "name": "preventDefault",
+ "type": "Boolean",
+ "desc": "do not trigger A href on clicks (default false).",
"memberOf": ""
},
{
- "name": "closable",
+ "name": "isContainer",
"type": "Boolean",
- "desc": "default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "desc": "is it a container - just returns a drop down item..",
+ "memberOf": ""
},
{
- "name": "fixed",
+ "name": "active",
"type": "Boolean",
- "desc": "default false, fix the bar at the top",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "desc": "used on sidebars to highlight active itesm",
+ "memberOf": ""
+ },
+ {
+ "name": "fa",
+ "type": "String",
+ "desc": "favicon to show on left of menu item.",
+ "memberOf": ""
+ },
+ {
+ "name": "menu",
+ "type": "Roo.bootsrap.Menu",
+ "desc": "the child menu.",
+ "memberOf": ""
},
{
"name": "cls",
"type": "function",
"desc": "Fires when the children have been rendered.."
},
+ {
+ "name": "click",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw click event for the entire grid."
+ },
{
"name": "destroy",
"sig": "function (_self)\n{\n\n}",
}
]
},
- "Roo.bootstrap.MessageBox": {
+ "Roo.bootstrap.MenuMgr": {
"props": [],
"events": [],
"methods": [
{
- "name": "alert",
- "sig": "(String title, String msg, Function fn, Object scope)",
+ "name": "get",
+ "sig": "(String/Object menu)",
"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)."
+ "desc": "Returns a {@link Roo.menu.Menu} object"
},
{
- "name": "confirm",
- "sig": "(String title, String msg, Function fn, Object scope)",
+ "name": "hideAll",
+ "sig": "()",
"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)."
+ "desc": "Hides all menus that are currently visible"
+ }
+ ]
+ },
+ "Roo.bootstrap.MenuSeparator": {
+ "props": [
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "getDialog",
+ "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<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "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\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire."
+ },
+ {
+ "name": "destroy",
"sig": "()",
"type": "function",
- "desc": "Returns a reference to the underlying {@link Roo.BasicDialog} 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}."
+ },
+ {
+ "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": "Hides the message box if it is displayed"
+ "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 the message box is currently displayed"
+ "desc": "Returns true if this component is visible."
},
{
- "name": "progress",
- "sig": "(String title, String msg)",
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"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."
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
},
{
- "name": "prompt",
- "sig": "(String title, String msg, Function fn, Object scope, Boolean/Number multiline)",
+ "name": "purgeListeners",
+ "sig": "()",
"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."
+ "desc": "Removes all listeners for this object"
},
{
- "name": "show",
- "sig": "(Object config)",
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
"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>"
+ "desc": "Removes <b>all</b> added captures from the Observable."
},
{
- "name": "updateProgress",
- "sig": "(Number value, String text)",
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
"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."
+ "desc": "Removes a listener"
},
{
- "name": "updateText",
- "sig": "(String text)",
+ "name": "render",
+ "sig": "(String/HTMLElement/Element container)",
"type": "function",
- "desc": "Updates the message box body text"
+ "desc": "If this is a lazy rendering component, render it to its container element."
},
{
- "name": "wait",
- "sig": "(String msg, String title)",
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
"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."
+ "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.bootstrap.Modal": {
+ "Roo.bootstrap.MessageBar": {
"props": [
{
- "name": "title",
+ "name": "html",
"type": "String",
- "desc": "Title of dialog",
+ "desc": "contents of the MessageBar",
"memberOf": ""
},
{
- "name": "html",
+ "name": "weight",
"type": "String",
- "desc": "- the body of the dialog (for simple ones) - you can also use template..",
- "memberOf": ""
+ "desc": "default info",
+ "memberOf": "",
+ "optvals": [
+ "info",
+ "success",
+ "warning",
+ "danger"
+ ]
},
{
- "name": "tmpl",
- "type": "Roo.Template",
- "desc": "- a template with variables. to use it, add a handler in show:method adn",
+ "name": "beforeClass",
+ "type": "String",
+ "desc": "insert the bar before the given class",
"memberOf": ""
},
{
- "name": "specificTitle",
+ "name": "closable",
"type": "Boolean",
"desc": "default false",
- "memberOf": ""
- },
- {
- "name": "buttons",
- "type": "Array",
- "desc": "Array of buttons or standard button set..",
- "memberOf": ""
- },
- {
- "name": "buttonPosition",
- "type": "String",
- "desc": "default right",
"memberOf": "",
"optvals": [
- "left",
- "right",
- "center"
+ "true",
+ "false"
]
},
{
- "name": "animate",
- "type": "Boolean",
- "desc": "default true",
- "memberOf": ""
- },
- {
- "name": "allow_close",
+ "name": "fixed",
"type": "Boolean",
- "desc": "default true",
- "memberOf": ""
+ "desc": "default false, fix the bar at the top",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
"name": "cls",
"type": "function",
"desc": "Fires before the component is shown. Return false to stop the show."
},
- {
- "name": "btnclick",
- "sig": "function (e)\n{\n\n}",
- "type": "function",
- "desc": "The raw btnclick event for the button"
- },
{
"name": "childrenrendered",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Appends an event handler to this component"
},
- {
- "name": "applyBody",
- "sig": "(Obj data)",
- "type": "function",
- "desc": "Set the body of the Dialog using the template"
- },
+ {
+ "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\n<b>before</b> 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 <b>all</b> 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.bootstrap.MessageBox": {
+ "props": [],
+ "events": [],
+ "methods": [
+ {
+ "name": "alert",
+ "sig": "(String title, String msg, Function fn, Object scope)",
+ "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)."
+ },
+ {
+ "name": "confirm",
+ "sig": "(String title, String msg, Function fn, Object scope)",
+ "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)."
+ },
+ {
+ "name": "getDialog",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns a reference to the underlying {@link Roo.BasicDialog} element"
+ },
+ {
+ "name": "hide",
+ "sig": "()",
+ "type": "function",
+ "desc": "Hides the message box if it is displayed"
+ },
+ {
+ "name": "isVisible",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if the message box is currently displayed"
+ },
+ {
+ "name": "progress",
+ "sig": "(String title, String msg)",
+ "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."
+ },
+ {
+ "name": "prompt",
+ "sig": "(String title, String msg, Function fn, Object scope, Boolean/Number multiline)",
+ "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."
+ },
+ {
+ "name": "show",
+ "sig": "(Object config)",
+ "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>"
+ },
+ {
+ "name": "updateProgress",
+ "sig": "(Number value, String text)",
+ "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."
+ },
+ {
+ "name": "updateText",
+ "sig": "(String text)",
+ "type": "function",
+ "desc": "Updates the message box body text"
+ },
+ {
+ "name": "wait",
+ "sig": "(String msg, String title)",
+ "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."
+ }
+ ]
+ },
+ "Roo.bootstrap.Modal": {
+ "props": [
+ {
+ "name": "title",
+ "type": "String",
+ "desc": "Title of dialog",
+ "memberOf": ""
+ },
+ {
+ "name": "html",
+ "type": "String",
+ "desc": "- the body of the dialog (for simple ones) - you can also use template..",
+ "memberOf": ""
+ },
+ {
+ "name": "tmpl",
+ "type": "Roo.Template",
+ "desc": "- a template with variables. to use it, add a handler in show:method adn",
+ "memberOf": ""
+ },
+ {
+ "name": "specificTitle",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": ""
+ },
+ {
+ "name": "buttons",
+ "type": "Array",
+ "desc": "Array of buttons or standard button set..",
+ "memberOf": ""
+ },
+ {
+ "name": "buttonPosition",
+ "type": "String",
+ "desc": "default right",
+ "memberOf": "",
+ "optvals": [
+ "left",
+ "right",
+ "center"
+ ]
+ },
+ {
+ "name": "animate",
+ "type": "Boolean",
+ "desc": "default true",
+ "memberOf": ""
+ },
+ {
+ "name": "allow_close",
+ "type": "Boolean",
+ "desc": "default true",
+ "memberOf": ""
+ },
+ {
+ "name": "fitwindow",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": ""
+ },
+ {
+ "name": "size",
+ "type": "String",
+ "desc": "default empty",
+ "memberOf": "",
+ "optvals": [
+ "sm",
+ "lg"
+ ]
+ },
+ {
+ "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<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "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": "btnclick",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw btnclick event for the button"
+ },
+ {
+ "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": "applyBody",
+ "sig": "(Obj data)",
+ "type": "function",
+ "desc": "Set the body of the Dialog using the template"
+ },
{
"name": "capture",
"sig": "(Observable o, Function fn, Object scope)",
"desc": "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
"memberOf": "Roo.bootstrap.Input"
},
+ {
+ "name": "indicatorpos",
+ "type": "String",
+ "desc": "default left",
+ "memberOf": "Roo.bootstrap.Input",
+ "optvals": [
+ "left",
+ "right"
+ ]
+ },
{
"name": "align",
"type": "String",
"type": "function",
"desc": "Fires before the component is shown. Return false to stop the show."
},
+ {
+ "name": "beforetoggle",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire before toggle the menu"
+ },
{
"name": "childrenrendered",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires before the component is shown. Return false to stop the show."
},
+ {
+ "name": "beforetoggle",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire before toggle the menu"
+ },
{
"name": "childrenrendered",
"sig": "function (_self)\n{\n\n}",
"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\n<b>before</b> 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 <b>all</b> 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.bootstrap.Navbar": {
- "props": [
- {
- "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<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf": "Roo.util.Observable"
- }
- ],
- "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}",
+ "name": "beforetoggle",
+ "sig": "function (e)\n{\n\n}",
"type": "function",
- "desc": "Fires before the component is shown. Return false to stop the show."
+ "desc": "Fire before toggle the menu"
},
{
"name": "childrenrendered",
}
]
},
- "Roo.bootstrap.Pagination": {
+ "Roo.bootstrap.Navbar": {
"props": [
- {
- "name": "size",
- "type": "String",
- "desc": "xs | sm | md | lg",
- "memberOf": ""
- },
- {
- "name": "inverse",
- "type": "Boolean",
- "desc": "false | true",
- "memberOf": ""
- },
{
"name": "cls",
"type": "String",
"type": "function",
"desc": "Fires before the component is shown. Return false to stop the show."
},
+ {
+ "name": "beforetoggle",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire before toggle the menu"
+ },
{
"name": "childrenrendered",
"sig": "function (_self)\n{\n\n}",
}
]
},
- "Roo.bootstrap.PaginationItem": {
+ "Roo.bootstrap.NumberField": {
"props": [
{
- "name": "html",
+ "name": "allowDecimals",
+ "type": "Boolean",
+ "desc": "False to disallow decimal values (defaults to true)",
+ "memberOf": ""
+ },
+ {
+ "name": "decimalSeparator",
"type": "String",
- "desc": "text",
+ "desc": "Character(s) to allow as the decimal separator (defaults to '.')",
"memberOf": ""
},
{
- "name": "href",
+ "name": "decimalPrecision",
+ "type": "Number",
+ "desc": "The maximum precision to display after the decimal separator (defaults to 2)",
+ "memberOf": ""
+ },
+ {
+ "name": "allowNegative",
+ "type": "Boolean",
+ "desc": "False to prevent entering a negative sign (defaults to true)",
+ "memberOf": ""
+ },
+ {
+ "name": "minValue",
+ "type": "Number",
+ "desc": "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
+ "memberOf": ""
+ },
+ {
+ "name": "maxValue",
+ "type": "Number",
+ "desc": "The maximum allowed value (defaults to Number.MAX_VALUE)",
+ "memberOf": ""
+ },
+ {
+ "name": "minText",
"type": "String",
- "desc": "the link",
+ "desc": "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")",
"memberOf": ""
},
{
- "name": "preventDefault",
+ "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": ""
+ },
+ {
+ "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": ""
+ },
+ {
+ "name": "castInt",
"type": "Boolean",
- "desc": "default true",
+ "desc": "cast int if true (defalut true)",
"memberOf": "",
"optvals": [
"true",
]
},
{
- "name": "active",
+ "name": "disabled",
"type": "Boolean",
- "desc": "default false",
- "memberOf": "",
+ "desc": "is it disabled",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "inputType",
+ "type": "String",
+ "desc": "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "name",
+ "type": "String",
+ "desc": "name of the input",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "fieldLabel",
+ "type": "string",
+ "desc": "- the label associated",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "placeholder",
+ "type": "string",
+ "desc": "- placeholder to put in text.",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "before",
+ "type": "string",
+ "desc": "- input group add on before",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "after",
+ "type": "string",
+ "desc": "- input group add on after",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "size",
+ "type": "string",
+ "desc": "- (lg|sm) or leave empty..",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "xs",
+ "type": "Number",
+ "desc": "colspan out of 12 for mobile-sized screens",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "sm",
+ "type": "Number",
+ "desc": "colspan out of 12 for tablet-sized screens",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "md",
+ "type": "Number",
+ "desc": "colspan out of 12 for computer-sized screens",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "lg",
+ "type": "Number",
+ "desc": "colspan out of 12 for large computer-sized screens",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "value",
+ "type": "string",
+ "desc": "default value of the input",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelWidth",
+ "type": "Number",
+ "desc": "set the width of label (0-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelAlign",
+ "type": "String",
+ "desc": "",
+ "memberOf": "Roo.bootstrap.Input",
+ "optvals": [
+ "top",
+ "left"
+ ]
+ },
+ {
+ "name": "readOnly",
+ "type": "Boolean",
+ "desc": "Specifies that the field should be read-only",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "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.Input"
+ },
+ {
+ "name": "indicatorpos",
+ "type": "String",
+ "desc": "default left",
+ "memberOf": "Roo.bootstrap.Input",
+ "optvals": [
+ "left",
+ "right"
+ ]
+ },
+ {
+ "name": "align",
+ "type": "String",
+ "desc": "Default left",
+ "memberOf": "Roo.bootstrap.Input",
+ "optvals": [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ {
+ "name": "forceFeedback",
+ "type": "Boolean",
+ "desc": "Default false",
+ "memberOf": "Roo.bootstrap.Input",
"optvals": [
"true",
"false"
]
},
{
- "name": "disabled",
+ "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.Input"
+ },
+ {
+ "name": "validateOnBlur",
"type": "Boolean",
- "desc": "default false",
- "memberOf": ""
+ "desc": "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "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.Input"
+ },
+ {
+ "name": "focusClass",
+ "type": "String",
+ "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "invalidClass",
+ "type": "String",
+ "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "validClass",
+ "type": "String",
+ "desc": "The CSS class to use when marking a field valid (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "hasFeedback",
+ "type": "Boolean",
+ "desc": "default true",
+ "memberOf": "Roo.bootstrap.Input",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "invalidFeedbackIcon",
+ "type": "String",
+ "desc": "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "validFeedbackIcon",
+ "type": "String",
+ "desc": "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "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.Input"
+ },
+ {
+ "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.Input"
+ },
+ {
+ "name": "vtype",
+ "type": "String",
+ "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "disableKeyFilter",
+ "type": "Boolean",
+ "desc": "True to disable input keystroke filtering (defaults to false)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "allowBlank",
+ "type": "Boolean",
+ "desc": "False to validate that the value length > 0 (defaults to true)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "blankText",
+ "type": "String",
+ "desc": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "minLength",
+ "type": "Number",
+ "desc": "Minimum input field length required (defaults to 0)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "maxLength",
+ "type": "Number",
+ "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "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.Input"
+ },
+ {
+ "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.Input"
+ },
+ {
+ "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.Input"
+ },
+ {
+ "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.Input"
+ },
+ {
+ "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.bootstrap.Input"
},
{
"name": "cls",
"desc": "cutomer id",
"memberOf": "Roo.bootstrap.Component"
},
- {
- "name": "name",
- "type": "string",
- "desc": "Specifies name attribute",
- "memberOf": "Roo.bootstrap.Component"
- },
{
"name": "tooltip",
"type": "string",
"desc": "Fires before the component is shown. Return false to stop the show."
},
{
- "name": "childrenrendered",
+ "name": "blur",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the children have been rendered.."
+ "desc": "Fires when this field loses input focus."
},
{
- "name": "click",
- "sig": "function (e)\n{\n\n}",
+ "name": "change",
+ "sig": "function (_self, newValue, oldValue)\n{\n\n}",
"type": "function",
- "desc": "The raw click event for the entire grid."
+ "desc": "Fires just before the field blurs if the field value has changed."
+ },
+ {
+ "name": "childrenrendered",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the children have been rendered.."
},
{
"name": "destroy",
"type": "function",
"desc": "Fires after the component is enabled."
},
+ {
+ "name": "focus",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field receives input focus."
+ },
{
"name": "hide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is hidden."
},
+ {
+ "name": "invalid",
+ "sig": "function (_self, msg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been marked as invalid."
+ },
+ {
+ "name": "keyup",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the key up"
+ },
{
"name": "render",
"sig": "function (_self)\n{\n\n}",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is shown."
+ },
+ {
+ "name": "specialkey",
+ "sig": "function (_self, e)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been validated with no errors."
}
],
"methods": [
"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."
},
+ {
+ "name": "clearInvalid",
+ "sig": "()",
+ "type": "function",
+ "desc": "Clear any invalid styles/messages for this field"
+ },
{
"name": "destroy",
"sig": "()",
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getName",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the name of the field"
+ },
+ {
+ "name": "getRawValue",
+ "sig": "()",
+ "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}."
+ },
+ {
+ "name": "getValue",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"type": "function",
"desc": "Initialize Events for the element"
},
+ {
+ "name": "inputEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "return the real input element."
+ },
{
"name": "isVisible",
"sig": "()",
"type": "function",
"desc": "Returns true if this component is visible."
},
+ {
+ "name": "markInvalid",
+ "sig": "(String msg)",
+ "type": "function",
+ "desc": "Mark this field as invalid"
+ },
+ {
+ "name": "markValid",
+ "sig": "()",
+ "type": "function",
+ "desc": "Mark this field as valid"
+ },
{
"name": "on",
"sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
"desc": "If this is a lazy rendering component, render it to its container element."
},
+ {
+ "name": "reset",
+ "sig": "()",
+ "type": "function",
+ "desc": "Resets the current field value to the originally loaded value and clears any validation messages"
+ },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
"type": "function",
"desc": "Convenience function for setting disabled/enabled by boolean."
},
+ {
+ "name": "setRawValue",
+ "sig": "(Mixed value)",
+ "type": "function",
+ "desc": "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}."
+ },
+ {
+ "name": "setValue",
+ "sig": "(Mixed value)",
+ "type": "function",
+ "desc": "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}."
+ },
{
"name": "setVisible",
"sig": "(Boolean visible)",
"sig": "(String eventName, Function handler, Object scope)",
"type": "function",
"desc": "Removes a listener (shorthand for removeListener)"
+ },
+ {
+ "name": "validate",
+ "sig": "()",
+ "type": "function",
+ "desc": "Validates the field value"
+ },
+ {
+ "name": "validateValue",
+ "sig": "(Mixed value)",
+ "type": "function",
+ "desc": "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails"
}
]
},
- "Roo.bootstrap.PagingToolbar": {
+ "Roo.bootstrap.Pagination": {
"props": [
{
- "name": "dataSource",
- "type": "Roo.data.Store",
- "desc": "The underlying data store providing the paged data",
- "memberOf": ""
- },
- {
- "name": "container",
- "type": "String/HTMLElement/Element",
- "desc": "container The id or element that will contain the toolbar",
+ "name": "size",
+ "type": "String",
+ "desc": "xs | sm | md | lg",
"memberOf": ""
},
{
- "name": "displayInfo",
+ "name": "inverse",
"type": "Boolean",
- "desc": "True to display the displayMsg (defaults to false)",
+ "desc": "false | true",
"memberOf": ""
},
{
- "name": "pageSize",
- "type": "Number",
- "desc": "The number of records to display per page (defaults to 20)",
- "memberOf": ""
+ "name": "cls",
+ "type": "String",
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "displayMsg",
+ "name": "style",
"type": "String",
- "desc": "The paging status message to display (defaults to \"Displaying {start} - {end} of {total}\")",
- "memberOf": ""
+ "desc": "any extra css",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "emptyMsg",
- "type": "String",
- "desc": "The message to display when no records are found (defaults to \"No data to display\")",
- "memberOf": ""
+ "name": "xattr",
+ "type": "Object",
+ "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "inverse",
+ "name": "can_build_overlaid",
"type": "Boolean",
- "desc": "is inverted color",
- "memberOf": "Roo.bootstrap.NavSimplebar"
- },
- {
- "name": "type",
- "type": "String",
- "desc": "",
- "memberOf": "Roo.bootstrap.NavSimplebar",
- "optvals": [
- "nav",
- "pills",
- "tabs"
- ]
- },
- {
- "name": "arrangement",
- "type": "Boolean",
- "desc": "stacked | justified",
- "memberOf": "Roo.bootstrap.NavSimplebar"
- },
- {
- "name": "align",
- "type": "String",
- "desc": "alignment",
- "memberOf": "Roo.bootstrap.NavSimplebar",
- "optvals": [
- "left",
- "right"
- ]
- },
- {
- "name": "main",
- "type": "Boolean",
- "desc": "main nav bar? default false",
- "memberOf": "Roo.bootstrap.NavSimplebar",
- "optvals": [
- "true",
- "false"
- ]
- },
- {
- "name": "loadMask",
- "type": "Boolean",
- "desc": "loadMask on the bar",
- "memberOf": "Roo.bootstrap.NavSimplebar",
- "optvals": [
- "true",
- "false"
- ]
- },
- {
- "name": "tag",
- "type": "String",
- "desc": "default is nav",
- "memberOf": "Roo.bootstrap.NavSimplebar",
- "optvals": [
- "header",
- "footer",
- "nav",
- "div"
- ]
- },
- {
- "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"
+ "desc": "True if element can be rebuild from a HTML page",
+ "memberOf": "Roo.bootstrap.Component"
},
{
"name": "dataId",
"type": "function",
"desc": "Appends an event handler to this component"
},
- {
- "name": "bind",
- "sig": "(Roo.data.Store store)",
- "type": "function",
- "desc": "Binds the paging toolbar to the specified {@link Roo.data.Store}"
- },
{
"name": "capture",
"sig": "(Observable o, Function fn, Object scope)",
"sig": "(String eventName, Function handler, Object scope)",
"type": "function",
"desc": "Removes a listener (shorthand for removeListener)"
- },
- {
- "name": "unbind",
- "sig": "(Roo.data.Store store)",
- "type": "function",
- "desc": "Unbinds the paging toolbar from the specified {@link Roo.data.Store}"
}
]
},
- "Roo.bootstrap.Popover": {
+ "Roo.bootstrap.PaginationItem": {
"props": [
{
"name": "html",
"type": "String",
- "desc": "contents of the popover (or false to use children..)",
- "memberOf": ""
- },
- {
- "name": "title",
- "type": "String",
- "desc": "of popover (or false to hide)",
+ "desc": "text",
"memberOf": ""
},
{
- "name": "placement",
+ "name": "href",
"type": "String",
- "desc": "how it is placed",
+ "desc": "the link",
"memberOf": ""
},
{
- "name": "trigger",
- "type": "String",
- "desc": "click || hover (or false to trigger manually)",
- "memberOf": ""
+ "name": "preventDefault",
+ "type": "Boolean",
+ "desc": "default true",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
- "name": "over",
- "type": "String",
- "desc": "what (parent or false to trigger manually.)",
- "memberOf": ""
+ "name": "active",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
- "name": "delay",
- "type": "Number",
- "desc": "- delay before showing",
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "default false",
"memberOf": ""
},
{
"type": "function",
"desc": "Fires when the children have been rendered.."
},
+ {
+ "name": "click",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw click event for the entire grid."
+ },
{
"name": "destroy",
"sig": "function (_self)\n{\n\n}",
}
]
},
- "Roo.bootstrap.Progress": {
+ "Roo.bootstrap.PagingToolbar": {
"props": [
{
- "name": "striped",
- "type": "Boolean",
- "desc": "striped of the progress bar",
+ "name": "dataSource",
+ "type": "Roo.data.Store",
+ "desc": "The underlying data store providing the paged data",
"memberOf": ""
},
{
- "name": "active",
+ "name": "container",
+ "type": "String/HTMLElement/Element",
+ "desc": "container The id or element that will contain the toolbar",
+ "memberOf": ""
+ },
+ {
+ "name": "displayInfo",
"type": "Boolean",
- "desc": "animated of the progress bar",
+ "desc": "True to display the displayMsg (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "pageSize",
+ "type": "Number",
+ "desc": "The number of records to display per page (defaults to 20)",
+ "memberOf": ""
+ },
+ {
+ "name": "displayMsg",
+ "type": "String",
+ "desc": "The paging status message to display (defaults to \"Displaying {start} - {end} of {total}\")",
"memberOf": ""
},
+ {
+ "name": "emptyMsg",
+ "type": "String",
+ "desc": "The message to display when no records are found (defaults to \"No data to display\")",
+ "memberOf": ""
+ },
+ {
+ "name": "inverse",
+ "type": "Boolean",
+ "desc": "is inverted color",
+ "memberOf": "Roo.bootstrap.NavSimplebar"
+ },
+ {
+ "name": "type",
+ "type": "String",
+ "desc": "",
+ "memberOf": "Roo.bootstrap.NavSimplebar",
+ "optvals": [
+ "nav",
+ "pills",
+ "tabs"
+ ]
+ },
+ {
+ "name": "arrangement",
+ "type": "Boolean",
+ "desc": "stacked | justified",
+ "memberOf": "Roo.bootstrap.NavSimplebar"
+ },
+ {
+ "name": "align",
+ "type": "String",
+ "desc": "alignment",
+ "memberOf": "Roo.bootstrap.NavSimplebar",
+ "optvals": [
+ "left",
+ "right"
+ ]
+ },
+ {
+ "name": "main",
+ "type": "Boolean",
+ "desc": "main nav bar? default false",
+ "memberOf": "Roo.bootstrap.NavSimplebar",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "loadMask",
+ "type": "Boolean",
+ "desc": "loadMask on the bar",
+ "memberOf": "Roo.bootstrap.NavSimplebar",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "tag",
+ "type": "String",
+ "desc": "default is nav",
+ "memberOf": "Roo.bootstrap.NavSimplebar",
+ "optvals": [
+ "header",
+ "footer",
+ "nav",
+ "div"
+ ]
+ },
{
"name": "cls",
"type": "String",
"type": "function",
"desc": "Fires before the component is shown. Return false to stop the show."
},
+ {
+ "name": "beforetoggle",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire before toggle the menu"
+ },
{
"name": "childrenrendered",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Appends an event handler to this component"
},
+ {
+ "name": "bind",
+ "sig": "(Roo.data.Store store)",
+ "type": "function",
+ "desc": "Binds the paging toolbar to the specified {@link Roo.data.Store}"
+ },
{
"name": "capture",
"sig": "(Observable o, Function fn, Object scope)",
"sig": "(String eventName, Function handler, Object scope)",
"type": "function",
"desc": "Removes a listener (shorthand for removeListener)"
+ },
+ {
+ "name": "unbind",
+ "sig": "(Roo.data.Store store)",
+ "type": "function",
+ "desc": "Unbinds the paging toolbar from the specified {@link Roo.data.Store}"
}
]
},
- "Roo.bootstrap.ProgressBar": {
+ "Roo.bootstrap.Popover": {
"props": [
{
- "name": "aria_valuenow",
- "type": "Number",
- "desc": "aria-value now",
- "memberOf": ""
- },
- {
- "name": "aria_valuemin",
- "type": "Number",
- "desc": "aria-value min",
+ "name": "html",
+ "type": "String",
+ "desc": "contents of the popover (or false to use children..)",
"memberOf": ""
},
{
- "name": "aria_valuemax",
- "type": "Number",
- "desc": "aria-value max",
+ "name": "title",
+ "type": "String",
+ "desc": "of popover (or false to hide)",
"memberOf": ""
},
{
- "name": "label",
+ "name": "placement",
"type": "String",
- "desc": "label for the progress bar",
+ "desc": "how it is placed",
"memberOf": ""
},
{
- "name": "panel",
+ "name": "trigger",
"type": "String",
- "desc": "",
- "memberOf": "",
- "optvals": [
- "success",
- "info",
- "warning",
- "danger"
- ]
+ "desc": "click || hover (or false to trigger manually)",
+ "memberOf": ""
},
{
- "name": "role",
+ "name": "over",
"type": "String",
- "desc": "role of the progress bar",
+ "desc": "what (parent or false to trigger manually.)",
"memberOf": ""
},
{
- "name": "sr_only",
- "type": "String",
- "desc": "text",
+ "name": "delay",
+ "type": "Number",
+ "desc": "- delay before showing",
"memberOf": ""
},
{
"name": "hide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is hidden."
+ "desc": "After the popover hide"
},
{
"name": "render",
"name": "show",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is shown."
+ "desc": "After the popover show"
}
],
"methods": [
}
]
},
- "Roo.bootstrap.Radio": {
+ "Roo.bootstrap.Progress": {
"props": [
{
- "name": "valueOff",
- "type": "String",
- "desc": "The value that should go into the generated input element's value when unchecked.",
- "memberOf": "Roo.bootstrap.CheckBox"
- },
- {
- "name": "inputValue",
- "type": "String",
- "desc": "The value that should go into the generated input element's value when checked.",
- "memberOf": "Roo.bootstrap.CheckBox"
- },
- {
- "name": "boxLabel",
- "type": "String",
- "desc": "The text that appears beside the checkbox",
- "memberOf": "Roo.bootstrap.CheckBox"
- },
- {
- "name": "weight",
- "type": "String",
- "desc": "The text that appears beside the checkbox",
- "memberOf": "Roo.bootstrap.CheckBox",
- "optvals": [
- "primary",
- "warning",
- "info",
- "danger",
- "success"
- ]
- },
- {
- "name": "checked",
- "type": "Boolean",
- "desc": "initnal the element",
- "memberOf": "Roo.bootstrap.CheckBox"
- },
- {
- "name": "inline",
- "type": "Boolean",
- "desc": "inline the element (default false)",
- "memberOf": "Roo.bootstrap.CheckBox"
- },
- {
- "name": "groupId",
- "type": "String",
- "desc": "the checkbox group id // normal just use for checkbox",
- "memberOf": "Roo.bootstrap.CheckBox"
- },
- {
- "name": "disabled",
- "type": "Boolean",
- "desc": "is it disabled",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "inputType",
- "type": "String",
- "desc": "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "name",
- "type": "String",
- "desc": "name of the input",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "fieldLabel",
- "type": "string",
- "desc": "- the label associated",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "placeholder",
- "type": "string",
- "desc": "- placeholder to put in text.",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "before",
- "type": "string",
- "desc": "- input group add on before",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "after",
- "type": "string",
- "desc": "- input group add on after",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "size",
- "type": "string",
- "desc": "- (lg|sm) or leave empty..",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "xs",
- "type": "Number",
- "desc": "colspan out of 12 for mobile-sized screens",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "sm",
- "type": "Number",
- "desc": "colspan out of 12 for tablet-sized screens",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "md",
- "type": "Number",
- "desc": "colspan out of 12 for computer-sized screens",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "lg",
- "type": "Number",
- "desc": "colspan out of 12 for large computer-sized screens",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "value",
- "type": "string",
- "desc": "default value of the input",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "labelWidth",
- "type": "Number",
- "desc": "set the width of label (0-12)",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "labelAlign",
- "type": "String",
- "desc": "",
- "memberOf": "Roo.bootstrap.Input",
- "optvals": [
- "top",
- "left"
- ]
- },
- {
- "name": "readOnly",
- "type": "Boolean",
- "desc": "Specifies that the field should be read-only",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "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.Input"
- },
- {
- "name": "align",
- "type": "String",
- "desc": "Default left",
- "memberOf": "Roo.bootstrap.Input",
- "optvals": [
- "left",
- "center",
- "right"
- ]
- },
- {
- "name": "forceFeedback",
- "type": "Boolean",
- "desc": "Default false",
- "memberOf": "Roo.bootstrap.Input",
- "optvals": [
- "true",
- "false"
- ]
- },
- {
- "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.Input"
- },
- {
- "name": "validateOnBlur",
- "type": "Boolean",
- "desc": "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "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.Input"
- },
- {
- "name": "focusClass",
- "type": "String",
- "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "invalidClass",
- "type": "String",
- "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "validClass",
- "type": "String",
- "desc": "The CSS class to use when marking a field valid (defaults to \"x-form-invalid\")",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "hasFeedback",
- "type": "Boolean",
- "desc": "default true",
- "memberOf": "Roo.bootstrap.Input",
- "optvals": [
- "true",
- "false"
- ]
- },
- {
- "name": "invalidFeedbackIcon",
- "type": "String",
- "desc": "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "validFeedbackIcon",
- "type": "String",
- "desc": "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "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.Input"
- },
- {
- "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.Input"
- },
- {
- "name": "vtype",
- "type": "String",
- "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "disableKeyFilter",
+ "name": "striped",
"type": "Boolean",
- "desc": "True to disable input keystroke filtering (defaults to false)",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "striped of the progress bar",
+ "memberOf": ""
},
{
- "name": "allowBlank",
+ "name": "active",
"type": "Boolean",
- "desc": "False to validate that the value length > 0 (defaults to true)",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "blankText",
- "type": "String",
- "desc": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "minLength",
- "type": "Number",
- "desc": "Minimum input field length required (defaults to 0)",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "maxLength",
- "type": "Number",
- "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "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.Input"
- },
- {
- "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.Input"
- },
- {
- "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.Input"
- },
- {
- "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.Input"
- },
- {
- "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.bootstrap.Input"
+ "desc": "animated of the progress bar",
+ "memberOf": ""
},
{
"name": "cls",
"desc": "cutomer id",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "name",
+ "type": "string",
+ "desc": "Specifies name attribute",
+ "memberOf": "Roo.bootstrap.Component"
+ },
{
"name": "tooltip",
"type": "string",
"type": "function",
"desc": "Fires before the component is shown. Return false to stop the show."
},
- {
- "name": "blur",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when this field loses input focus."
- },
- {
- "name": "change",
- "sig": "function (_self, newValue, oldValue)\n{\n\n}",
- "type": "function",
- "desc": "Fires just before the field blurs if the field value has changed."
- },
- {
- "name": "check",
- "sig": "function (_self, checked)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the element is checked or unchecked."
- },
{
"name": "childrenrendered",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is enabled."
},
- {
- "name": "focus",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when this field receives input focus."
- },
{
"name": "hide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is hidden."
},
- {
- "name": "invalid",
- "sig": "function (_self, msg)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the field has been marked as invalid."
- },
- {
- "name": "keyup",
- "sig": "function (_self, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the key up"
- },
{
"name": "render",
"sig": "function (_self)\n{\n\n}",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is shown."
- },
- {
- "name": "specialkey",
- "sig": "function (_self, e)\n{\n\n}",
- "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."
- },
- {
- "name": "valid",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the field has been validated with no errors."
}
],
"methods": [
"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."
},
- {
- "name": "clearInvalid",
- "sig": "()",
- "type": "function",
- "desc": "Clear any invalid styles/messages for this field"
- },
{
"name": "destroy",
"sig": "()",
"type": "function",
"desc": "Try to focus this component."
},
- {
- "name": "get",
- "sig": "(string the)",
- "type": "function",
- "desc": "fetch a CheckBox Group based on the group ID"
- },
{
"name": "getChildContainer",
"sig": "()",
"type": "function",
"desc": "Returns the id of this component."
},
- {
- "name": "getName",
- "sig": "()",
- "type": "function",
- "desc": "Returns the name of the field"
- },
- {
- "name": "getRawValue",
- "sig": "()",
- "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}."
- },
- {
- "name": "getValue",
- "sig": "()",
- "type": "function",
- "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
- },
{
"name": "hasListener",
"sig": "(String eventName)",
"type": "function",
"desc": "Initialize Events for the element"
},
- {
- "name": "inputEl",
- "sig": "()",
- "type": "function",
- "desc": "return the real input element."
- },
{
"name": "isVisible",
"sig": "()",
"type": "function",
"desc": "Returns true if this component is visible."
},
- {
- "name": "markInvalid",
- "sig": "(String msg)",
- "type": "function",
- "desc": "Mark this field as invalid"
- },
- {
- "name": "markValid",
- "sig": "()",
- "type": "function",
- "desc": "Mark this field as valid"
- },
{
"name": "on",
"sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
"desc": "Removes all listeners for this object"
},
- {
- "name": "register",
- "sig": "(Roo.bootstrap.CheckBox the)",
- "type": "function",
- "desc": "register a CheckBox Group"
- },
{
"name": "releaseCapture",
"sig": "(Observable o)",
"type": "function",
"desc": "If this is a lazy rendering component, render it to its container element."
},
- {
- "name": "reset",
- "sig": "()",
- "type": "function",
- "desc": "Resets the current field value to the originally loaded value and clears any validation messages"
- },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
"type": "function",
"desc": "Convenience function for setting disabled/enabled by boolean."
},
- {
- "name": "setRawValue",
- "sig": "(Mixed value)",
- "type": "function",
- "desc": "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}."
- },
- {
- "name": "setValue",
- "sig": "(Mixed value)",
- "type": "function",
- "desc": "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}."
- },
{
"name": "setVisible",
"sig": "(Boolean visible)",
"sig": "(String eventName, Function handler, Object scope)",
"type": "function",
"desc": "Removes a listener (shorthand for removeListener)"
- },
- {
- "name": "validate",
- "sig": "()",
- "type": "function",
- "desc": "Validates the field value"
- },
- {
- "name": "validateValue",
- "sig": "(Mixed value)",
- "type": "function",
- "desc": "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails"
}
]
},
- "Roo.bootstrap.Row": {
+ "Roo.bootstrap.ProgressBar": {
"props": [
+ {
+ "name": "aria_valuenow",
+ "type": "Number",
+ "desc": "aria-value now",
+ "memberOf": ""
+ },
+ {
+ "name": "aria_valuemin",
+ "type": "Number",
+ "desc": "aria-value min",
+ "memberOf": ""
+ },
+ {
+ "name": "aria_valuemax",
+ "type": "Number",
+ "desc": "aria-value max",
+ "memberOf": ""
+ },
+ {
+ "name": "label",
+ "type": "String",
+ "desc": "label for the progress bar",
+ "memberOf": ""
+ },
+ {
+ "name": "panel",
+ "type": "String",
+ "desc": "",
+ "memberOf": "",
+ "optvals": [
+ "success",
+ "info",
+ "warning",
+ "danger"
+ ]
+ },
+ {
+ "name": "role",
+ "type": "String",
+ "desc": "role of the progress bar",
+ "memberOf": ""
+ },
+ {
+ "name": "sr_only",
+ "type": "String",
+ "desc": "text",
+ "memberOf": ""
+ },
{
"name": "cls",
"type": "String",
}
]
},
- "Roo.bootstrap.Slider": {
+ "Roo.bootstrap.Radio": {
"props": [
{
- "name": "cls",
+ "name": "valueOff",
"type": "String",
- "desc": "css class",
- "memberOf": "Roo.bootstrap.Component"
+ "desc": "The value that should go into the generated input element's value when unchecked.",
+ "memberOf": "Roo.bootstrap.CheckBox"
+ },
+ {
+ "name": "inputValue",
+ "type": "String",
+ "desc": "The value that should go into the generated input element's value when checked.",
+ "memberOf": "Roo.bootstrap.CheckBox"
+ },
+ {
+ "name": "boxLabel",
+ "type": "String",
+ "desc": "The text that appears beside the checkbox",
+ "memberOf": "Roo.bootstrap.CheckBox"
+ },
+ {
+ "name": "weight",
+ "type": "String",
+ "desc": "The text that appears beside the checkbox",
+ "memberOf": "Roo.bootstrap.CheckBox",
+ "optvals": [
+ "primary",
+ "warning",
+ "info",
+ "danger",
+ "success"
+ ]
+ },
+ {
+ "name": "checked",
+ "type": "Boolean",
+ "desc": "initnal the element",
+ "memberOf": "Roo.bootstrap.CheckBox"
+ },
+ {
+ "name": "inline",
+ "type": "Boolean",
+ "desc": "inline the element (default false)",
+ "memberOf": "Roo.bootstrap.CheckBox"
+ },
+ {
+ "name": "groupId",
+ "type": "String",
+ "desc": "the checkbox group id // normal just use for checkbox",
+ "memberOf": "Roo.bootstrap.CheckBox"
+ },
+ {
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "is it disabled",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "inputType",
+ "type": "String",
+ "desc": "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "name",
+ "type": "String",
+ "desc": "name of the input",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "fieldLabel",
+ "type": "string",
+ "desc": "- the label associated",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "placeholder",
+ "type": "string",
+ "desc": "- placeholder to put in text.",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "before",
+ "type": "string",
+ "desc": "- input group add on before",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "after",
+ "type": "string",
+ "desc": "- input group add on after",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "size",
+ "type": "string",
+ "desc": "- (lg|sm) or leave empty..",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "xs",
+ "type": "Number",
+ "desc": "colspan out of 12 for mobile-sized screens",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "sm",
+ "type": "Number",
+ "desc": "colspan out of 12 for tablet-sized screens",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "md",
+ "type": "Number",
+ "desc": "colspan out of 12 for computer-sized screens",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "lg",
+ "type": "Number",
+ "desc": "colspan out of 12 for large computer-sized screens",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "value",
+ "type": "string",
+ "desc": "default value of the input",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelWidth",
+ "type": "Number",
+ "desc": "set the width of label (0-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelAlign",
+ "type": "String",
+ "desc": "",
+ "memberOf": "Roo.bootstrap.Input",
+ "optvals": [
+ "top",
+ "left"
+ ]
+ },
+ {
+ "name": "readOnly",
+ "type": "Boolean",
+ "desc": "Specifies that the field should be read-only",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "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.Input"
+ },
+ {
+ "name": "indicatorpos",
+ "type": "String",
+ "desc": "default left",
+ "memberOf": "Roo.bootstrap.Input",
+ "optvals": [
+ "left",
+ "right"
+ ]
+ },
+ {
+ "name": "align",
+ "type": "String",
+ "desc": "Default left",
+ "memberOf": "Roo.bootstrap.Input",
+ "optvals": [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ {
+ "name": "forceFeedback",
+ "type": "Boolean",
+ "desc": "Default false",
+ "memberOf": "Roo.bootstrap.Input",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "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.Input"
+ },
+ {
+ "name": "validateOnBlur",
+ "type": "Boolean",
+ "desc": "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "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.Input"
+ },
+ {
+ "name": "focusClass",
+ "type": "String",
+ "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "invalidClass",
+ "type": "String",
+ "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "validClass",
+ "type": "String",
+ "desc": "The CSS class to use when marking a field valid (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "hasFeedback",
+ "type": "Boolean",
+ "desc": "default true",
+ "memberOf": "Roo.bootstrap.Input",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "invalidFeedbackIcon",
+ "type": "String",
+ "desc": "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "validFeedbackIcon",
+ "type": "String",
+ "desc": "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "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.Input"
+ },
+ {
+ "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.Input"
+ },
+ {
+ "name": "vtype",
+ "type": "String",
+ "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "disableKeyFilter",
+ "type": "Boolean",
+ "desc": "True to disable input keystroke filtering (defaults to false)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "allowBlank",
+ "type": "Boolean",
+ "desc": "False to validate that the value length > 0 (defaults to true)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "blankText",
+ "type": "String",
+ "desc": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "minLength",
+ "type": "Number",
+ "desc": "Minimum input field length required (defaults to 0)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "maxLength",
+ "type": "Number",
+ "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "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.Input"
+ },
+ {
+ "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.Input"
+ },
+ {
+ "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.Input"
+ },
+ {
+ "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.Input"
+ },
+ {
+ "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.bootstrap.Input"
+ },
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
},
{
"name": "style",
"desc": "cutomer id",
"memberOf": "Roo.bootstrap.Component"
},
- {
- "name": "name",
- "type": "string",
- "desc": "Specifies name attribute",
- "memberOf": "Roo.bootstrap.Component"
- },
{
"name": "tooltip",
"type": "string",
"type": "function",
"desc": "Fires before the component is shown. Return false to stop the show."
},
+ {
+ "name": "blur",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field loses input focus."
+ },
+ {
+ "name": "change",
+ "sig": "function (_self, newValue, oldValue)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires just before the field blurs if the field value has changed."
+ },
+ {
+ "name": "check",
+ "sig": "function (_self, checked)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the element is checked or unchecked."
+ },
{
"name": "childrenrendered",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is enabled."
},
+ {
+ "name": "focus",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field receives input focus."
+ },
{
"name": "hide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is hidden."
},
+ {
+ "name": "invalid",
+ "sig": "function (_self, msg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been marked as invalid."
+ },
+ {
+ "name": "keyup",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the key up"
+ },
{
"name": "render",
"sig": "function (_self)\n{\n\n}",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is shown."
+ },
+ {
+ "name": "specialkey",
+ "sig": "function (_self, e)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been validated with no errors."
}
],
"methods": [
"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."
},
+ {
+ "name": "clearInvalid",
+ "sig": "()",
+ "type": "function",
+ "desc": "Clear any invalid styles/messages for this field"
+ },
{
"name": "destroy",
"sig": "()",
"type": "function",
"desc": "Try to focus this component."
},
+ {
+ "name": "get",
+ "sig": "(string the)",
+ "type": "function",
+ "desc": "fetch a CheckBox Group based on the group ID"
+ },
{
"name": "getChildContainer",
"sig": "()",
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getName",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the name of the field"
+ },
+ {
+ "name": "getRawValue",
+ "sig": "()",
+ "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}."
+ },
+ {
+ "name": "getValue",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"type": "function",
"desc": "Initialize Events for the element"
},
+ {
+ "name": "inputEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "return the real input element."
+ },
{
"name": "isVisible",
"sig": "()",
"type": "function",
"desc": "Returns true if this component is visible."
},
+ {
+ "name": "markInvalid",
+ "sig": "(String msg)",
+ "type": "function",
+ "desc": "Mark this field as invalid"
+ },
+ {
+ "name": "markValid",
+ "sig": "()",
+ "type": "function",
+ "desc": "Mark this field as valid"
+ },
{
"name": "on",
"sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
"desc": "Removes all listeners for this object"
},
+ {
+ "name": "register",
+ "sig": "(Roo.bootstrap.CheckBox the)",
+ "type": "function",
+ "desc": "register a CheckBox Group"
+ },
{
"name": "releaseCapture",
"sig": "(Observable o)",
"type": "function",
"desc": "If this is a lazy rendering component, render it to its container element."
},
+ {
+ "name": "reset",
+ "sig": "()",
+ "type": "function",
+ "desc": "Resets the current field value to the originally loaded value and clears any validation messages"
+ },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
"type": "function",
"desc": "Convenience function for setting disabled/enabled by boolean."
},
+ {
+ "name": "setRawValue",
+ "sig": "(Mixed value)",
+ "type": "function",
+ "desc": "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}."
+ },
+ {
+ "name": "setValue",
+ "sig": "(Mixed value)",
+ "type": "function",
+ "desc": "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}."
+ },
{
"name": "setVisible",
"sig": "(Boolean visible)",
"sig": "(String eventName, Function handler, Object scope)",
"type": "function",
"desc": "Removes a listener (shorthand for removeListener)"
+ },
+ {
+ "name": "validate",
+ "sig": "()",
+ "type": "function",
+ "desc": "Validates the field value"
+ },
+ {
+ "name": "validateValue",
+ "sig": "(Mixed value)",
+ "type": "function",
+ "desc": "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails"
}
]
},
- "Roo.bootstrap.TabGroup": {
+ "Roo.bootstrap.Row": {
"props": [
{
- "name": "navId",
+ "name": "cls",
"type": "String",
- "desc": "the navigation id (for use with navbars) - will be auto generated if it does not exist..",
- "memberOf": ""
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "carousel",
- "type": "Boolean",
- "desc": "true to make the group behave like a carousel",
- "memberOf": ""
+ "name": "style",
+ "type": "String",
+ "desc": "any extra css",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "bullets",
- "type": "Boolean",
- "desc": "show bullets for the panels",
- "memberOf": ""
+ "name": "xattr",
+ "type": "Object",
+ "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "autoslide",
+ "name": "can_build_overlaid",
"type": "Boolean",
- "desc": "auto slide .. default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "desc": "True if element can be rebuild from a HTML page",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "slideOnTouch",
- "type": "Boolean",
- "desc": "slide on touch .. default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "name": "dataId",
+ "type": "string",
+ "desc": "cutomer id",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "timer",
- "type": "Number",
- "desc": "auto slide timer .. default 0 millisecond",
- "memberOf": ""
- },
- {
- "name": "xs",
- "type": "Number",
- "desc": "colspan out of 12 for mobile-sized screens or 0 for hidden",
- "memberOf": "Roo.bootstrap.Column"
- },
- {
- "name": "sm",
- "type": "Number",
- "desc": "colspan out of 12 for tablet-sized screens or 0 for hidden",
- "memberOf": "Roo.bootstrap.Column"
- },
- {
- "name": "md",
- "type": "Number",
- "desc": "colspan out of 12 for computer-sized screens or 0 for hidden",
- "memberOf": "Roo.bootstrap.Column"
- },
- {
- "name": "lg",
- "type": "Number",
- "desc": "colspan out of 12 for large computer-sized screens or 0 for hidden",
- "memberOf": "Roo.bootstrap.Column"
- },
- {
- "name": "xsoff",
- "type": "Number",
- "desc": "colspan offset out of 12 for mobile-sized screens or 0 for hidden",
- "memberOf": "Roo.bootstrap.Column"
- },
- {
- "name": "smoff",
- "type": "Number",
- "desc": "colspan offset out of 12 for tablet-sized screens or 0 for hidden",
- "memberOf": "Roo.bootstrap.Column"
- },
- {
- "name": "mdoff",
- "type": "Number",
- "desc": "colspan offset out of 12 for computer-sized screens or 0 for hidden",
- "memberOf": "Roo.bootstrap.Column"
- },
- {
- "name": "lgoff",
- "type": "Number",
- "desc": "colspan offset out of 12 for large computer-sized screens or 0 for hidden",
- "memberOf": "Roo.bootstrap.Column"
- },
- {
- "name": "hidden",
- "type": "Boolean",
- "desc": "hide the element",
- "memberOf": "Roo.bootstrap.Column",
- "optvals": [
- "true",
- "false"
- ]
- },
- {
- "name": "alert",
- "type": "String",
- "desc": "type alert (changes background / border...)",
- "memberOf": "Roo.bootstrap.Column",
- "optvals": [
- "success",
- "info",
- "warning",
- "danger"
- ]
- },
- {
- "name": "fa",
- "type": "String",
- "desc": "font awesome icon",
- "memberOf": "Roo.bootstrap.Column",
- "optvals": [
- "ban",
- "check",
- "..."
- ]
- },
- {
- "name": "fasize",
- "type": "Number",
- "desc": "font awsome size",
- "memberOf": "Roo.bootstrap.Column",
- "optvals": [
- "1",
- "2",
- "...."
- ]
- },
- {
- "name": "icon",
- "type": "String",
- "desc": "glyphicon name",
- "memberOf": "Roo.bootstrap.Column",
- "optvals": [
- "info-sign",
- "check",
- "..."
- ]
- },
- {
- "name": "html",
- "type": "String",
- "desc": "content of column.",
- "memberOf": "Roo.bootstrap.Column"
- },
- {
- "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": "name",
+ "type": "string",
+ "desc": "Specifies name attribute",
+ "memberOf": "Roo.bootstrap.Component"
},
{
"name": "tooltip",
"type": "function",
"desc": "Try to focus this component."
},
- {
- "name": "get",
- "sig": "(string the)",
- "type": "function",
- "desc": "fetch a Navigation Group based on the navigation ID\nif one does not exist , it will get created."
- },
{
"name": "getChildContainer",
"sig": "()",
"type": "function",
"desc": "Removes all listeners for this object"
},
- {
- "name": "register",
- "sig": "(Roo.bootstrap.NavItem the)",
- "type": "function",
- "desc": "register a Navigation item"
- },
- {
- "name": "register",
- "sig": "(Roo.bootstrap.NavGroup the)",
- "type": "function",
- "desc": "register a Navigation Group"
- },
{
"name": "releaseCapture",
"sig": "(Observable o)",
"type": "function",
"desc": "Show a component - removes 'hidden' class"
},
- {
- "name": "showPanel",
- "sig": "(Roo.bootstrap.TabPanel|number|string panel)",
- "type": "function",
- "desc": "show a specific panel"
- },
{
"name": "tooltipEl",
"sig": "()",
}
]
},
- "Roo.bootstrap.TabPanel": {
+ "Roo.bootstrap.SecurePass": {
+ "props": [],
+ "events": [],
+ "methods": []
+ },
+ "Roo.bootstrap.Slider": {
"props": [
- {
- "name": "active",
- "type": "Boolean",
- "desc": "panel active",
- "memberOf": ""
- },
- {
- "name": "html",
- "type": "String",
- "desc": "panel content",
- "memberOf": ""
- },
- {
- "name": "tabId",
- "type": "String",
- "desc": "unique tab ID (will be autogenerated if not set. - used to match TabItem to Panel)",
- "memberOf": ""
- },
- {
- "name": "navId",
- "type": "String",
- "desc": "The Roo.bootstrap.NavGroup which triggers show hide ()",
- "memberOf": ""
- },
{
"name": "cls",
"type": "String",
}
],
"events": [
- {
- "name": "beforedeactivate",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires before a tab is de-activated - can be used to do validation on a form."
- },
{
"name": "beforedestroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires before the component is shown. Return false to stop the show."
},
- {
- "name": "changed",
- "sig": "function (_self, state)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the active status changes"
- },
{
"name": "childrenrendered",
"sig": "function (_self)\n{\n\n}",
}
]
},
- "Roo.bootstrap.Table": {
+ "Roo.bootstrap.SplitBar": {
"props": [
{
- "name": "cls",
- "type": "String",
- "desc": "table class",
- "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"
+ }
+ ],
+ "events": [
+ {
+ "name": "beforeresize",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the splitter is dragged"
},
{
- "name": "align",
- "type": "String",
- "desc": "Specifies the alignment of a table according to surrounding text",
- "memberOf": "",
- "optvals": [
- "left",
- "center",
- "right"
- ]
+ "name": "moved",
+ "sig": "function (_self, newSize)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the splitter is moved"
},
{
- "name": "bgcolor",
- "type": "String",
- "desc": "Specifies the background color for a table",
- "memberOf": ""
+ "name": "resize",
+ "sig": "function (_self, newSize)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the splitter is moved (alias for {@link #event-moved})"
+ }
+ ],
+ "methods": [
+ {
+ "name": "addEvents",
+ "sig": "(Object object)",
+ "type": "function",
+ "desc": "Used to define events on this Observable"
},
{
- "name": "border",
- "type": "Number",
- "desc": "Specifies whether the table cells should have borders or not",
- "memberOf": ""
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this component"
},
{
- "name": "cellpadding",
- "type": "Number",
- "desc": "Specifies the space between the cell wall and the cell content",
- "memberOf": ""
+ "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\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire."
},
{
- "name": "cellspacing",
- "type": "Number",
- "desc": "Specifies the space between cells",
- "memberOf": ""
+ "name": "destroy",
+ "sig": "(Boolean removeEl)",
+ "type": "function",
+ "desc": "Destroy this splitbar."
},
{
- "name": "frame",
- "type": "String",
- "desc": "Specifies which parts of the outside borders that should be visible",
- "memberOf": ""
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "rules",
- "type": "String",
- "desc": "Specifies which parts of the inside borders that should be visible",
- "memberOf": ""
+ "name": "getAdapter",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the adapter this SplitBar uses"
},
{
- "name": "sortable",
- "type": "String",
- "desc": "Specifies that the table should be sortable",
- "memberOf": ""
+ "name": "getMaximumSize",
+ "sig": "()",
+ "type": "function",
+ "desc": "Gets the maximum size for the resizing element"
},
{
- "name": "summary",
- "type": "String",
- "desc": "Specifies a summary of the content of a table",
- "memberOf": ""
+ "name": "getMinimumSize",
+ "sig": "()",
+ "type": "function",
+ "desc": "Gets the minimum size for the resizing element"
},
{
- "name": "width",
- "type": "Number",
- "desc": "Specifies the width of a table",
- "memberOf": ""
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "layout",
- "type": "String",
- "desc": "table layout (auto | fixed | initial | inherit)",
- "memberOf": ""
+ "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": "striped",
- "type": "boolean",
- "desc": "Should the rows be alternative striped",
- "memberOf": ""
+ "name": "purgeListeners",
+ "sig": "()",
+ "type": "function",
+ "desc": "Removes all listeners for this object"
},
{
- "name": "bordered",
- "type": "boolean",
- "desc": "Add borders to the table",
- "memberOf": ""
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
},
{
- "name": "hover",
- "type": "boolean",
- "desc": "Add hover highlighting",
- "memberOf": ""
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
},
{
- "name": "condensed",
- "type": "boolean",
- "desc": "Format condensed",
- "memberOf": ""
+ "name": "setAdapter",
+ "sig": "(Object adapter)",
+ "type": "function",
+ "desc": "Set the adapter this SplitBar uses"
},
{
- "name": "responsive",
- "type": "boolean",
- "desc": "Format condensed",
+ "name": "setCurrentSize",
+ "sig": "(Number size)",
+ "type": "function",
+ "desc": "Sets the initialize size for the resizing element"
+ },
+ {
+ "name": "setMaximumSize",
+ "sig": "(Number maxSize)",
+ "type": "function",
+ "desc": "Sets the maximum size for the resizing element"
+ },
+ {
+ "name": "setMinimumSize",
+ "sig": "(Number minSize)",
+ "type": "function",
+ "desc": "Sets the minimum size for the resizing element"
+ },
+ {
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter": {
+ "props": [],
+ "events": [],
+ "methods": [
+ {
+ "name": "getElementSize",
+ "sig": "(Roo.bootstrap.SplitBar s)",
+ "type": "function",
+ "desc": "Called before drag operations to get the current size of the resizing element."
+ },
+ {
+ "name": "setElementSize",
+ "sig": "(Roo.bootstrap.SplitBar s, Number newSize, Function onComplete)",
+ "type": "function",
+ "desc": "Called after drag operations to set the size of the resizing element."
+ }
+ ]
+ },
+ "Roo.bootstrap.SplitBar.BasicLayoutAdapter": {
+ "props": [],
+ "events": [],
+ "methods": [
+ {
+ "name": "getElementSize",
+ "sig": "(Roo.bootstrap.SplitBar s)",
+ "type": "function",
+ "desc": "Called before drag operations to get the current size of the resizing element."
+ },
+ {
+ "name": "setElementSize",
+ "sig": "(Roo.bootstrap.SplitBar s, Number newSize, Function onComplete)",
+ "type": "function",
+ "desc": "Called after drag operations to set the size of the resizing element."
+ }
+ ]
+ },
+ "Roo.bootstrap.TabGroup": {
+ "props": [
+ {
+ "name": "navId",
+ "type": "String",
+ "desc": "the navigation id (for use with navbars) - will be auto generated if it does not exist..",
"memberOf": ""
},
{
- "name": "loadMask",
+ "name": "carousel",
"type": "Boolean",
- "desc": "default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "desc": "true to make the group behave like a carousel",
+ "memberOf": ""
},
{
- "name": "footerShow",
+ "name": "bullets",
"type": "Boolean",
- "desc": "generate tfoot, default true",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "desc": "show bullets for the panels",
+ "memberOf": ""
},
{
- "name": "headerShow",
+ "name": "autoslide",
"type": "Boolean",
- "desc": "generate thead, default true",
+ "desc": "auto slide .. default false",
"memberOf": "",
"optvals": [
"true",
]
},
{
- "name": "rowSelection",
- "type": "Boolean",
- "desc": "default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "name": "timer",
+ "type": "Number",
+ "desc": "auto slide timer .. default 0 millisecond",
+ "memberOf": ""
},
{
- "name": "cellSelection",
+ "name": "showarrow",
"type": "Boolean",
- "desc": "default false",
+ "desc": "show arrow default true",
"memberOf": "",
"optvals": [
"true",
]
},
{
- "name": "footer",
- "type": "Roo.bootstrap.PagingToolbar",
- "desc": "a paging toolbar",
- "memberOf": ""
+ "name": "xs",
+ "type": "Number",
+ "desc": "colspan out of 12 for mobile-sized screens or 0 for hidden",
+ "memberOf": "Roo.bootstrap.Column"
},
{
- "name": "style",
- "type": "String",
- "desc": "any extra css",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "sm",
+ "type": "Number",
+ "desc": "colspan out of 12 for tablet-sized screens or 0 for hidden",
+ "memberOf": "Roo.bootstrap.Column"
},
{
- "name": "xattr",
- "type": "Object",
- "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "md",
+ "type": "Number",
+ "desc": "colspan out of 12 for computer-sized screens or 0 for hidden",
+ "memberOf": "Roo.bootstrap.Column"
},
{
- "name": "can_build_overlaid",
- "type": "Boolean",
- "desc": "True if element can be rebuild from a HTML page",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "lg",
+ "type": "Number",
+ "desc": "colspan out of 12 for large computer-sized screens or 0 for hidden",
+ "memberOf": "Roo.bootstrap.Column"
},
{
- "name": "dataId",
- "type": "string",
- "desc": "cutomer id",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "xsoff",
+ "type": "Number",
+ "desc": "colspan offset out of 12 for mobile-sized screens or 0 for hidden",
+ "memberOf": "Roo.bootstrap.Column"
},
{
- "name": "name",
- "type": "string",
- "desc": "Specifies name attribute",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "smoff",
+ "type": "Number",
+ "desc": "colspan offset out of 12 for tablet-sized screens or 0 for hidden",
+ "memberOf": "Roo.bootstrap.Column"
},
{
- "name": "tooltip",
- "type": "string",
+ "name": "mdoff",
+ "type": "Number",
+ "desc": "colspan offset out of 12 for computer-sized screens or 0 for hidden",
+ "memberOf": "Roo.bootstrap.Column"
+ },
+ {
+ "name": "lgoff",
+ "type": "Number",
+ "desc": "colspan offset out of 12 for large computer-sized screens or 0 for hidden",
+ "memberOf": "Roo.bootstrap.Column"
+ },
+ {
+ "name": "hidden",
+ "type": "Boolean",
+ "desc": "hide the element",
+ "memberOf": "Roo.bootstrap.Column",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "alert",
+ "type": "String",
+ "desc": "type alert (changes background / border...)",
+ "memberOf": "Roo.bootstrap.Column",
+ "optvals": [
+ "success",
+ "info",
+ "warning",
+ "danger"
+ ]
+ },
+ {
+ "name": "fa",
+ "type": "String",
+ "desc": "font awesome icon",
+ "memberOf": "Roo.bootstrap.Column",
+ "optvals": [
+ "ban",
+ "check",
+ "..."
+ ]
+ },
+ {
+ "name": "fasize",
+ "type": "Number",
+ "desc": "font awsome size",
+ "memberOf": "Roo.bootstrap.Column",
+ "optvals": [
+ "1",
+ "2",
+ "...."
+ ]
+ },
+ {
+ "name": "icon",
+ "type": "String",
+ "desc": "glyphicon name",
+ "memberOf": "Roo.bootstrap.Column",
+ "optvals": [
+ "info-sign",
+ "check",
+ "..."
+ ]
+ },
+ {
+ "name": "html",
+ "type": "String",
+ "desc": "content of column.",
+ "memberOf": "Roo.bootstrap.Column"
+ },
+ {
+ "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"
},
"type": "function",
"desc": "Fires before the component is shown. Return false to stop the show."
},
- {
- "name": "cellclick",
- "sig": "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a cell is clicked"
- },
- {
- "name": "celldblclick",
- "sig": "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a cell is double clicked"
- },
{
"name": "childrenrendered",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is hidden."
},
- {
- "name": "mouseout",
- "sig": "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a mouseout occur"
- },
- {
- "name": "mouseover",
- "sig": "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a mouseover occur"
- },
{
"name": "render",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is rendered."
},
- {
- "name": "rowclass",
- "sig": "function (_self, rowcfg)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a row is rendered, so you can change add a style to it."
- },
- {
- "name": "rowclick",
- "sig": "function (_self, el, rowIndex, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a row is clicked"
- },
- {
- "name": "rowdblclick",
- "sig": "function (_self, el, rowIndex, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a row is double clicked"
- },
- {
- "name": "rowsrendered",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when all the rows have been rendered"
- },
{
"name": "show",
"sig": "function (_self)\n{\n\n}",
"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."
},
- {
- "name": "clear",
- "sig": "()",
- "type": "function",
- "desc": "Remove all rows"
- },
{
"name": "destroy",
"sig": "()",
"type": "function",
"desc": "Try to focus this component."
},
+ {
+ "name": "get",
+ "sig": "(string the)",
+ "type": "function",
+ "desc": "fetch a Navigation Group based on the navigation ID\nif one does not exist , it will get created."
+ },
{
"name": "getChildContainer",
"sig": "()",
"type": "function",
"desc": "Removes all listeners for this object"
},
+ {
+ "name": "register",
+ "sig": "(Roo.bootstrap.NavItem the)",
+ "type": "function",
+ "desc": "register a Navigation item"
+ },
+ {
+ "name": "register",
+ "sig": "(Roo.bootstrap.NavGroup the)",
+ "type": "function",
+ "desc": "register a Navigation Group"
+ },
{
"name": "releaseCapture",
"sig": "(Observable o)",
"type": "function",
"desc": "Convenience function for setting disabled/enabled by boolean."
},
- {
- "name": "setRowVisibility",
- "sig": "(Number rowIndex, Boolean state)",
- "type": "function",
- "desc": "Show or hide a row."
- },
{
"name": "setVisible",
"sig": "(Boolean visible)",
"type": "function",
"desc": "Show a component - removes 'hidden' class"
},
+ {
+ "name": "showPanel",
+ "sig": "(Roo.bootstrap.TabPanel|number|string panel)",
+ "type": "function",
+ "desc": "show a specific panel"
+ },
{
"name": "tooltipEl",
"sig": "()",
}
]
},
- "Roo.bootstrap.Table.AbstractSelectionModel": {
+ "Roo.bootstrap.TabPanel": {
"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"
- }
- ],
- "events": [],
- "methods": [
+ "name": "active",
+ "type": "Boolean",
+ "desc": "panel active",
+ "memberOf": ""
+ },
{
- "name": "addEvents",
- "sig": "(Object object)",
- "type": "function",
- "desc": "Used to define events on this Observable"
+ "name": "html",
+ "type": "String",
+ "desc": "panel content",
+ "memberOf": ""
},
{
- "name": "addListener",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
- "type": "function",
- "desc": "Appends an event handler to this component"
+ "name": "tabId",
+ "type": "String",
+ "desc": "unique tab ID (will be autogenerated if not set. - used to match TabItem to Panel)",
+ "memberOf": ""
},
{
- "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\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire."
+ "name": "navId",
+ "type": "String",
+ "desc": "The Roo.bootstrap.NavGroup which triggers show hide ()",
+ "memberOf": ""
},
{
- "name": "fireEvent",
- "sig": "(String eventName, Object... args)",
- "type": "function",
- "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ "name": "href",
+ "type": "String",
+ "desc": "click to link..",
+ "memberOf": ""
},
{
- "name": "hasListener",
- "sig": "(String eventName)",
- "type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
+ "name": "cls",
+ "type": "String",
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "isLocked",
- "sig": "()",
- "type": "function",
- "desc": "Returns true if the selections are locked."
+ "name": "style",
+ "type": "String",
+ "desc": "any extra css",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "lock",
- "sig": "()",
- "type": "function",
- "desc": "Locks the selections."
+ "name": "xattr",
+ "type": "Object",
+ "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "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": "can_build_overlaid",
+ "type": "Boolean",
+ "desc": "True if element can be rebuild from a HTML page",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "purgeListeners",
- "sig": "()",
- "type": "function",
- "desc": "Removes all listeners for this object"
+ "name": "dataId",
+ "type": "string",
+ "desc": "cutomer id",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "releaseCapture",
- "sig": "(Observable o)",
- "type": "function",
- "desc": "Removes <b>all</b> added captures from the Observable."
+ "name": "name",
+ "type": "string",
+ "desc": "Specifies name attribute",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "removeListener",
- "sig": "(String eventName, Function handler, Object scope)",
- "type": "function",
- "desc": "Removes a listener"
+ "name": "tooltip",
+ "type": "string",
+ "desc": "Text for the tooltip",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "un",
- "sig": "(String eventName, Function handler, Object scope)",
- "type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
+ "name": "container_method",
+ "type": "string",
+ "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "unlock",
- "sig": "()",
- "type": "function",
- "desc": "Unlocks the selections."
- }
- ]
- },
- "Roo.bootstrap.Table.RowSelectionModel": {
- "props": [
+ "name": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
+ },
{
- "name": "singleSelect",
+ "name": "allowDomMove",
"type": "Boolean",
- "desc": "True to allow selection of only one row at a time (defaults to false)",
- "memberOf": ""
+ "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",
],
"events": [
{
- "name": "afterselectionchange",
+ "name": "beforedeactivate",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the selection changes (eg. by key press or clicking)"
+ "desc": "Fires before a tab is de-activated - can be used to do validation on a form."
},
{
- "name": "beforerowselect",
- "sig": "function (_self, rowIndex, keepExisting)\n{\n\n}",
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a row is selected being selected, return false to cancel."
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
},
{
- "name": "rowdeselect",
- "sig": "function (_self, rowIndex)\n{\n\n}",
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a row is deselected."
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
},
{
- "name": "rowselect",
- "sig": "function (_self, rowIndex, r)\n{\n\n}",
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a row is selected."
+ "desc": "Fires before the component is rendered. Return false to stop the render."
},
{
- "name": "selectionchange",
+ "name": "beforeshow",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the selection changes"
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "changed",
+ "sig": "function (_self, state)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the active status changes"
+ },
+ {
+ "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": [
"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."
},
{
- "name": "clearSelections",
+ "name": "destroy",
"sig": "()",
"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}."
},
{
- "name": "deselectRange",
- "sig": "(Number startRow, Number endRow)",
+ "name": "disable",
+ "sig": "()",
"type": "function",
- "desc": "Deselects a range of rows. All rows in between startRow and endRow are also deselected."
+ "desc": "Disable this component."
},
{
- "name": "deselectRow",
- "sig": "(Number row)",
+ "name": "enable",
+ "sig": "()",
"type": "function",
- "desc": "Deselects a row."
+ "desc": "Enable this component."
},
{
"name": "fireEvent",
"desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "getCount",
+ "name": "focus",
+ "sig": "(Boolean selectText)",
+ "type": "function",
+ "desc": "Try to focus this component."
+ },
+ {
+ "name": "getChildContainer",
"sig": "()",
"type": "function",
- "desc": "Gets the number of selected rows."
+ "desc": "Fetch the element to add children to"
},
{
- "name": "getSelected",
+ "name": "getEl",
"sig": "()",
"type": "function",
- "desc": "Returns the first selected record."
+ "desc": "Returns the underlying {@link Roo.Element}."
},
{
- "name": "getSelections",
+ "name": "getId",
"sig": "()",
"type": "function",
- "desc": "Returns the selected records"
+ "desc": "Returns the id of this component."
},
{
"name": "hasListener",
"desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "hasSelection",
+ "name": "hide",
"sig": "()",
"type": "function",
- "desc": "Returns True if there is a selection."
- },
- {
- "name": "isIdSelected",
- "sig": "(String id)",
- "type": "function",
- "desc": "Returns True if the specified record id is selected."
+ "desc": "Hide a component - adds 'hidden' class"
},
{
- "name": "isLocked",
+ "name": "initEvents",
"sig": "()",
"type": "function",
- "desc": "Returns true if the selections are locked."
- },
- {
- "name": "isSelected",
- "sig": "(Number/Record record)",
- "type": "function",
- "desc": "Returns True if the specified row is selected."
+ "desc": "Initialize Events for the element"
},
{
- "name": "lock",
+ "name": "isVisible",
"sig": "()",
"type": "function",
- "desc": "Locks the selections."
+ "desc": "Returns true if this component is visible."
},
{
"name": "on",
"desc": "Removes a listener"
},
{
- "name": "selectAll",
- "sig": "()",
+ "name": "render",
+ "sig": "(String/HTMLElement/Element container)",
"type": "function",
- "desc": "Selects all rows."
+ "desc": "If this is a lazy rendering component, render it to its container element."
},
{
- "name": "selectFirstRow",
- "sig": "()",
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
"type": "function",
- "desc": "Selects the first row in the grid."
+ "desc": "Convenience function for setting disabled/enabled by boolean."
},
{
- "name": "selectLastRow",
- "sig": "(Boolean keepExisting)",
+ "name": "setVisible",
+ "sig": "(Boolean visible)",
"type": "function",
- "desc": "Select the last row."
+ "desc": "Convenience function to hide or show this component by boolean."
},
{
- "name": "selectNext",
- "sig": "(Boolean keepExisting)",
+ "name": "show",
+ "sig": "()",
"type": "function",
- "desc": "Selects the row immediately following the last selected row."
+ "desc": "Show a component - removes 'hidden' class"
},
{
- "name": "selectPrevious",
- "sig": "(Boolean keepExisting)",
+ "name": "tooltipEl",
+ "sig": "()",
"type": "function",
- "desc": "Selects the row that precedes the last selected row."
+ "desc": "Fetch the element to display the tooltip on."
},
{
- "name": "selectRange",
- "sig": "(Number startRow, Number endRow, Boolean keepExisting)",
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
"type": "function",
- "desc": "Selects a range of rows. All rows in between startRow and endRow are also selected."
- },
- {
- "name": "selectRecords",
- "sig": "(Array records, Boolean keepExisting)",
- "type": "function",
- "desc": "Select records."
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.bootstrap.Table": {
+ "props": [
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "table class",
+ "memberOf": ""
},
{
- "name": "selectRow",
- "sig": "(Number row, Boolean keepExisting)",
- "type": "function",
- "desc": "Selects a row."
+ "name": "align",
+ "type": "String",
+ "desc": "Specifies the alignment of a table according to surrounding text",
+ "memberOf": "",
+ "optvals": [
+ "left",
+ "center",
+ "right"
+ ]
},
{
- "name": "selectRows",
- "sig": "(Array rows, Boolean keepExisting)",
- "type": "function",
- "desc": "Selects multiple rows."
+ "name": "bgcolor",
+ "type": "String",
+ "desc": "Specifies the background color for a table",
+ "memberOf": ""
},
{
- "name": "un",
- "sig": "(String eventName, Function handler, Object scope)",
- "type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
+ "name": "border",
+ "type": "Number",
+ "desc": "Specifies whether the table cells should have borders or not",
+ "memberOf": ""
},
{
- "name": "unlock",
- "sig": "()",
- "type": "function",
- "desc": "Unlocks the selections."
- }
- ]
- },
- "Roo.bootstrap.TableBody": {
- "props": [
+ "name": "cellpadding",
+ "type": "Number",
+ "desc": "Specifies the space between the cell wall and the cell content",
+ "memberOf": ""
+ },
{
- "name": "cls",
+ "name": "cellspacing",
+ "type": "Number",
+ "desc": "Specifies the space between cells",
+ "memberOf": ""
+ },
+ {
+ "name": "frame",
"type": "String",
- "desc": "element class",
+ "desc": "Specifies which parts of the outside borders that should be visible",
"memberOf": ""
},
{
- "name": "tag",
+ "name": "rules",
"type": "String",
- "desc": "element tag (thead|tbody|tfoot) default tbody",
+ "desc": "Specifies which parts of the inside borders that should be visible",
"memberOf": ""
},
{
- "name": "align",
+ "name": "sortable",
"type": "String",
- "desc": "Aligns the content inside the element",
+ "desc": "Specifies that the table should be sortable",
"memberOf": ""
},
{
- "name": "charoff",
+ "name": "summary",
+ "type": "String",
+ "desc": "Specifies a summary of the content of a table",
+ "memberOf": ""
+ },
+ {
+ "name": "width",
"type": "Number",
- "desc": "Sets the number of characters the content inside the element will be aligned from the character specified by the char attribute",
+ "desc": "Specifies the width of a table",
"memberOf": ""
},
{
- "name": "valign",
+ "name": "layout",
"type": "String",
- "desc": "Vertical aligns the content inside the <tbody> element",
+ "desc": "table layout (auto | fixed | initial | inherit)",
+ "memberOf": ""
+ },
+ {
+ "name": "striped",
+ "type": "boolean",
+ "desc": "Should the rows be alternative striped",
+ "memberOf": ""
+ },
+ {
+ "name": "bordered",
+ "type": "boolean",
+ "desc": "Add borders to the table",
+ "memberOf": ""
+ },
+ {
+ "name": "hover",
+ "type": "boolean",
+ "desc": "Add hover highlighting",
+ "memberOf": ""
+ },
+ {
+ "name": "condensed",
+ "type": "boolean",
+ "desc": "Format condensed",
+ "memberOf": ""
+ },
+ {
+ "name": "responsive",
+ "type": "boolean",
+ "desc": "Format condensed",
+ "memberOf": ""
+ },
+ {
+ "name": "loadMask",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "footerShow",
+ "type": "Boolean",
+ "desc": "generate tfoot, default true",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "headerShow",
+ "type": "Boolean",
+ "desc": "generate thead, default true",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "rowSelection",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "cellSelection",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "scrollBody",
+ "type": "Boolean",
+ "desc": "default false - body scrolled / fixed header",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "footer",
+ "type": "Roo.bootstrap.PagingToolbar",
+ "desc": "a paging toolbar",
"memberOf": ""
},
{
"type": "function",
"desc": "Fires before the component is shown. Return false to stop the show."
},
+ {
+ "name": "cellclick",
+ "sig": "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a cell is clicked"
+ },
+ {
+ "name": "cellcontextmenu",
+ "sig": "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a cell is right clicked"
+ },
+ {
+ "name": "celldblclick",
+ "sig": "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a cell is double clicked"
+ },
{
"name": "childrenrendered",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires when the children have been rendered.."
},
+ {
+ "name": "contextmenu",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw contextmenu event for the entire grid."
+ },
{
"name": "destroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is enabled."
},
+ {
+ "name": "headercontextmenu",
+ "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a header is right clicked"
+ },
{
"name": "hide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is hidden."
},
+ {
+ "name": "mouseout",
+ "sig": "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a mouseout occur"
+ },
+ {
+ "name": "mouseover",
+ "sig": "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a mouseover occur"
+ },
{
"name": "render",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is rendered."
},
+ {
+ "name": "rowclass",
+ "sig": "function (_self, rowcfg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is rendered, so you can change add a style to it."
+ },
+ {
+ "name": "rowclick",
+ "sig": "function (_self, el, rowIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is clicked"
+ },
+ {
+ "name": "rowcontextmenu",
+ "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is right clicked"
+ },
+ {
+ "name": "rowdblclick",
+ "sig": "function (_self, el, rowIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is double clicked"
+ },
+ {
+ "name": "rowsrendered",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when all the rows have been rendered"
+ },
{
"name": "show",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Appends an event handler to this component"
},
+ {
+ "name": "autoSize",
+ "sig": "()",
+ "type": "function",
+ "desc": "Forces a resize - used by panel.Grid"
+ },
{
"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\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire."
},
+ {
+ "name": "clear",
+ "sig": "()",
+ "type": "function",
+ "desc": "Remove all rows"
+ },
{
"name": "destroy",
"sig": "()",
"type": "function",
"desc": "Returns the underlying {@link Roo.Element}."
},
+ {
+ "name": "getGridEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the grid's underlying element = used by panel.Grid"
+ },
{
"name": "getId",
"sig": "()",
"type": "function",
"desc": "Convenience function for setting disabled/enabled by boolean."
},
+ {
+ "name": "setRowVisibility",
+ "sig": "(Number rowIndex, Boolean state)",
+ "type": "function",
+ "desc": "Show or hide a row."
+ },
{
"name": "setVisible",
"sig": "(Boolean visible)",
}
]
},
- "Roo.bootstrap.TableCell": {
+ "Roo.bootstrap.Table.AbstractSelectionModel": {
"props": [
{
- "name": "html",
- "type": "String",
- "desc": "cell contain text",
- "memberOf": ""
- },
- {
- "name": "cls",
- "type": "String",
- "desc": "cell class",
- "memberOf": ""
- },
- {
- "name": "tag",
- "type": "String",
- "desc": "cell tag (td|th) default td",
- "memberOf": ""
- },
- {
- "name": "abbr",
- "type": "String",
- "desc": "Specifies an abbreviated version of the content in a cell",
- "memberOf": ""
- },
- {
- "name": "align",
- "type": "String",
- "desc": "Aligns the content in a cell",
- "memberOf": ""
- },
- {
- "name": "axis",
- "type": "String",
- "desc": "Categorizes cells",
- "memberOf": ""
- },
- {
- "name": "bgcolor",
- "type": "String",
- "desc": "Specifies the background color of a cell",
- "memberOf": ""
- },
- {
- "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": "colspan",
- "type": "Number",
- "desc": "Specifies the number of columns a cell should span",
- "memberOf": ""
- },
- {
- "name": "headers",
- "type": "String",
- "desc": "Specifies one or more header cells a cell is related to",
- "memberOf": ""
- },
- {
- "name": "height",
- "type": "Number",
- "desc": "Sets the height of a cell",
- "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"
+ }
+ ],
+ "events": [],
+ "methods": [
{
- "name": "nowrap",
- "type": "String",
- "desc": "Specifies that the content inside a cell should not wrap",
- "memberOf": ""
+ "name": "addEvents",
+ "sig": "(Object object)",
+ "type": "function",
+ "desc": "Used to define events on this Observable"
},
{
- "name": "rowspan",
- "type": "Number",
- "desc": "Sets the number of rows a cell should span",
- "memberOf": ""
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this component"
},
{
- "name": "scope",
- "type": "String",
- "desc": "Defines a way to associate header cells and data cells in a table",
- "memberOf": ""
+ "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\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire."
},
{
- "name": "valign",
- "type": "String",
- "desc": "Vertical aligns the content in a cell",
- "memberOf": ""
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "width",
- "type": "Number",
- "desc": "Specifies the width of a cell",
- "memberOf": ""
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "style",
- "type": "String",
- "desc": "any extra css",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "isLocked",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if the selections are locked."
},
{
- "name": "xattr",
- "type": "Object",
- "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "lock",
+ "sig": "()",
+ "type": "function",
+ "desc": "Locks the selections."
},
{
- "name": "can_build_overlaid",
- "type": "Boolean",
- "desc": "True if element can be rebuild from a HTML page",
- "memberOf": "Roo.bootstrap.Component"
+ "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": "dataId",
- "type": "string",
- "desc": "cutomer id",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "purgeListeners",
+ "sig": "()",
+ "type": "function",
+ "desc": "Removes all listeners for this object"
},
{
- "name": "name",
- "type": "string",
- "desc": "Specifies name attribute",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
},
{
- "name": "tooltip",
- "type": "string",
- "desc": "Text for the tooltip",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
},
{
- "name": "container_method",
- "type": "string",
- "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
},
{
- "name": "disableClass",
- "type": "String",
- "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf": "Roo.Component"
- },
+ "name": "unlock",
+ "sig": "()",
+ "type": "function",
+ "desc": "Unlocks the selections."
+ }
+ ]
+ },
+ "Roo.bootstrap.Table.RowSelectionModel": {
+ "props": [
{
- "name": "allowDomMove",
+ "name": "singleSelect",
"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"
+ "desc": "True to allow selection of only one row at a time (defaults to false)",
+ "memberOf": ""
},
{
"name": "listeners",
],
"events": [
{
- "name": "beforedestroy",
+ "name": "afterselectionchange",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ "desc": "Fires after the selection changes (eg. by key press or clicking)"
},
{
- "name": "beforehide",
- "sig": "function (_self)\n{\n\n}",
+ "name": "beforerowselect",
+ "sig": "function (_self, rowIndex, keepExisting)\n{\n\n}",
"type": "function",
- "desc": "Fires before the component is hidden. Return false to stop the hide."
+ "desc": "Fires when a row is selected being selected, return false to cancel."
},
{
- "name": "beforerender",
- "sig": "function (_self)\n{\n\n}",
+ "name": "rowdeselect",
+ "sig": "function (_self, rowIndex)\n{\n\n}",
"type": "function",
- "desc": "Fires before the component is rendered. Return false to stop the render."
+ "desc": "Fires when a row is deselected."
},
{
- "name": "beforeshow",
- "sig": "function (_self)\n{\n\n}",
+ "name": "rowselect",
+ "sig": "function (_self, rowIndex, r)\n{\n\n}",
"type": "function",
- "desc": "Fires before the component is shown. Return false to stop the show."
+ "desc": "Fires when a row is selected."
},
{
- "name": "childrenrendered",
+ "name": "selectionchange",
"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."
+ "desc": "Fires when the selection changes"
}
],
"methods": [
"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."
},
{
- "name": "destroy",
+ "name": "clearSelections",
"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}."
+ "desc": "Clears all selections."
},
{
- "name": "disable",
- "sig": "()",
+ "name": "deselectRange",
+ "sig": "(Number startRow, Number endRow)",
"type": "function",
- "desc": "Disable this component."
+ "desc": "Deselects a range of rows. All rows in between startRow and endRow are also deselected."
},
{
- "name": "enable",
- "sig": "()",
+ "name": "deselectRow",
+ "sig": "(Number row)",
"type": "function",
- "desc": "Enable this component."
+ "desc": "Deselects a row."
},
{
"name": "fireEvent",
"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",
+ "name": "getCount",
"sig": "()",
"type": "function",
- "desc": "Fetch the element to add children to"
+ "desc": "Gets the number of selected rows."
},
{
- "name": "getEl",
+ "name": "getSelected",
"sig": "()",
"type": "function",
- "desc": "Returns the underlying {@link Roo.Element}."
+ "desc": "Returns the first selected record."
},
{
- "name": "getId",
+ "name": "getSelections",
"sig": "()",
"type": "function",
- "desc": "Returns the id of this component."
+ "desc": "Returns the selected records"
},
{
"name": "hasListener",
"desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "hide",
+ "name": "hasSelection",
"sig": "()",
"type": "function",
- "desc": "Hide a component - adds 'hidden' class"
+ "desc": "Returns True if there is a selection."
},
{
- "name": "initEvents",
+ "name": "isIdSelected",
+ "sig": "(String id)",
+ "type": "function",
+ "desc": "Returns True if the specified record id is selected."
+ },
+ {
+ "name": "isLocked",
"sig": "()",
"type": "function",
- "desc": "Initialize Events for the element"
+ "desc": "Returns true if the selections are locked."
},
{
- "name": "isVisible",
+ "name": "isSelected",
+ "sig": "(Number/Record record)",
+ "type": "function",
+ "desc": "Returns True if the specified row is selected."
+ },
+ {
+ "name": "lock",
"sig": "()",
"type": "function",
- "desc": "Returns true if this component is visible."
+ "desc": "Locks the selections."
},
{
"name": "on",
"desc": "Removes a listener"
},
{
- "name": "render",
- "sig": "(String/HTMLElement/Element container)",
+ "name": "selectAll",
+ "sig": "()",
"type": "function",
- "desc": "If this is a lazy rendering component, render it to its container element."
+ "desc": "Selects all rows."
},
{
- "name": "setDisabled",
- "sig": "(Boolean disabled)",
+ "name": "selectFirstRow",
+ "sig": "()",
"type": "function",
- "desc": "Convenience function for setting disabled/enabled by boolean."
+ "desc": "Selects the first row in the grid."
},
{
- "name": "setVisible",
- "sig": "(Boolean visible)",
+ "name": "selectLastRow",
+ "sig": "(Boolean keepExisting)",
"type": "function",
- "desc": "Convenience function to hide or show this component by boolean."
+ "desc": "Select the last row."
},
{
- "name": "show",
- "sig": "()",
+ "name": "selectNext",
+ "sig": "(Boolean keepExisting)",
"type": "function",
- "desc": "Show a component - removes 'hidden' class"
+ "desc": "Selects the row immediately following the last selected row."
},
{
- "name": "tooltipEl",
- "sig": "()",
+ "name": "selectPrevious",
+ "sig": "(Boolean keepExisting)",
"type": "function",
- "desc": "Fetch the element to display the tooltip on."
+ "desc": "Selects the row that precedes the last selected row."
+ },
+ {
+ "name": "selectRange",
+ "sig": "(Number startRow, Number endRow, Boolean keepExisting)",
+ "type": "function",
+ "desc": "Selects a range of rows. All rows in between startRow and endRow are also selected."
+ },
+ {
+ "name": "selectRecords",
+ "sig": "(Array records, Boolean keepExisting)",
+ "type": "function",
+ "desc": "Select records."
+ },
+ {
+ "name": "selectRow",
+ "sig": "(Number row, Boolean keepExisting)",
+ "type": "function",
+ "desc": "Selects a row."
+ },
+ {
+ "name": "selectRows",
+ "sig": "(Array rows, Boolean keepExisting)",
+ "type": "function",
+ "desc": "Selects multiple rows."
},
{
"name": "un",
"sig": "(String eventName, Function handler, Object scope)",
"type": "function",
"desc": "Removes a listener (shorthand for removeListener)"
+ },
+ {
+ "name": "unlock",
+ "sig": "()",
+ "type": "function",
+ "desc": "Unlocks the selections."
}
]
},
- "Roo.bootstrap.TableRow": {
+ "Roo.bootstrap.TableBody": {
"props": [
{
"name": "cls",
"type": "String",
- "desc": "row class",
+ "desc": "element class",
"memberOf": ""
},
{
- "name": "align",
+ "name": "tag",
"type": "String",
- "desc": "Aligns the content in a table row",
+ "desc": "element tag (thead|tbody|tfoot) default tbody",
"memberOf": ""
},
{
- "name": "bgcolor",
+ "name": "align",
"type": "String",
- "desc": "Specifies a background color for a table row",
+ "desc": "Aligns the content inside the element",
"memberOf": ""
},
{
"name": "charoff",
"type": "Number",
- "desc": "Sets the number of characters the content will be aligned from the character specified by the char attribute",
+ "desc": "Sets the number of characters the content inside the element will be aligned from the character specified by the char attribute",
"memberOf": ""
},
{
"name": "valign",
"type": "String",
- "desc": "Vertical aligns the content in a table row",
+ "desc": "Vertical aligns the content inside the <tbody> element",
"memberOf": ""
},
{
}
]
},
- "Roo.bootstrap.TextArea": {
+ "Roo.bootstrap.TableCell": {
"props": [
- {
- "name": "cols",
- "type": "Number",
- "desc": "Specifies the visible width of a text area",
- "memberOf": ""
- },
- {
- "name": "rows",
- "type": "Number",
- "desc": "Specifies the visible number of lines in a text area",
- "memberOf": ""
- },
- {
- "name": "wrap",
- "type": "string",
- "desc": "Specifies how the text in a text area is to be wrapped when submitted in a form",
- "memberOf": "",
- "optvals": [
- "soft",
- "hard"
- ]
- },
- {
- "name": "resize",
- "type": "string",
- "desc": "",
- "memberOf": "",
- "optvals": [
- "none",
- "both",
- "horizontal",
- "vertical",
- "inherit",
- "initial"
- ]
- },
{
"name": "html",
- "type": "string",
- "desc": "text",
- "memberOf": ""
- },
- {
- "name": "disabled",
- "type": "Boolean",
- "desc": "is it disabled",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "inputType",
"type": "String",
- "desc": "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "cell contain text",
+ "memberOf": ""
},
{
- "name": "name",
+ "name": "cls",
"type": "String",
- "desc": "name of the input",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "fieldLabel",
- "type": "string",
- "desc": "- the label associated",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "placeholder",
- "type": "string",
- "desc": "- placeholder to put in text.",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "before",
- "type": "string",
- "desc": "- input group add on before",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "after",
- "type": "string",
- "desc": "- input group add on after",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "size",
- "type": "string",
- "desc": "- (lg|sm) or leave empty..",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "xs",
- "type": "Number",
- "desc": "colspan out of 12 for mobile-sized screens",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "sm",
- "type": "Number",
- "desc": "colspan out of 12 for tablet-sized screens",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "md",
- "type": "Number",
- "desc": "colspan out of 12 for computer-sized screens",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "lg",
- "type": "Number",
- "desc": "colspan out of 12 for large computer-sized screens",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "value",
- "type": "string",
- "desc": "default value of the input",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "labelWidth",
- "type": "Number",
- "desc": "set the width of label (0-12)",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "cell class",
+ "memberOf": ""
},
{
- "name": "labelAlign",
+ "name": "tag",
"type": "String",
- "desc": "",
- "memberOf": "Roo.bootstrap.Input",
- "optvals": [
- "top",
- "left"
- ]
- },
- {
- "name": "readOnly",
- "type": "Boolean",
- "desc": "Specifies that the field should be read-only",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "cell tag (td|th) default td",
+ "memberOf": ""
},
{
- "name": "autocomplete",
+ "name": "abbr",
"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.Input"
+ "desc": "Specifies an abbreviated version of the content in a cell",
+ "memberOf": ""
},
{
"name": "align",
"type": "String",
- "desc": "Default left",
- "memberOf": "Roo.bootstrap.Input",
- "optvals": [
- "left",
- "center",
- "right"
- ]
- },
- {
- "name": "forceFeedback",
- "type": "Boolean",
- "desc": "Default false",
- "memberOf": "Roo.bootstrap.Input",
- "optvals": [
- "true",
- "false"
- ]
- },
- {
- "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.Input"
- },
- {
- "name": "validateOnBlur",
- "type": "Boolean",
- "desc": "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "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.Input"
- },
- {
- "name": "focusClass",
- "type": "String",
- "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "invalidClass",
- "type": "String",
- "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "validClass",
- "type": "String",
- "desc": "The CSS class to use when marking a field valid (defaults to \"x-form-invalid\")",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "hasFeedback",
- "type": "Boolean",
- "desc": "default true",
- "memberOf": "Roo.bootstrap.Input",
- "optvals": [
- "true",
- "false"
- ]
+ "desc": "Aligns the content in a cell",
+ "memberOf": ""
},
{
- "name": "invalidFeedbackIcon",
+ "name": "axis",
"type": "String",
- "desc": "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "Categorizes cells",
+ "memberOf": ""
},
{
- "name": "validFeedbackIcon",
+ "name": "bgcolor",
"type": "String",
- "desc": "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "Specifies the background color of a cell",
+ "memberOf": ""
},
{
- "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.Input"
+ "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": "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.Input"
+ "name": "colspan",
+ "type": "Number",
+ "desc": "Specifies the number of columns a cell should span",
+ "memberOf": ""
},
{
- "name": "vtype",
+ "name": "headers",
"type": "String",
- "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "disableKeyFilter",
- "type": "Boolean",
- "desc": "True to disable input keystroke filtering (defaults to false)",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "Specifies one or more header cells a cell is related to",
+ "memberOf": ""
},
{
- "name": "allowBlank",
- "type": "Boolean",
- "desc": "False to validate that the value length > 0 (defaults to true)",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "height",
+ "type": "Number",
+ "desc": "Sets the height of a cell",
+ "memberOf": ""
},
{
- "name": "blankText",
+ "name": "nowrap",
"type": "String",
- "desc": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "minLength",
- "type": "Number",
- "desc": "Minimum input field length required (defaults to 0)",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "Specifies that the content inside a cell should not wrap",
+ "memberOf": ""
},
{
- "name": "maxLength",
+ "name": "rowspan",
"type": "Number",
- "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "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.Input"
+ "desc": "Sets the number of rows a cell should span",
+ "memberOf": ""
},
{
- "name": "maxLengthText",
+ "name": "scope",
"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.Input"
- },
- {
- "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.Input"
- },
- {
- "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.Input"
+ "desc": "Defines a way to associate header cells and data cells in a table",
+ "memberOf": ""
},
{
- "name": "regexText",
+ "name": "valign",
"type": "String",
- "desc": "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "Vertical aligns the content in a cell",
+ "memberOf": ""
},
{
- "name": "cls",
- "type": "String",
- "desc": "css class",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "width",
+ "type": "Number",
+ "desc": "Specifies the width of a cell",
+ "memberOf": ""
},
{
"name": "style",
"desc": "cutomer id",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "name",
+ "type": "string",
+ "desc": "Specifies name attribute",
+ "memberOf": "Roo.bootstrap.Component"
+ },
{
"name": "tooltip",
"type": "string",
"type": "function",
"desc": "Fires before the component is shown. Return false to stop the show."
},
- {
- "name": "blur",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when this field loses input focus."
- },
- {
- "name": "change",
- "sig": "function (_self, newValue, oldValue)\n{\n\n}",
- "type": "function",
- "desc": "Fires just before the field blurs if the field value has changed."
- },
{
"name": "childrenrendered",
"sig": "function (_self)\n{\n\n}",
"desc": "Fires after the component is enabled."
},
{
- "name": "focus",
+ "name": "hide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when this field receives input focus."
+ "desc": "Fires after the component is hidden."
},
{
- "name": "hide",
+ "name": "render",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is hidden."
+ "desc": "Fires after the component is rendered."
},
{
- "name": "invalid",
- "sig": "function (_self, msg)\n{\n\n}",
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the field has been marked as invalid."
+ "desc": "Fires after the component is shown."
+ }
+ ],
+ "methods": [
+ {
+ "name": "addEvents",
+ "sig": "(Object object)",
+ "type": "function",
+ "desc": "Used to define events on this Observable"
},
{
- "name": "keyup",
- "sig": "function (_self, e)\n{\n\n}",
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "Fires after the key up"
+ "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\n<b>before</b> 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 <b>all</b> added captures from the Observable."
+ },
+ {
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
},
{
"name": "render",
- "sig": "function (_self)\n{\n\n}",
+ "sig": "(String/HTMLElement/Element container)",
"type": "function",
- "desc": "Fires after the component is rendered."
+ "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.bootstrap.TableRow": {
+ "props": [
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "row class",
+ "memberOf": ""
+ },
+ {
+ "name": "align",
+ "type": "String",
+ "desc": "Aligns the content in a table row",
+ "memberOf": ""
+ },
+ {
+ "name": "bgcolor",
+ "type": "String",
+ "desc": "Specifies a background color for a table row",
+ "memberOf": ""
+ },
+ {
+ "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": "valign",
+ "type": "String",
+ "desc": "Vertical aligns the content in a table row",
+ "memberOf": ""
+ },
+ {
+ "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<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "beforedestroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is shown."
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
},
{
- "name": "specialkey",
- "sig": "function (_self, e)\n{\n\n}",
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
"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."
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
},
{
- "name": "valid",
+ "name": "beforerender",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the field has been validated with no errors."
+ "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": [
"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."
},
- {
- "name": "clearInvalid",
- "sig": "()",
- "type": "function",
- "desc": "Clear any invalid styles/messages for this field"
- },
{
"name": "destroy",
"sig": "()",
"type": "function",
"desc": "Returns the id of this component."
},
- {
- "name": "getName",
- "sig": "()",
- "type": "function",
- "desc": "Returns the name of the field"
- },
- {
- "name": "getRawValue",
- "sig": "()",
- "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}."
- },
- {
- "name": "getValue",
- "sig": "()",
- "type": "function",
- "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
- },
{
"name": "hasListener",
"sig": "(String eventName)",
"type": "function",
"desc": "Initialize Events for the element"
},
- {
- "name": "inputEl",
- "sig": "()",
- "type": "function",
- "desc": "return the real textarea element."
- },
{
"name": "isVisible",
"sig": "()",
"type": "function",
"desc": "Returns true if this component is visible."
},
- {
- "name": "markInvalid",
- "sig": "(String msg)",
- "type": "function",
- "desc": "Mark this field as invalid"
- },
- {
- "name": "markValid",
- "sig": "()",
- "type": "function",
- "desc": "Mark this field as valid"
- },
{
"name": "on",
"sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
"desc": "If this is a lazy rendering component, render it to its container element."
},
- {
- "name": "reset",
- "sig": "()",
- "type": "function",
- "desc": "Resets the current field value to the originally loaded value and clears any validation messages"
- },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
"type": "function",
"desc": "Convenience function for setting disabled/enabled by boolean."
},
- {
- "name": "setRawValue",
- "sig": "(Mixed value)",
- "type": "function",
- "desc": "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}."
- },
- {
- "name": "setValue",
- "sig": "(Mixed value)",
- "type": "function",
- "desc": "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}."
- },
{
"name": "setVisible",
"sig": "(Boolean visible)",
"sig": "(String eventName, Function handler, Object scope)",
"type": "function",
"desc": "Removes a listener (shorthand for removeListener)"
- },
- {
- "name": "validate",
- "sig": "()",
- "type": "function",
- "desc": "Validates the field value"
- },
- {
- "name": "validateValue",
- "sig": "(Mixed value)",
- "type": "function",
- "desc": "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails"
}
]
},
- "Roo.bootstrap.TimeField": {
+ "Roo.bootstrap.TextArea": {
"props": [
{
- "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').",
+ "name": "cols",
+ "type": "Number",
+ "desc": "Specifies the visible width of a text area",
+ "memberOf": ""
+ },
+ {
+ "name": "rows",
+ "type": "Number",
+ "desc": "Specifies the visible number of lines in a text area",
+ "memberOf": ""
+ },
+ {
+ "name": "wrap",
+ "type": "string",
+ "desc": "Specifies how the text in a text area is to be wrapped when submitted in a form",
+ "memberOf": "",
+ "optvals": [
+ "soft",
+ "hard"
+ ]
+ },
+ {
+ "name": "resize",
+ "type": "string",
+ "desc": "",
+ "memberOf": "",
+ "optvals": [
+ "none",
+ "both",
+ "horizontal",
+ "vertical",
+ "inherit",
+ "initial"
+ ]
+ },
+ {
+ "name": "html",
+ "type": "string",
+ "desc": "text",
"memberOf": ""
},
{
"desc": "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
"memberOf": "Roo.bootstrap.Input"
},
+ {
+ "name": "indicatorpos",
+ "type": "String",
+ "desc": "default left",
+ "memberOf": "Roo.bootstrap.Input",
+ "optvals": [
+ "left",
+ "right"
+ ]
+ },
{
"name": "align",
"type": "String",
"type": "function",
"desc": "Fires after the component is rendered."
},
- {
- "name": "select",
- "sig": "function (_self, date)\n{\n\n}",
- "type": "function",
- "desc": "Fires when select a date."
- },
{
"name": "show",
- "sig": "function (thisthis, date)\n{\n\n}",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when this field show."
+ "desc": "Fires after the component is shown."
},
{
"name": "specialkey",
"name": "inputEl",
"sig": "()",
"type": "function",
- "desc": "return the real input element."
+ "desc": "return the real textarea element."
},
{
"name": "isVisible",
}
]
},
- "Roo.bootstrap.Tooltip": {
- "props": [],
- "events": [],
- "methods": [
- {
- "name": "currentEl",
- "sig": "()",
- "type": "function",
- "desc": ""
- }
- ]
- },
- "Roo.bootstrap.TriggerField": {
+ "Roo.bootstrap.TimeField": {
"props": [
{
- "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": ""
- },
- {
- "name": "caret",
+ "name": "format",
"type": "String",
- "desc": "a fontawesome for the trigger icon see http://fortawesome.github.io/Font-Awesome/icons/",
- "memberOf": "",
- "optvals": [
- "search",
- "calendar"
- ]
- },
- {
- "name": "hideTrigger",
- "type": "Boolean",
- "desc": "True to hide the trigger element and display only the base text field (defaults to false)",
+ "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": ""
},
- {
- "name": "removable",
- "type": "Boolean",
- "desc": "special filter default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
- },
{
"name": "disabled",
"type": "Boolean",
"desc": "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
"memberOf": "Roo.bootstrap.Input"
},
+ {
+ "name": "indicatorpos",
+ "type": "String",
+ "desc": "default left",
+ "memberOf": "Roo.bootstrap.Input",
+ "optvals": [
+ "left",
+ "right"
+ ]
+ },
{
"name": "align",
"type": "String",
"type": "function",
"desc": "Fires after the component is rendered."
},
+ {
+ "name": "select",
+ "sig": "function (_self, date)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when select a date."
+ },
{
"name": "show",
- "sig": "function (_self)\n{\n\n}",
+ "sig": "function (thisthis, date)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is shown."
+ "desc": "Fires when this field show."
},
{
"name": "specialkey",
"type": "function",
"desc": "Appends an event handler to this element (shorthand for addListener)"
},
- {
- "name": "onTriggerClick",
- "sig": "(EventObject e)",
- "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."
- },
{
"name": "purgeListeners",
"sig": "()",
}
]
},
- "Roo.bootstrap.UploadCropbox": {
+ "Roo.bootstrap.Tooltip": {
+ "props": [],
+ "events": [],
+ "methods": [
+ {
+ "name": "currentEl",
+ "sig": "()",
+ "type": "function",
+ "desc": ""
+ }
+ ]
+ },
+ "Roo.bootstrap.TriggerField": {
"props": [
{
- "name": "emptyText",
+ "name": "triggerClass",
"type": "String",
- "desc": "show when image has been loaded",
+ "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": ""
},
{
- "name": "rotateNotify",
+ "name": "caret",
"type": "String",
- "desc": "show when image too small to rotate",
+ "desc": "a fontawesome for the trigger icon see http://fortawesome.github.io/Font-Awesome/icons/",
+ "memberOf": "",
+ "optvals": [
+ "search",
+ "calendar"
+ ]
+ },
+ {
+ "name": "hideTrigger",
+ "type": "Boolean",
+ "desc": "True to hide the trigger element and display only the base text field (defaults to false)",
"memberOf": ""
},
{
- "name": "errorTimeout",
+ "name": "removable",
+ "type": "Boolean",
+ "desc": "special filter default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "is it disabled",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "inputType",
+ "type": "String",
+ "desc": "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "name",
+ "type": "String",
+ "desc": "name of the input",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "fieldLabel",
+ "type": "string",
+ "desc": "- the label associated",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "placeholder",
+ "type": "string",
+ "desc": "- placeholder to put in text.",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "before",
+ "type": "string",
+ "desc": "- input group add on before",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "after",
+ "type": "string",
+ "desc": "- input group add on after",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "size",
+ "type": "string",
+ "desc": "- (lg|sm) or leave empty..",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "xs",
"type": "Number",
- "desc": "default 3000",
- "memberOf": ""
+ "desc": "colspan out of 12 for mobile-sized screens",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "minWidth",
+ "name": "sm",
"type": "Number",
- "desc": "default 300",
- "memberOf": ""
+ "desc": "colspan out of 12 for tablet-sized screens",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "minHeight",
+ "name": "md",
"type": "Number",
- "desc": "default 300",
- "memberOf": ""
+ "desc": "colspan out of 12 for computer-sized screens",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "buttons",
- "type": "Array",
- "desc": "default ['rotateLeft', 'pictureBtn', 'rotateRight']",
- "memberOf": ""
+ "name": "lg",
+ "type": "Number",
+ "desc": "colspan out of 12 for large computer-sized screens",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "isDocument",
+ "name": "value",
+ "type": "string",
+ "desc": "default value of the input",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelWidth",
+ "type": "Number",
+ "desc": "set the width of label (0-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelAlign",
+ "type": "String",
+ "desc": "",
+ "memberOf": "Roo.bootstrap.Input",
+ "optvals": [
+ "top",
+ "left"
+ ]
+ },
+ {
+ "name": "readOnly",
"type": "Boolean",
- "desc": "default false",
- "memberOf": "",
+ "desc": "Specifies that the field should be read-only",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "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.Input"
+ },
+ {
+ "name": "indicatorpos",
+ "type": "String",
+ "desc": "default left",
+ "memberOf": "Roo.bootstrap.Input",
+ "optvals": [
+ "left",
+ "right"
+ ]
+ },
+ {
+ "name": "align",
+ "type": "String",
+ "desc": "Default left",
+ "memberOf": "Roo.bootstrap.Input",
+ "optvals": [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ {
+ "name": "forceFeedback",
+ "type": "Boolean",
+ "desc": "Default false",
+ "memberOf": "Roo.bootstrap.Input",
"optvals": [
"true",
"false"
]
},
{
- "name": "url",
+ "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.Input"
+ },
+ {
+ "name": "validateOnBlur",
+ "type": "Boolean",
+ "desc": "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "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.Input"
+ },
+ {
+ "name": "focusClass",
"type": "String",
- "desc": "action url",
- "memberOf": ""
+ "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "paramName",
+ "name": "invalidClass",
"type": "String",
- "desc": "default 'imageUpload'",
- "memberOf": ""
+ "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "method",
+ "name": "validClass",
"type": "String",
- "desc": "default POST",
- "memberOf": ""
+ "desc": "The CSS class to use when marking a field valid (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "loadMask",
+ "name": "hasFeedback",
"type": "Boolean",
"desc": "default true",
- "memberOf": "",
+ "memberOf": "Roo.bootstrap.Input",
"optvals": [
"true",
"false"
]
},
{
- "name": "loadingText",
+ "name": "invalidFeedbackIcon",
+ "type": "String",
+ "desc": "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "validFeedbackIcon",
+ "type": "String",
+ "desc": "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "selectOnFocus",
"type": "Boolean",
- "desc": "default 'Loading...'",
- "memberOf": ""
+ "desc": "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "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.Input"
+ },
+ {
+ "name": "vtype",
+ "type": "String",
+ "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "disableKeyFilter",
+ "type": "Boolean",
+ "desc": "True to disable input keystroke filtering (defaults to false)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "allowBlank",
+ "type": "Boolean",
+ "desc": "False to validate that the value length > 0 (defaults to true)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "blankText",
+ "type": "String",
+ "desc": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "minLength",
+ "type": "Number",
+ "desc": "Minimum input field length required (defaults to 0)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "maxLength",
+ "type": "Number",
+ "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "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.Input"
+ },
+ {
+ "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.Input"
+ },
+ {
+ "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.Input"
+ },
+ {
+ "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.Input"
+ },
+ {
+ "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.bootstrap.Input"
},
{
"name": "cls",
"desc": "cutomer id",
"memberOf": "Roo.bootstrap.Component"
},
- {
- "name": "name",
- "type": "string",
- "desc": "Specifies name attribute",
- "memberOf": "Roo.bootstrap.Component"
- },
{
"name": "tooltip",
"type": "string",
}
],
"events": [
- {
- "name": "arrange",
- "sig": "function (_self, formData)\n{\n\n}",
- "type": "function",
- "desc": "Fire when arrange the file data"
- },
{
"name": "beforedestroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires before the component is hidden. Return false to stop the hide."
},
- {
- "name": "beforeloadcanvas",
- "sig": "function (_self, src)\n{\n\n}",
- "type": "function",
- "desc": "Fire before load the canvas"
- },
{
"name": "beforerender",
"sig": "function (_self)\n{\n\n}",
"desc": "Fires before the component is rendered. Return false to stop the render."
},
{
- "name": "beforeselectfile",
+ "name": "beforeshow",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fire before select file"
+ "desc": "Fires before the component is shown. Return false to stop the show."
},
{
- "name": "beforeshow",
+ "name": "blur",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires before the component is shown. Return false to stop the show."
+ "desc": "Fires when this field loses input focus."
},
{
- "name": "childrenrendered",
- "sig": "function (_self)\n{\n\n}",
+ "name": "change",
+ "sig": "function (_self, newValue, oldValue)\n{\n\n}",
"type": "function",
- "desc": "Fires when the children have been rendered.."
+ "desc": "Fires just before the field blurs if the field value has changed."
},
{
- "name": "crop",
- "sig": "function (_self, data)\n{\n\n}",
+ "name": "childrenrendered",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fire after initEvent"
+ "desc": "Fires when the children have been rendered.."
},
{
"name": "destroy",
"type": "function",
"desc": "Fires after the component is disabled."
},
- {
- "name": "download",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fire when download the image"
- },
{
"name": "enable",
"sig": "function (_self)\n{\n\n}",
"desc": "Fires after the component is enabled."
},
{
- "name": "exception",
- "sig": "function (_self, xhr)\n{\n\n}",
- "type": "function",
- "desc": "Fire when get exception"
- },
- {
- "name": "footerbuttonclick",
- "sig": "function (_self, type)\n{\n\n}",
+ "name": "focus",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fire when footerbuttonclick"
+ "desc": "Fires when this field receives input focus."
},
{
"name": "hide",
"desc": "Fires after the component is hidden."
},
{
- "name": "initial",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fire after initEvent"
- },
- {
- "name": "inspect",
- "sig": "function (_self, file)\n{\n\n}",
+ "name": "invalid",
+ "sig": "function (_self, msg)\n{\n\n}",
"type": "function",
- "desc": "Fire when inspect the file"
+ "desc": "Fires after the field has been marked as invalid."
},
{
- "name": "prepare",
- "sig": "function (_self, file)\n{\n\n}",
+ "name": "keyup",
+ "sig": "function (_self, e)\n{\n\n}",
"type": "function",
- "desc": "Fire when preparing the file data"
+ "desc": "Fires after the key up"
},
{
"name": "render",
"type": "function",
"desc": "Fires after the component is rendered."
},
- {
- "name": "resize",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fire when resize"
- },
- {
- "name": "rotate",
- "sig": "function (_self, pos)\n{\n\n}",
- "type": "function",
- "desc": "Fire when rotate the image"
- },
{
"name": "show",
"sig": "function (_self)\n{\n\n}",
"desc": "Fires after the component is shown."
},
{
- "name": "trash",
- "sig": "function (_self)\n{\n\n}",
+ "name": "specialkey",
+ "sig": "function (_self, e)\n{\n\n}",
"type": "function",
- "desc": "Fire when trash image"
+ "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."
},
{
- "name": "upload",
- "sig": "function (_self, data)\n{\n\n}",
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fire when xhr upload the file"
+ "desc": "Fires after the field has been validated with no errors."
}
],
"methods": [
"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."
},
+ {
+ "name": "clearInvalid",
+ "sig": "()",
+ "type": "function",
+ "desc": "Clear any invalid styles/messages for this field"
+ },
{
"name": "destroy",
"sig": "()",
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getName",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the name of the field"
+ },
+ {
+ "name": "getRawValue",
+ "sig": "()",
+ "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}."
+ },
+ {
+ "name": "getValue",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"type": "function",
"desc": "Initialize Events for the element"
},
+ {
+ "name": "inputEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "return the real input element."
+ },
{
"name": "isVisible",
"sig": "()",
"type": "function",
"desc": "Returns true if this component is visible."
},
+ {
+ "name": "markInvalid",
+ "sig": "(String msg)",
+ "type": "function",
+ "desc": "Mark this field as invalid"
+ },
+ {
+ "name": "markValid",
+ "sig": "()",
+ "type": "function",
+ "desc": "Mark this field as valid"
+ },
{
"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": "onTriggerClick",
+ "sig": "(EventObject e)",
+ "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."
+ },
{
"name": "purgeListeners",
"sig": "()",
"type": "function",
"desc": "If this is a lazy rendering component, render it to its container element."
},
+ {
+ "name": "reset",
+ "sig": "()",
+ "type": "function",
+ "desc": "Resets the current field value to the originally loaded value and clears any validation messages"
+ },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
"type": "function",
"desc": "Convenience function for setting disabled/enabled by boolean."
},
+ {
+ "name": "setRawValue",
+ "sig": "(Mixed value)",
+ "type": "function",
+ "desc": "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}."
+ },
+ {
+ "name": "setValue",
+ "sig": "(Mixed value)",
+ "type": "function",
+ "desc": "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}."
+ },
{
"name": "setVisible",
"sig": "(Boolean visible)",
"sig": "(String eventName, Function handler, Object scope)",
"type": "function",
"desc": "Removes a listener (shorthand for removeListener)"
+ },
+ {
+ "name": "validate",
+ "sig": "()",
+ "type": "function",
+ "desc": "Validates the field value"
+ },
+ {
+ "name": "validateValue",
+ "sig": "(Mixed value)",
+ "type": "function",
+ "desc": "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails"
}
]
},
- "Roo.bootstrap.dash": {
- "props": [],
- "events": [],
- "methods": []
- },
- "Roo.bootstrap.dash.NumberBox": {
+ "Roo.bootstrap.UploadCropbox": {
"props": [
{
- "name": "headline",
+ "name": "emptyText",
"type": "String",
- "desc": "Box headline",
+ "desc": "show when image has been loaded",
"memberOf": ""
},
{
- "name": "content",
+ "name": "rotateNotify",
"type": "String",
- "desc": "Box content",
+ "desc": "show when image too small to rotate",
"memberOf": ""
},
{
- "name": "icon",
+ "name": "errorTimeout",
+ "type": "Number",
+ "desc": "default 3000",
+ "memberOf": ""
+ },
+ {
+ "name": "minWidth",
+ "type": "Number",
+ "desc": "default 300",
+ "memberOf": ""
+ },
+ {
+ "name": "minHeight",
+ "type": "Number",
+ "desc": "default 300",
+ "memberOf": ""
+ },
+ {
+ "name": "buttons",
+ "type": "Array",
+ "desc": "default ['rotateLeft', 'pictureBtn', 'rotateRight']",
+ "memberOf": ""
+ },
+ {
+ "name": "isDocument",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "url",
"type": "String",
- "desc": "Box icon",
+ "desc": "action url",
"memberOf": ""
},
{
- "name": "footer",
+ "name": "paramName",
"type": "String",
- "desc": "Footer text",
+ "desc": "default 'imageUpload'",
"memberOf": ""
},
{
- "name": "fhref",
+ "name": "method",
"type": "String",
- "desc": "Footer href",
+ "desc": "default POST",
+ "memberOf": ""
+ },
+ {
+ "name": "loadMask",
+ "type": "Boolean",
+ "desc": "default true",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "loadingText",
+ "type": "Boolean",
+ "desc": "default 'Loading...'",
+ "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<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "arrange",
+ "sig": "function (_self, formData)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire when arrange the file data"
+ },
+ {
+ "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": "beforeloadcanvas",
+ "sig": "function (_self, src)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire before load the canvas"
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeselectfile",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire before select file"
+ },
+ {
+ "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": "crop",
+ "sig": "function (_self, data)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire after initEvent"
+ },
+ {
+ "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": "download",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire when download the image"
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "exception",
+ "sig": "function (_self, xhr)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire when get exception"
+ },
+ {
+ "name": "footerbuttonclick",
+ "sig": "function (_self, type)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire when footerbuttonclick"
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "initial",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire after initEvent"
+ },
+ {
+ "name": "inspect",
+ "sig": "function (_self, file)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire when inspect the file"
+ },
+ {
+ "name": "prepare",
+ "sig": "function (_self, file)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire when preparing the file data"
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "resize",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire when resize"
+ },
+ {
+ "name": "rotate",
+ "sig": "function (_self, pos)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire when rotate the image"
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ },
+ {
+ "name": "trash",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire when trash image"
+ },
+ {
+ "name": "upload",
+ "sig": "function (_self, data)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire when xhr upload the file"
+ }
+ ],
+ "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\n<b>before</b> 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 <b>all</b> 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.bootstrap.dash": {
+ "props": [],
+ "events": [],
+ "methods": []
+ },
+ "Roo.bootstrap.dash.NumberBox": {
+ "props": [
+ {
+ "name": "headline",
+ "type": "String",
+ "desc": "Box headline",
+ "memberOf": ""
+ },
+ {
+ "name": "content",
+ "type": "String",
+ "desc": "Box content",
+ "memberOf": ""
+ },
+ {
+ "name": "icon",
+ "type": "String",
+ "desc": "Box icon",
+ "memberOf": ""
+ },
+ {
+ "name": "footer",
+ "type": "String",
+ "desc": "Footer text",
+ "memberOf": ""
+ },
+ {
+ "name": "fhref",
+ "type": "String",
+ "desc": "Footer href",
"memberOf": ""
},
{
}
]
},
- "Roo.bootstrap.menu": {
+ "Roo.bootstrap.layout": {
"props": [],
"events": [],
"methods": []
},
- "Roo.bootstrap.menu.Item": {
+ "Roo.bootstrap.layout.Basic": {
"props": [
{
- "name": "submenu",
- "type": "Boolean",
- "desc": "default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
- },
- {
- "name": "html",
- "type": "String",
- "desc": "text of the item",
- "memberOf": ""
- },
- {
- "name": "href",
- "type": "String",
- "desc": "the link",
+ "name": "mgr",
+ "type": "Roo.bootstrap.layout.Manager",
+ "desc": "The manager",
"memberOf": ""
},
{
- "name": "disable",
- "type": "Boolean",
- "desc": "default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
- },
- {
- "name": "preventDefault",
- "type": "Boolean",
- "desc": "default true",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
- },
- {
- "name": "icon",
- "type": "String",
- "desc": "Font awesome icon",
+ "name": "region",
+ "type": "string",
+ "desc": "the region that it inhabits..",
"memberOf": ""
},
{
- "name": "pos",
- "type": "String",
- "desc": "Submenu align to (left | right) default right",
+ "name": "skipConfig",
+ "type": "bool",
+ "desc": "skip config?",
"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",
"memberOf": "Roo.util.Observable"
}
],
- "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": "click",
- "sig": "function (e)\n{\n\n}",
- "type": "function",
- "desc": "The raw click event for the entire grid."
- },
- {
- "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": "mouseout",
- "sig": "function (_self, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the mouse exits this menu"
- },
- {
- "name": "mouseover",
- "sig": "function (_self, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the mouse is hovering over this menu"
- },
+ "events": [],
+ "methods": [
{
- "name": "render",
- "sig": "function (_self)\n{\n\n}",
+ "name": "add",
+ "sig": "(ContentPanel... panel)",
"type": "function",
- "desc": "Fires after the component is rendered."
+ "desc": "Add the passed ContentPanel(s)"
},
- {
- "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": "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."
},
- {
- "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)",
"desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "focus",
- "sig": "(Boolean selectText)",
+ "name": "getActivePanel",
+ "sig": "()",
"type": "function",
- "desc": "Try to focus this component."
+ "desc": "Get the active panel for this region."
},
{
- "name": "getChildContainer",
+ "name": "getEl",
"sig": "()",
"type": "function",
- "desc": "Fetch the element to add children to"
+ "desc": "Returns the container element for this region."
},
{
- "name": "getEl",
- "sig": "()",
+ "name": "getPanel",
+ "sig": "(Number/String/ContentPanel panel)",
"type": "function",
- "desc": "Returns the underlying {@link Roo.Element}."
+ "desc": "Returns the panel specified or null if it's not in this region."
},
{
- "name": "getId",
+ "name": "getPosition",
"sig": "()",
"type": "function",
- "desc": "Returns the id of this component."
+ "desc": "Returns this regions position (north/south/east/west/center)."
},
{
"name": "hasListener",
"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": "()",
+ "name": "hasPanel",
+ "sig": "(Number/String/ContentPanel panel)",
"type": "function",
- "desc": "Initialize Events for the element"
+ "desc": "Returns true if the panel is in this region."
},
{
"name": "isVisible",
"sig": "()",
"type": "function",
- "desc": "Returns true if this component is visible."
+ "desc": "Returns true if this region is currently visible."
},
{
"name": "on",
"desc": "Removes <b>all</b> 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)",
+ "name": "remove",
+ "sig": "(Number/String/ContentPanel panel, Boolean preservePanel)",
"type": "function",
- "desc": "Convenience function for setting disabled/enabled by boolean."
+ "desc": "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed."
},
{
- "name": "setVisible",
- "sig": "(Boolean visible)",
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
"type": "function",
- "desc": "Convenience function to hide or show this component by boolean."
+ "desc": "Removes a listener"
},
{
- "name": "show",
- "sig": "()",
+ "name": "resizeTo",
+ "sig": "(Number newSize)",
"type": "function",
- "desc": "Show a component - removes 'hidden' class"
+ "desc": "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height."
},
{
- "name": "tooltipEl",
- "sig": "()",
+ "name": "showPanel",
+ "sig": "(Number/String/ContentPanel panelId)",
"type": "function",
- "desc": "Fetch the element to display the tooltip on."
+ "desc": "Show the specified panel."
},
{
"name": "un",
}
]
},
- "Roo.bootstrap.menu.Menu": {
+ "Roo.bootstrap.layout.Border": {
"props": [
- {
- "name": "html",
- "type": "String",
- "desc": "Text of the menu",
- "memberOf": ""
- },
- {
- "name": "weight",
- "type": "String",
- "desc": "",
- "memberOf": "",
- "optvals": [
- "default",
- "primary",
- "success",
- "info",
- "warning",
- "danger",
- "inverse"
- ]
- },
- {
- "name": "icon",
- "type": "String",
- "desc": "Font awesome icon",
- "memberOf": ""
- },
- {
- "name": "pos",
- "type": "String",
- "desc": "Menu align to (top | bottom) default bottom",
- "memberOf": ""
- },
{
"name": "cls",
"type": "String",
"name": "beforehide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires before this menu is hidden"
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
},
{
"name": "beforerender",
"name": "beforeshow",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires before this menu is displayed"
+ "desc": "Fires before the component is shown. Return false to stop the show."
},
{
"name": "childrenrendered",
"type": "function",
"desc": "Fires when the children have been rendered.."
},
- {
- "name": "click",
- "sig": "function (_self, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires when this menu is clicked (or when the enter key is pressed while it is active)"
- },
{
"name": "destroy",
"sig": "function (_self)\n{\n\n}",
"name": "hide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after this menu is hidden"
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "layout",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a layout is performed."
+ },
+ {
+ "name": "regioncollapsed",
+ "sig": "function (region)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a region is collapsed."
+ },
+ {
+ "name": "regionexpanded",
+ "sig": "function (region)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a region is expanded."
+ },
+ {
+ "name": "regionresized",
+ "sig": "function (region, newSize)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the user resizes a region."
},
{
"name": "render",
"name": "show",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after this menu is displayed"
+ "desc": "Fires after the component is shown."
}
],
"methods": [
+ {
+ "name": "add",
+ "sig": "(String target, Roo.ContentPanel panel)",
+ "type": "function",
+ "desc": "Adds a ContentPanel (or subclass) to this layout."
+ },
{
"name": "addEvents",
"sig": "(Object object)",
"type": "function",
"desc": "Appends an event handler to this component"
},
+ {
+ "name": "addRegion",
+ "sig": "(String target, Object config)",
+ "type": "function",
+ "desc": "Creates and adds a new region if it doesn't already exist."
+ },
+ {
+ "name": "addxtype",
+ "sig": "(Object cfg)",
+ "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>"
+ },
+ {
+ "name": "beginUpdate",
+ "sig": "()",
+ "type": "function",
+ "desc": "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls"
+ },
{
"name": "capture",
"sig": "(Observable o, Function fn, Object scope)",
"type": "function",
"desc": "Enable this component."
},
+ {
+ "name": "endUpdate",
+ "sig": "(Boolean noLayout)",
+ "type": "function",
+ "desc": "Restore auto-layouts and optionally disable the manager from performing a layout"
+ },
+ {
+ "name": "findPanel",
+ "sig": "(String panelId)",
+ "type": "function",
+ "desc": "Searches all regions for a panel with the specified id"
+ },
{
"name": "fireEvent",
"sig": "(String eventName, Object... args)",
"name": "getEl",
"sig": "()",
"type": "function",
- "desc": "Returns the underlying {@link Roo.Element}."
+ "desc": "Returns the Element this layout is bound to."
},
{
"name": "getId",
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getRegion",
+ "sig": "(String target)",
+ "type": "function",
+ "desc": "Returns the specified region."
+ },
+ {
+ "name": "getViewSize",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"type": "function",
"desc": "Initialize Events for the element"
},
+ {
+ "name": "isUpdating",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if this layout is currently being updated"
+ },
{
"name": "isVisible",
"sig": "()",
"type": "function",
"desc": "Returns true if this component is visible."
},
+ {
+ "name": "layout",
+ "sig": "()",
+ "type": "function",
+ "desc": "Performs a layout update."
+ },
{
"name": "on",
"sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
"desc": "Removes <b>all</b> added captures from the Observable."
},
+ {
+ "name": "remove",
+ "sig": "(String target, Number/String/Roo.ContentPanel panel)",
+ "type": "function",
+ "desc": "Remove a ContentPanel (or subclass) to this layout."
+ },
{
"name": "removeListener",
"sig": "(String eventName, Function handler, Object scope)",
"type": "function",
"desc": "Show a component - removes 'hidden' class"
},
+ {
+ "name": "showPanel",
+ "sig": "(String/ContentPanel panelId)",
+ "type": "function",
+ "desc": "Searches all regions for a panel with the specified id and activates (shows) it."
+ },
{
"name": "tooltipEl",
"sig": "()",
}
]
},
- "Roo.bootstrap.menu.Separator": {
+ "Roo.bootstrap.layout.Manager": {
"props": [
{
"name": "cls",
"type": "function",
"desc": "Fires after the component is hidden."
},
+ {
+ "name": "layout",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a layout is performed."
+ },
+ {
+ "name": "regioncollapsed",
+ "sig": "function (region)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a region is collapsed."
+ },
+ {
+ "name": "regionexpanded",
+ "sig": "function (region)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a region is expanded."
+ },
+ {
+ "name": "regionresized",
+ "sig": "function (region, newSize)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the user resizes a region."
+ },
{
"name": "render",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Appends an event handler to this component"
},
+ {
+ "name": "beginUpdate",
+ "sig": "()",
+ "type": "function",
+ "desc": "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls"
+ },
{
"name": "capture",
"sig": "(Observable o, Function fn, Object scope)",
"type": "function",
"desc": "Enable this component."
},
+ {
+ "name": "endUpdate",
+ "sig": "(Boolean noLayout)",
+ "type": "function",
+ "desc": "Restore auto-layouts and optionally disable the manager from performing a layout"
+ },
{
"name": "fireEvent",
"sig": "(String eventName, Object... args)",
"name": "getEl",
"sig": "()",
"type": "function",
- "desc": "Returns the underlying {@link Roo.Element}."
+ "desc": "Returns the Element this layout is bound to."
},
{
"name": "getId",
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getRegion",
+ "sig": "(String target)",
+ "type": "function",
+ "desc": "Returns the specified region."
+ },
+ {
+ "name": "getViewSize",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"type": "function",
"desc": "Initialize Events for the element"
},
+ {
+ "name": "isUpdating",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if this layout is currently being updated"
+ },
{
"name": "isVisible",
"sig": "()",
}
]
},
- "Roo.data": {
- "props": [],
- "events": [],
- "methods": []
- },
- "Roo.data.ArrayReader": {
+ "Roo.bootstrap.layout.Region": {
+ "props": [
+ {
+ "name": "margins",
+ "type": "Object",
+ "desc": "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
+ "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": ""
+ },
+ {
+ "name": "tabPosition",
+ "type": "String",
+ "desc": "\"top\" or \"bottom\" (defaults to \"bottom\")",
+ "memberOf": "",
+ "optvals": [
+ "top",
+ "bottom"
+ ]
+ },
+ {
+ "name": "alwaysShowTabs",
+ "type": "Boolean",
+ "desc": "True to always display tabs even when there is only 1 panel (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "autoScroll",
+ "type": "Boolean",
+ "desc": "True to enable overflow scrolling (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "titlebar",
+ "type": "Boolean",
+ "desc": "True to display a title bar (defaults to true)",
+ "memberOf": ""
+ },
+ {
+ "name": "title",
+ "type": "String",
+ "desc": "The title for the region (overrides panel titles)",
+ "memberOf": ""
+ },
+ {
+ "name": "animate",
+ "type": "Boolean",
+ "desc": "True to animate expand/collapse (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "autoHide",
+ "type": "Boolean",
+ "desc": "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
+ "memberOf": ""
+ },
+ {
+ "name": "preservePanels",
+ "type": "Boolean",
+ "desc": "True to preserve removed panels so they can be readded later (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "closeOnTab",
+ "type": "Boolean",
+ "desc": "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "hideTabs",
+ "type": "Boolean",
+ "desc": "True to hide the tab strip (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "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": ""
+ },
+ {
+ "name": "minTabWidth",
+ "type": "Number",
+ "desc": "The minimum tab width (defaults to 40)",
+ "memberOf": ""
+ },
+ {
+ "name": "preferredTabWidth",
+ "type": "Number",
+ "desc": "The preferred tab width (defaults to 150)",
+ "memberOf": ""
+ },
+ {
+ "name": "overflow",
+ "type": "String",
+ "desc": "if you have menus in the region, then you need to set this to visible.",
+ "memberOf": "",
+ "optvals": [
+ "hidden",
+ "visible"
+ ]
+ },
+ {
+ "name": "hidden",
+ "type": "Boolean",
+ "desc": "True to start the region hidden (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "hideWhenEmpty",
+ "type": "Boolean",
+ "desc": "True to hide the region when it has no panels",
+ "memberOf": ""
+ },
+ {
+ "name": "disableTabTips",
+ "type": "Boolean",
+ "desc": "True to disable tab tooltips",
+ "memberOf": ""
+ },
+ {
+ "name": "width",
+ "type": "Number",
+ "desc": "For East/West panels",
+ "memberOf": ""
+ },
+ {
+ "name": "height",
+ "type": "Number",
+ "desc": "For North/South panels",
+ "memberOf": ""
+ },
+ {
+ "name": "split",
+ "type": "Boolean",
+ "desc": "To show the splitter",
+ "memberOf": ""
+ },
+ {
+ "name": "toolbar",
+ "type": "Boolean",
+ "desc": "xtype configuration for a toolbar - shows on right of tabbar",
+ "memberOf": ""
+ },
+ {
+ "name": "cls",
+ "type": "string",
+ "desc": "Extra CSS classes to add to region",
+ "memberOf": ""
+ },
+ {
+ "name": "mgr",
+ "type": "Roo.bootstrap.layout.Manager",
+ "desc": "The manager",
+ "memberOf": ""
+ },
+ {
+ "name": "region",
+ "type": "string",
+ "desc": "the region that it inhabits..",
+ "memberOf": ""
+ },
+ {
+ "name": "skipConfig",
+ "type": "bool",
+ "desc": "skip config?",
+ "memberOf": "Roo.bootstrap.layout.Basic"
+ },
+ {
+ "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"
+ }
+ ],
+ "events": [],
+ "methods": [
+ {
+ "name": "add",
+ "sig": "(ContentPanel... panel)",
+ "type": "function",
+ "desc": "Adds the passed ContentPanel(s) to this region."
+ },
+ {
+ "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": "animateCollapse",
+ "sig": "(Boolean skipAnim)",
+ "type": "function",
+ "desc": "Collapses this region."
+ },
+ {
+ "name": "animateExpand",
+ "sig": "(Roo.EventObject e, Boolean skipAnim)",
+ "type": "function",
+ "desc": "Expands this region if it was previously collapsed."
+ },
+ {
+ "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\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire."
+ },
+ {
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ },
+ {
+ "name": "getActivePanel",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the active panel for this region."
+ },
+ {
+ "name": "getBox",
+ "sig": "(String title)",
+ "type": "function",
+ "desc": "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)"
+ },
+ {
+ "name": "getEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the container element for this region."
+ },
+ {
+ "name": "getPanel",
+ "sig": "(Number/String/ContentPanel panel)",
+ "type": "function",
+ "desc": "Returns the panel specified or null if it's not in this region."
+ },
+ {
+ "name": "getPosition",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns this regions position (north/south/east/west/center)."
+ },
+ {
+ "name": "getTabs",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the TabPanel component used by this region"
+ },
+ {
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
+ },
+ {
+ "name": "hasPanel",
+ "sig": "(Number/String/ContentPanel panel)",
+ "type": "function",
+ "desc": "Returns true if the panel is in this region."
+ },
+ {
+ "name": "hide",
+ "sig": "()",
+ "type": "function",
+ "desc": "Hides this region."
+ },
+ {
+ "name": "hidePanel",
+ "sig": "(Number/String/ContentPanel panel)",
+ "type": "function",
+ "desc": "Hides the tab for the specified panel."
+ },
+ {
+ "name": "isVisible",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if this region is currently 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 <b>all</b> added captures from the Observable."
+ },
+ {
+ "name": "remove",
+ "sig": "(Number/String/ContentPanel panel, Boolean preservePanel)",
+ "type": "function",
+ "desc": "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed."
+ },
+ {
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
+ },
+ {
+ "name": "resizeTo",
+ "sig": "(Number newSize)",
+ "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."
+ },
+ {
+ "name": "show",
+ "sig": "()",
+ "type": "function",
+ "desc": "Shows this region if it was previously hidden."
+ },
+ {
+ "name": "showPanel",
+ "sig": "(Number/String/ContentPanel panelId)",
+ "type": "function",
+ "desc": "Shows the specified panel."
+ },
+ {
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ },
+ {
+ "name": "unhidePanel",
+ "sig": "(Number/String/ContentPanel panel)",
+ "type": "function",
+ "desc": "Unhides the tab for a previously hidden panel."
+ }
+ ]
+ },
+ "Roo.bootstrap.layout.Split": {
+ "props": [
+ {
+ "name": "collapsible",
+ "type": "Boolean",
+ "desc": "False to disable collapsing (defaults to true)",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "collapsed",
+ "type": "Boolean",
+ "desc": "True to set the initial display to collapsed (defaults to false)",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "floatable",
+ "type": "Boolean",
+ "desc": "False to disable floating (defaults to true)",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "margins",
+ "type": "Object",
+ "desc": "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "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": "tabPosition",
+ "type": "String",
+ "desc": "\"top\" or \"bottom\" (defaults to \"bottom\")",
+ "memberOf": "Roo.LayoutRegion",
+ "optvals": [
+ "top",
+ "bottom"
+ ]
+ },
+ {
+ "name": "collapsedTitle",
+ "type": "String",
+ "desc": "Optional string message to display in the collapsed block of a north or south region",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "alwaysShowTabs",
+ "type": "Boolean",
+ "desc": "True to always display tabs even when there is only 1 panel (defaults to false)",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "autoScroll",
+ "type": "Boolean",
+ "desc": "True to enable overflow scrolling (defaults to false)",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "titlebar",
+ "type": "Boolean",
+ "desc": "True to display a title bar (defaults to true)",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "title",
+ "type": "String",
+ "desc": "The title for the region (overrides panel titles)",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "animate",
+ "type": "Boolean",
+ "desc": "True to animate expand/collapse (defaults to false)",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "autoHide",
+ "type": "Boolean",
+ "desc": "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "preservePanels",
+ "type": "Boolean",
+ "desc": "True to preserve removed panels so they can be readded later (defaults to false)",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "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": "hideTabs",
+ "type": "Boolean",
+ "desc": "True to hide the tab strip (defaults to false)",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "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": "minTabWidth",
+ "type": "Number",
+ "desc": "The minimum tab width (defaults to 40)",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "preferredTabWidth",
+ "type": "Number",
+ "desc": "The preferred tab width (defaults to 150)",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "showPin",
+ "type": "Boolean",
+ "desc": "True to show a pin button",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "hidden",
+ "type": "Boolean",
+ "desc": "True to start the region hidden (defaults to false)",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "hideWhenEmpty",
+ "type": "Boolean",
+ "desc": "True to hide the region when it has no panels",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "disableTabTips",
+ "type": "Boolean",
+ "desc": "True to disable tab tooltips",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "width",
+ "type": "Number",
+ "desc": "For East/West panels",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "height",
+ "type": "Number",
+ "desc": "For North/South panels",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "split",
+ "type": "Boolean",
+ "desc": "To show the splitter",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "toolbar",
+ "type": "Boolean",
+ "desc": "xtype configuration for a toolbar - shows on right of tabbar",
+ "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"
+ }
+ ],
+ "events": [
+ {
+ "name": "beforecollapse",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this region before collapse."
+ },
+ {
+ "name": "beforeremove",
+ "sig": "function (_self, panel, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument."
+ },
+ {
+ "name": "collapsed",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this region is collapsed."
+ },
+ {
+ "name": "expanded",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this region is expanded."
+ },
+ {
+ "name": "invalidated",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the layout for this region is changed."
+ },
+ {
+ "name": "panelactivated",
+ "sig": "function (_self, panel)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a panel is activated."
+ },
+ {
+ "name": "paneladded",
+ "sig": "function (_self, panel)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a panel is added."
+ },
+ {
+ "name": "panelremoved",
+ "sig": "function (_self, panel)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a panel is removed."
+ },
+ {
+ "name": "resized",
+ "sig": "function (_self, newSize)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the user resizes this region."
+ },
+ {
+ "name": "slidehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this region slides out of view."
+ },
+ {
+ "name": "slideshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this region is slid into view."
+ },
+ {
+ "name": "visibilitychange",
+ "sig": "function (_self, visibility)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this region is shown or hidden"
+ }
+ ],
+ "methods": [
+ {
+ "name": "add",
+ "sig": "(ContentPanel... panel)",
+ "type": "function",
+ "desc": "Adds the passed ContentPanel(s) to this region."
+ },
+ {
+ "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\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire."
+ },
+ {
+ "name": "collapse",
+ "sig": "(Boolean skipAnim)",
+ "type": "function",
+ "desc": "Collapses this region."
+ },
+ {
+ "name": "expand",
+ "sig": "(Roo.EventObject e, Boolean skipAnim)",
+ "type": "function",
+ "desc": "Expands this region if it was previously collapsed."
+ },
+ {
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ },
+ {
+ "name": "getActivePanel",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the active panel for this region."
+ },
+ {
+ "name": "getEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the container element for this region."
+ },
+ {
+ "name": "getPanel",
+ "sig": "(Number/String/ContentPanel panel)",
+ "type": "function",
+ "desc": "Returns the panel specified or null if it's not in this region."
+ },
+ {
+ "name": "getPosition",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns this regions position (north/south/east/west/center)."
+ },
+ {
+ "name": "getSplitBar",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the {@link Roo.SplitBar} for this region."
+ },
+ {
+ "name": "getTabs",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the TabPanel component used by this region"
+ },
+ {
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
+ },
+ {
+ "name": "hasPanel",
+ "sig": "(Number/String/ContentPanel panel)",
+ "type": "function",
+ "desc": "Returns true if the panel is in this region."
+ },
+ {
+ "name": "hide",
+ "sig": "()",
+ "type": "function",
+ "desc": "Hides this region."
+ },
+ {
+ "name": "hidePanel",
+ "sig": "(Number/String/ContentPanel panel)",
+ "type": "function",
+ "desc": "Hides the tab for the specified panel."
+ },
+ {
+ "name": "isVisible",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if this region is currently 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 <b>all</b> added captures from the Observable."
+ },
+ {
+ "name": "remove",
+ "sig": "(Number/String/ContentPanel panel, Boolean preservePanel)",
+ "type": "function",
+ "desc": "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed."
+ },
+ {
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
+ },
+ {
+ "name": "resizeTo",
+ "sig": "(Number newSize)",
+ "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."
+ },
+ {
+ "name": "setCollapsedTitle",
+ "sig": "(String title)",
+ "type": "function",
+ "desc": "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)"
+ },
+ {
+ "name": "show",
+ "sig": "()",
+ "type": "function",
+ "desc": "Shows this region if it was previously hidden."
+ },
+ {
+ "name": "showPanel",
+ "sig": "(Number/String/ContentPanel panelId)",
+ "type": "function",
+ "desc": "Shows the specified panel."
+ },
+ {
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ },
+ {
+ "name": "unhidePanel",
+ "sig": "(Number/String/ContentPanel panel)",
+ "type": "function",
+ "desc": "Unhides the tab for a previously hidden panel."
+ }
+ ]
+ },
+ "Roo.bootstrap.menu": {
+ "props": [],
+ "events": [],
+ "methods": []
+ },
+ "Roo.bootstrap.menu.Item": {
+ "props": [
+ {
+ "name": "submenu",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "html",
+ "type": "String",
+ "desc": "text of the item",
+ "memberOf": ""
+ },
+ {
+ "name": "href",
+ "type": "String",
+ "desc": "the link",
+ "memberOf": ""
+ },
+ {
+ "name": "disable",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "preventDefault",
+ "type": "Boolean",
+ "desc": "default true",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "icon",
+ "type": "String",
+ "desc": "Font awesome icon",
+ "memberOf": ""
+ },
+ {
+ "name": "pos",
+ "type": "String",
+ "desc": "Submenu align to (left | right) default right",
+ "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<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "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": "click",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw click event for the entire grid."
+ },
+ {
+ "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": "mouseout",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the mouse exits this menu"
+ },
+ {
+ "name": "mouseover",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the mouse is hovering over this menu"
+ },
+ {
+ "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\n<b>before</b> 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 <b>all</b> 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.bootstrap.menu.Menu": {
+ "props": [
+ {
+ "name": "html",
+ "type": "String",
+ "desc": "Text of the menu",
+ "memberOf": ""
+ },
+ {
+ "name": "weight",
+ "type": "String",
+ "desc": "",
+ "memberOf": "",
+ "optvals": [
+ "default",
+ "primary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "inverse"
+ ]
+ },
+ {
+ "name": "icon",
+ "type": "String",
+ "desc": "Font awesome icon",
+ "memberOf": ""
+ },
+ {
+ "name": "pos",
+ "type": "String",
+ "desc": "Menu align to (top | bottom) default bottom",
+ "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<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "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 this menu is hidden"
+ },
+ {
+ "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 this menu is displayed"
+ },
+ {
+ "name": "childrenrendered",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the children have been rendered.."
+ },
+ {
+ "name": "click",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this menu is clicked (or when the enter key is pressed while it is active)"
+ },
+ {
+ "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 this menu 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 this menu is displayed"
+ }
+ ],
+ "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\n<b>before</b> 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 <b>all</b> 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.bootstrap.menu.Separator": {
+ "props": [
+ {
+ "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<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "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\n<b>before</b> 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 <b>all</b> 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.bootstrap.panel": {
+ "props": [],
+ "events": [],
+ "methods": []
+ },
+ "Roo.bootstrap.panel.Content": {
+ "props": [
+ {
+ "name": "fitToFrame",
+ "type": "Boolean",
+ "desc": "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "fitContainer",
+ "type": "Boolean",
+ "desc": "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
+ "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": ""
+ },
+ {
+ "name": "closable",
+ "type": "Boolean",
+ "desc": "True if the panel can be closed/removed",
+ "memberOf": ""
+ },
+ {
+ "name": "background",
+ "type": "Boolean",
+ "desc": "True if the panel should not be activated when it is added (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": ""
+ },
+ {
+ "name": "toolbar",
+ "type": "Toolbar",
+ "desc": "A toolbar for this panel",
+ "memberOf": ""
+ },
+ {
+ "name": "autoScroll",
+ "type": "Boolean",
+ "desc": "True to scroll overflow in this panel (use with {@link #fitToFrame})",
+ "memberOf": ""
+ },
+ {
+ "name": "title",
+ "type": "String",
+ "desc": "The title for this panel",
+ "memberOf": ""
+ },
+ {
+ "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": "url",
+ "type": "String",
+ "desc": "Calls {@link #setUrl} with this value",
+ "memberOf": ""
+ },
+ {
+ "name": "region",
+ "type": "String",
+ "desc": "which region to put this panel on (when used with xtype constructors)",
+ "memberOf": "",
+ "optvals": [
+ "center",
+ "north",
+ "south",
+ "east",
+ "west"
+ ]
+ },
+ {
+ "name": "params",
+ "type": "String/Object",
+ "desc": "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf": ""
+ },
+ {
+ "name": "loadOnce",
+ "type": "Boolean",
+ "desc": "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf": ""
+ },
+ {
+ "name": "content",
+ "type": "String",
+ "desc": "Raw content to fill content panel with (uses setContent on construction.)",
+ "memberOf": ""
+ },
+ {
+ "name": "badges",
+ "type": "Boolean",
+ "desc": "render the badges",
+ "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"
+ }
+ ],
+ "events": [
+ {
+ "name": "activate",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this panel is activated."
+ },
+ {
+ "name": "deactivate",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this panel is activated."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this tab is created"
+ },
+ {
+ "name": "resize",
+ "sig": "function (_self, width, height)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this panel is resized if fitToFrame is true."
+ }
+ ],
+ "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\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire."
+ },
+ {
+ "name": "destroy",
+ "sig": "()",
+ "type": "function",
+ "desc": "Destroys this panel"
+ },
+ {
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ },
+ {
+ "name": "getChildContainer",
+ "sig": "(Object cfg)",
+ "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>"
+ },
+ {
+ "name": "getEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns this panel's element - used by regiosn to add."
+ },
+ {
+ "name": "getId",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns this panel's id"
+ },
+ {
+ "name": "getTitle",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns this panel's title"
+ },
+ {
+ "name": "getToolbar",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the toolbar for this Panel if one was configured."
+ },
+ {
+ "name": "getUpdateManager",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates."
+ },
+ {
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
+ },
+ {
+ "name": "isClosable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true is this panel was configured to be closable"
+ },
+ {
+ "name": "load",
+ "sig": "(Object/String/Function url, String/Object params, Function callback, Boolean discardUrl)",
+ "type": "function",
+ "desc": "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}."
+ },
+ {
+ "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": "refresh",
+ "sig": "()",
+ "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."
+ },
+ {
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
+ },
+ {
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
+ },
+ {
+ "name": "setContent",
+ "sig": "(String content, Boolean loadScripts)",
+ "type": "function",
+ "desc": "Updates this panel's element"
+ },
+ {
+ "name": "setTitle",
+ "sig": "(String title)",
+ "type": "function",
+ "desc": "Set this panel's title"
+ },
+ {
+ "name": "setUrl",
+ "sig": "(String/Function url, String/Object params, Boolean loadOnce)",
+ "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."
+ },
+ {
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.bootstrap.panel.Grid": {
+ "props": [
+ {
+ "name": "grid",
+ "type": "Roo.bootstrap.Table",
+ "desc": "The grid for this panel",
+ "memberOf": ""
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "name": "closable",
+ "type": "Boolean",
+ "desc": "True if the panel can be closed/removed",
+ "memberOf": "Roo.bootstrap.panel.Content"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "name": "toolbar",
+ "type": "Toolbar",
+ "desc": "A toolbar for this panel",
+ "memberOf": "Roo.bootstrap.panel.Content"
+ },
+ {
+ "name": "autoScroll",
+ "type": "Boolean",
+ "desc": "True to scroll overflow in this panel (use with {@link #fitToFrame})",
+ "memberOf": "Roo.bootstrap.panel.Content"
+ },
+ {
+ "name": "title",
+ "type": "String",
+ "desc": "The title for this panel",
+ "memberOf": "Roo.bootstrap.panel.Content"
+ },
+ {
+ "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"
+ },
+ {
+ "name": "url",
+ "type": "String",
+ "desc": "Calls {@link #setUrl} with this value",
+ "memberOf": "Roo.bootstrap.panel.Content"
+ },
+ {
+ "name": "region",
+ "type": "String",
+ "desc": "which region to put this panel on (when used with xtype constructors)",
+ "memberOf": "Roo.bootstrap.panel.Content",
+ "optvals": [
+ "center",
+ "north",
+ "south",
+ "east",
+ "west"
+ ]
+ },
+ {
+ "name": "params",
+ "type": "String/Object",
+ "desc": "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf": "Roo.bootstrap.panel.Content"
+ },
+ {
+ "name": "loadOnce",
+ "type": "Boolean",
+ "desc": "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf": "Roo.bootstrap.panel.Content"
+ },
+ {
+ "name": "content",
+ "type": "String",
+ "desc": "Raw content to fill content panel with (uses setContent on construction.)",
+ "memberOf": "Roo.bootstrap.panel.Content"
+ },
+ {
+ "name": "badges",
+ "type": "Boolean",
+ "desc": "render the badges",
+ "memberOf": "Roo.bootstrap.panel.Content"
+ },
+ {
+ "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"
+ }
+ ],
+ "events": [
+ {
+ "name": "activate",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this panel is activated."
+ },
+ {
+ "name": "deactivate",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this panel is activated."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this tab is created"
+ },
+ {
+ "name": "resize",
+ "sig": "function (_self, width, height)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this panel is resized if fitToFrame is true."
+ }
+ ],
+ "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\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire."
+ },
+ {
+ "name": "destroy",
+ "sig": "()",
+ "type": "function",
+ "desc": "Destroys this panel"
+ },
+ {
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ },
+ {
+ "name": "getChildContainer",
+ "sig": "(Object cfg)",
+ "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>"
+ },
+ {
+ "name": "getEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns this panel's element - used by regiosn to add."
+ },
+ {
+ "name": "getGrid",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the grid for this panel"
+ },
+ {
+ "name": "getId",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns this panel's id"
+ },
+ {
+ "name": "getTitle",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns this panel's title"
+ },
+ {
+ "name": "getToolbar",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the toolbar for this Panel if one was configured."
+ },
+ {
+ "name": "getUpdateManager",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates."
+ },
+ {
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
+ },
+ {
+ "name": "isClosable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true is this panel was configured to be closable"
+ },
+ {
+ "name": "load",
+ "sig": "(Object/String/Function url, String/Object params, Function callback, Boolean discardUrl)",
+ "type": "function",
+ "desc": "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}."
+ },
+ {
+ "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": "refresh",
+ "sig": "()",
+ "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."
+ },
+ {
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
+ },
+ {
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
+ },
+ {
+ "name": "setContent",
+ "sig": "(String content, Boolean loadScripts)",
+ "type": "function",
+ "desc": "Updates this panel's element"
+ },
+ {
+ "name": "setTitle",
+ "sig": "(String title)",
+ "type": "function",
+ "desc": "Set this panel's title"
+ },
+ {
+ "name": "setUrl",
+ "sig": "(String/Function url, String/Object params, Boolean loadOnce)",
+ "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."
+ },
+ {
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.bootstrap.panel.Nest": {
+ "props": [
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "name": "closable",
+ "type": "Boolean",
+ "desc": "True if the panel can be closed/removed",
+ "memberOf": "Roo.bootstrap.panel.Content"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "name": "toolbar",
+ "type": "Toolbar",
+ "desc": "A toolbar for this panel",
+ "memberOf": "Roo.bootstrap.panel.Content"
+ },
+ {
+ "name": "autoScroll",
+ "type": "Boolean",
+ "desc": "True to scroll overflow in this panel (use with {@link #fitToFrame})",
+ "memberOf": "Roo.bootstrap.panel.Content"
+ },
+ {
+ "name": "title",
+ "type": "String",
+ "desc": "The title for this panel",
+ "memberOf": "Roo.bootstrap.panel.Content"
+ },
+ {
+ "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"
+ },
+ {
+ "name": "url",
+ "type": "String",
+ "desc": "Calls {@link #setUrl} with this value",
+ "memberOf": "Roo.bootstrap.panel.Content"
+ },
+ {
+ "name": "region",
+ "type": "String",
+ "desc": "which region to put this panel on (when used with xtype constructors)",
+ "memberOf": "Roo.bootstrap.panel.Content",
+ "optvals": [
+ "center",
+ "north",
+ "south",
+ "east",
+ "west"
+ ]
+ },
+ {
+ "name": "params",
+ "type": "String/Object",
+ "desc": "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf": "Roo.bootstrap.panel.Content"
+ },
+ {
+ "name": "loadOnce",
+ "type": "Boolean",
+ "desc": "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf": "Roo.bootstrap.panel.Content"
+ },
+ {
+ "name": "content",
+ "type": "String",
+ "desc": "Raw content to fill content panel with (uses setContent on construction.)",
+ "memberOf": "Roo.bootstrap.panel.Content"
+ },
+ {
+ "name": "badges",
+ "type": "Boolean",
+ "desc": "render the badges",
+ "memberOf": "Roo.bootstrap.panel.Content"
+ },
+ {
+ "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"
+ }
+ ],
+ "events": [
+ {
+ "name": "activate",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this panel is activated."
+ },
+ {
+ "name": "deactivate",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this panel is activated."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this tab is created"
+ },
+ {
+ "name": "resize",
+ "sig": "function (_self, width, height)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this panel is resized if fitToFrame is true."
+ }
+ ],
+ "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": "addxtype",
+ "sig": "(Object cfg)",
+ "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>"
+ },
+ {
+ "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\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire."
+ },
+ {
+ "name": "destroy",
+ "sig": "()",
+ "type": "function",
+ "desc": "Destroys this panel"
+ },
+ {
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ },
+ {
+ "name": "getChildContainer",
+ "sig": "(Object cfg)",
+ "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>"
+ },
+ {
+ "name": "getEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns this panel's element - used by regiosn to add."
+ },
+ {
+ "name": "getId",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns this panel's id"
+ },
+ {
+ "name": "getLayout",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the nested BorderLayout for this panel"
+ },
+ {
+ "name": "getTitle",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns this panel's title"
+ },
+ {
+ "name": "getToolbar",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the toolbar for this Panel if one was configured."
+ },
+ {
+ "name": "getUpdateManager",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates."
+ },
+ {
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
+ },
+ {
+ "name": "isClosable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true is this panel was configured to be closable"
+ },
+ {
+ "name": "load",
+ "sig": "(Object/String/Function url, String/Object params, Function callback, Boolean discardUrl)",
+ "type": "function",
+ "desc": "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}."
+ },
+ {
+ "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": "refresh",
+ "sig": "()",
+ "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."
+ },
+ {
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
+ },
+ {
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
+ },
+ {
+ "name": "setContent",
+ "sig": "(String content, Boolean loadScripts)",
+ "type": "function",
+ "desc": "Updates this panel's element"
+ },
+ {
+ "name": "setTitle",
+ "sig": "(String title)",
+ "type": "function",
+ "desc": "Set this panel's title"
+ },
+ {
+ "name": "setUrl",
+ "sig": "(String/Function url, String/Object params, Boolean loadOnce)",
+ "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."
+ },
+ {
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "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"
+ }
+ ],
+ "events": [
+ {
+ "name": "activate",
+ "sig": "function (tabPanel, _self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this tab becomes the active tab."
+ },
+ {
+ "name": "beforeclose",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before this tab is closed. To cancel the close, set cancel to true on e (e.cancel = true)."
+ },
+ {
+ "name": "close",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this tab is closed."
+ },
+ {
+ "name": "deactivate",
+ "sig": "function (tabPanel, _self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this tab is no longer the active tab."
+ }
+ ],
+ "methods": [
+ {
+ "name": "activate",
+ "sig": "()",
+ "type": "function",
+ "desc": "Activates this TabPanelItem -- this <b>does</b> deactivate the currently active TabPanelItem."
+ },
+ {
+ "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\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire."
+ },
+ {
+ "name": "disable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Disables this TabPanelItem -- this does nothing if this is the active TabPanelItem."
+ },
+ {
+ "name": "enable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Enables this TabPanelItem if it was previously disabled."
+ },
+ {
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ },
+ {
+ "name": "getText",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the text for this tab"
+ },
+ {
+ "name": "getUpdateManager",
+ "sig": "()",
+ "type": "function",
+ "desc": "Gets the {@link Roo.UpdateManager} for the body of this TabPanelItem. Enables you to perform Ajax updates."
+ },
+ {
+ "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": "Hides this TabPanelItem -- if you don't activate another TabPanelItem this could look odd."
+ },
+ {
+ "name": "isActive",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if this tab is the active tab."
+ },
+ {
+ "name": "isHidden",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if this tab is \"hidden\""
+ },
+ {
+ "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": "refresh",
+ "sig": "()",
+ "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."
+ },
+ {
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
+ },
+ {
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
+ },
+ {
+ "name": "setContent",
+ "sig": "(String content, Boolean loadScripts)",
+ "type": "function",
+ "desc": "Sets the content for this TabPanelItem."
+ },
+ {
+ "name": "setHidden",
+ "sig": "(Boolean hidden)",
+ "type": "function",
+ "desc": "Show or hide the tab"
+ },
+ {
+ "name": "setText",
+ "sig": "(String text)",
+ "type": "function",
+ "desc": "Sets the text for the tab (Note: this also sets the tooltip text)"
+ },
+ {
+ "name": "setTooltip",
+ "sig": "(String tooltip)",
+ "type": "function",
+ "desc": "Set the tooltip for the tab."
+ },
+ {
+ "name": "setUrl",
+ "sig": "(String/Function url, String/Object params, Boolean loadOnce)",
+ "type": "function",
+ "desc": "Set a URL to be used to load the content for this TabPanelItem."
+ },
+ {
+ "name": "show",
+ "sig": "()",
+ "type": "function",
+ "desc": "Shows this TabPanelItem -- this <b>does not</b> deactivate the currently active TabPanelItem."
+ },
+ {
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.bootstrap.panel.Tabs": {
+ "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"
+ }
+ ],
+ "events": [
+ {
+ "name": "beforetabchange",
+ "sig": "function (_self, e, tab)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the active tab changes, set cancel to true on the \"e\" parameter to cancel the change"
+ },
+ {
+ "name": "tabchange",
+ "sig": "function (_self, activePanel)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the active tab changes"
+ }
+ ],
+ "methods": [
+ {
+ "name": "activate",
+ "sig": "(String/Number id)",
+ "type": "function",
+ "desc": "Activates a {@link Roo.TabPanelItem}. The currently active one will be deactivated."
+ },
+ {
+ "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": "addTab",
+ "sig": "(String id, String text, String content, Boolean closable)",
+ "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."
+ },
+ {
+ "name": "addTabItem",
+ "sig": "(Roo.TabPanelItem item)",
+ "type": "function",
+ "desc": "Adds an existing {@link Roo.TabPanelItem}."
+ },
+ {
+ "name": "autoSizeTabs",
+ "sig": "()",
+ "type": "function",
+ "desc": "Manual call to resize the tabs (if {@link #resizeTabs} is false this does nothing)"
+ },
+ {
+ "name": "beginUpdate",
+ "sig": "()",
+ "type": "function",
+ "desc": "Disables tab resizing while tabs are being added (if {@link #resizeTabs} is false this does nothing)"
+ },
+ {
+ "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\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire."
+ },
+ {
+ "name": "destroy",
+ "sig": "(Boolean removeEl)",
+ "type": "function",
+ "desc": "Destroys this TabPanel"
+ },
+ {
+ "name": "disableTab",
+ "sig": "(String/Number id)",
+ "type": "function",
+ "desc": "Disables a {@link Roo.TabPanelItem}. It cannot be the active tab, if it is this call is ignored."
+ },
+ {
+ "name": "enableTab",
+ "sig": "(String/Number id)",
+ "type": "function",
+ "desc": "Enables a {@link Roo.TabPanelItem} that is disabled."
+ },
+ {
+ "name": "endUpdate",
+ "sig": "()",
+ "type": "function",
+ "desc": "Stops an update and resizes the tabs (if {@link #resizeTabs} is false this does nothing)"
+ },
+ {
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ },
+ {
+ "name": "getActiveTab",
+ "sig": "()",
+ "type": "function",
+ "desc": "Gets the active {@link Roo.TabPanelItem}."
+ },
+ {
+ "name": "getCount",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the number of tabs in this TabPanel."
+ },
+ {
+ "name": "getTab",
+ "sig": "(String/Number id)",
+ "type": "function",
+ "desc": "Returns the {@link Roo.TabPanelItem} with the specified id/index"
+ },
+ {
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
+ },
+ {
+ "name": "hideTab",
+ "sig": "(String/Number id)",
+ "type": "function",
+ "desc": "Hides the {@link Roo.TabPanelItem} with the specified id/index"
+ },
+ {
+ "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 <b>all</b> added captures from the Observable."
+ },
+ {
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
+ },
+ {
+ "name": "removeTab",
+ "sig": "(String/Number id)",
+ "type": "function",
+ "desc": "Removes a {@link Roo.TabPanelItem}."
+ },
+ {
+ "name": "setTabWidth",
+ "sig": "(Number The)",
+ "type": "function",
+ "desc": "Resizes all the tabs to the passed width"
+ },
+ {
+ "name": "syncHeight",
+ "sig": "(Number targetHeight)",
+ "type": "function",
+ "desc": "Updates the tab body element to fit the height of the container element\nfor overflow scrolling"
+ },
+ {
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ },
+ {
+ "name": "unhideTab",
+ "sig": "(String/Number id)",
+ "type": "function",
+ "desc": "\"Unhides\" the {@link Roo.TabPanelItem} with the specified id/index."
+ }
+ ]
+ },
+ "Roo.data": {
+ "props": [],
+ "events": [],
+ "methods": []
+ },
+ "Roo.data.ArrayReader": {
"props": [
{
"name": "id",
}
]
},
- "Roo.dd.DDTarget": {
+ "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"
+ }
+ ],
+ "events": [],
+ "methods": [
+ {
+ "name": "addEvents",
+ "sig": "(Object object)",
+ "type": "function",
+ "desc": "Used to define events on this Observable"
+ },
+ {
+ "name": "addInvalidHandleClass",
+ "sig": "(string cssClass)",
+ "type": "function",
+ "desc": "Lets you specify a css class of elements that will not initiate a drag"
+ },
+ {
+ "name": "addInvalidHandleId",
+ "sig": "(string id)",
+ "type": "function",
+ "desc": "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag"
+ },
+ {
+ "name": "addInvalidHandleType",
+ "sig": "(string tagName)",
+ "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."
+ },
+ {
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this component"
+ },
+ {
+ "name": "addToGroup",
+ "sig": "( sGroup)",
+ "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."
+ },
+ {
+ "name": "applyConfig",
+ "sig": "()",
+ "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."
+ },
+ {
+ "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\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire."
+ },
+ {
+ "name": "clearConstraints",
+ "sig": "()",
+ "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."
+ },
+ {
+ "name": "clearTicks",
+ "sig": "()",
+ "type": "function",
+ "desc": "Clears any tick interval defined for this instance"
+ },
+ {
+ "name": "endDrag",
+ "sig": "(Event e)",
+ "type": "function",
+ "desc": "Fired when we are done dragging the object"
+ },
+ {
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ },
+ {
+ "name": "function toString() {\n [native code]\n}",
+ "sig": "()",
+ "type": "function",
+ "desc": "toString method"
+ },
+ {
+ "name": "getDragEl",
+ "sig": "()",
+ "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"
+ },
+ {
+ "name": "getEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns a reference to the linked element"
+ },
+ {
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
+ },
+ {
+ "name": "init",
+ "sig": "( id, String sGroup, object config)",
+ "type": "function",
+ "desc": "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass"
+ },
+ {
+ "name": "initTarget",
+ "sig": "( id, String sGroup, object config)",
+ "type": "function",
+ "desc": "Initializes Targeting functionality only... the object does not\nget a mousedown handler."
+ },
+ {
+ "name": "isLocked",
+ "sig": "()",
+ "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.)"
+ },
+ {
+ "name": "isTarget",
+ "sig": "()",
+ "type": "function",
+ "desc": "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false."
+ },
+ {
+ "name": "isValidHandleChild",
+ "sig": "(HTMLElement node)",
+ "type": "function",
+ "desc": "Checks the tag exclusion list to see if this click should be ignored"
+ },
+ {
+ "name": "lock",
+ "sig": "()",
+ "type": "function",
+ "desc": "Lock this instance"
+ },
+ {
+ "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": "onAvailable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Override the onAvailable method to do what is needed after the initial\nposition was determined."
+ },
+ {
+ "name": "onDrag",
+ "sig": "(Event e)",
+ "type": "function",
+ "desc": "Abstract method called during the onMouseMove event while dragging an\nobject."
+ },
+ {
+ "name": "onDragDrop",
+ "sig": "(Event e, String|DragDrop[] id)",
+ "type": "function",
+ "desc": "Abstract method called when this item is dropped on another DragDrop\nobj"
+ },
+ {
+ "name": "onDragEnter",
+ "sig": "(Event e, String|DragDrop[] id)",
+ "type": "function",
+ "desc": "Abstract method called when this element fist begins hovering over\nanother DragDrop obj"
+ },
+ {
+ "name": "onDragOut",
+ "sig": "(Event e, String|DragDrop[] id)",
+ "type": "function",
+ "desc": "Abstract method called when we are no longer hovering over an element"
+ },
+ {
+ "name": "onDragOver",
+ "sig": "(Event e, String|DragDrop[] id)",
+ "type": "function",
+ "desc": "Abstract method called when this element is hovering over another\nDragDrop obj"
+ },
+ {
+ "name": "onInvalidDrop",
+ "sig": "(Event e)",
+ "type": "function",
+ "desc": "Abstract method called when this item is dropped on an area with no\ndrop target"
+ },
+ {
+ "name": "onMouseDown",
+ "sig": "(Event e)",
+ "type": "function",
+ "desc": "Event handler that fires when a drag/drop obj gets a mousedown"
+ },
+ {
+ "name": "onMouseUp",
+ "sig": "(Event e)",
+ "type": "function",
+ "desc": "Event handler that fires when a drag/drop obj gets a mouseup"
+ },
+ {
+ "name": "padding",
+ "sig": "()",
+ "type": "function",
+ "desc": "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object."
+ },
+ {
+ "name": "purgeListeners",
+ "sig": "()",
+ "type": "function",
+ "desc": "Removes all listeners for this object"
+ },
+ {
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
+ },
+ {
+ "name": "removeFromGroup",
+ "sig": "(string sGroup)",
+ "type": "function",
+ "desc": "Remove's this instance from the supplied interaction group"
+ },
+ {
+ "name": "removeInvalidHandleClass",
+ "sig": "(string cssClass)",
+ "type": "function",
+ "desc": "Unsets an invalid css class"
+ },
+ {
+ "name": "removeInvalidHandleId",
+ "sig": "(string id)",
+ "type": "function",
+ "desc": "Unsets an invalid handle id"
+ },
+ {
+ "name": "removeInvalidHandleType",
+ "sig": "(string tagName)",
+ "type": "function",
+ "desc": "Unsets an excluded tag name set by addInvalidHandleType"
+ },
+ {
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
+ },
+ {
+ "name": "resetConstraints",
+ "sig": "(boolean maintainOffset)",
+ "type": "function",
+ "desc": "resetConstraints must be called if you manually reposition a dd element."
+ },
+ {
+ "name": "setDragElId",
+ "sig": "( id)",
+ "type": "function",
+ "desc": "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag"
+ },
+ {
+ "name": "setHandleElId",
+ "sig": "( id)",
+ "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."
+ },
+ {
+ "name": "setInitPosition",
+ "sig": "(int diffX, int diffY)",
+ "type": "function",
+ "desc": "Stores the initial placement of the linked element."
+ },
+ {
+ "name": "setOuterHandleElId",
+ "sig": "( id)",
+ "type": "function",
+ "desc": "Allows you to set an element outside of the linked element as a drag\nhandle"
+ },
+ {
+ "name": "setPadding",
+ "sig": "(int iTop, int iRight, int iBot, int iLeft)",
+ "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."
+ },
+ {
+ "name": "setXConstraint",
+ "sig": "(int iLeft, int iRight, int iTickSize)",
+ "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."
+ },
+ {
+ "name": "setYConstraint",
+ "sig": "(int iUp, int iDown, int iTickSize)",
+ "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."
+ },
+ {
+ "name": "startDrag",
+ "sig": "(int X, int Y)",
+ "type": "function",
+ "desc": "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met."
+ },
+ {
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ },
+ {
+ "name": "unlock",
+ "sig": "()",
+ "type": "function",
+ "desc": "Unlock this instace"
+ },
+ {
+ "name": "unreg",
+ "sig": "()",
+ "type": "function",
+ "desc": "Remove all drag and drop hooks for this element"
+ }
+ ]
+ },
+ "Roo.dd.DragDrop": {
"props": [
{
"name": "listeners",
}
]
},
- "Roo.dd.DragDrop": {
+ "Roo.dd.DragDropMgr": {
+ "props": [],
+ "events": [],
+ "methods": [
+ {
+ "name": "getBestMatch",
+ "sig": "(DragDrop[] dds)",
+ "type": "function",
+ "desc": "Helper function for getting the best match from the list of drag\nand drop objects returned by the drag and drop events when we are\nin INTERSECT mode. It returns either the first object that the\ncursor is over, or the object that has the greatest overlap with\nthe dragged element."
+ },
+ {
+ "name": "getCss",
+ "sig": "(String id)",
+ "type": "function",
+ "desc": "Returns the style property for the DOM element (i.e.,\ndocument.getElById(id).style)"
+ },
+ {
+ "name": "getDDById",
+ "sig": "(String id)",
+ "type": "function",
+ "desc": "Returns the DragDrop instance for a given id"
+ },
+ {
+ "name": "getElement",
+ "sig": "(String id)",
+ "type": "function",
+ "desc": "Returns the actual DOM element"
+ },
+ {
+ "name": "getLocation",
+ "sig": "(DragDrop oDD)",
+ "type": "function",
+ "desc": "Returns a Region object containing the drag and drop element's position\nand size, including the padding configured for it"
+ },
+ {
+ "name": "getPosX",
+ "sig": "( el)",
+ "type": "function",
+ "desc": "Returns the X position of an html element"
+ },
+ {
+ "name": "getPosY",
+ "sig": "( el)",
+ "type": "function",
+ "desc": "Returns the Y position of an html element"
+ },
+ {
+ "name": "getRelated",
+ "sig": "(DragDrop p_oDD, boolean bTargetsOnly)",
+ "type": "function",
+ "desc": "Returns the drag and drop instances that are in all groups the\npassed in instance belongs to."
+ },
+ {
+ "name": "getScrollLeft",
+ "sig": "()",
+ "type": "function",
+ "desc": "Gets the scrollLeft"
+ },
+ {
+ "name": "getScrollTop",
+ "sig": "()",
+ "type": "function",
+ "desc": "Gets the scrollTop"
+ },
+ {
+ "name": "getStyle",
+ "sig": "(HTMLElement el, string styleProp)",
+ "type": "function",
+ "desc": "Returns the specified element style property"
+ },
+ {
+ "name": "handleWasClicked",
+ "sig": "( node)",
+ "type": "function",
+ "desc": "Recursively searches the immediate parent and all child nodes for\nthe handle element in order to determine wheter or not it was\nclicked."
+ },
+ {
+ "name": "isDragDrop",
+ "sig": "(String id)",
+ "type": "function",
+ "desc": "Utility function to determine if a given element has been\nregistered as a drag drop item."
+ },
+ {
+ "name": "isHandle",
+ "sig": "(String id)",
+ "type": "function",
+ "desc": "Utility function to determine if a given element has been\nregistered as a drag drop handle for the given Drag Drop object."
+ },
+ {
+ "name": "isLegalTarget",
+ "sig": "(DragDrop the, DragDrop the)",
+ "type": "function",
+ "desc": "Returns true if the specified dd target is a legal target for\nthe specifice drag obj"
+ },
+ {
+ "name": "isLocked",
+ "sig": "()",
+ "type": "function",
+ "desc": "Is drag and drop locked?"
+ },
+ {
+ "name": "isTypeOfDD",
+ "sig": "(Object the)",
+ "type": "function",
+ "desc": "My goal is to be able to transparently determine if an object is\ntypeof DragDrop, and the exact subclass of DragDrop. typeof\nreturns \"object\", oDD.constructor.toString() always returns\n\"DragDrop\" and not the name of the subclass. So for now it just\nevaluates a well-known variable in DragDrop."
+ },
+ {
+ "name": "lock",
+ "sig": "()",
+ "type": "function",
+ "desc": "Lock all drag and drop functionality"
+ },
+ {
+ "name": "moveToEl",
+ "sig": "(HTMLElement moveEl, HTMLElement targetEl)",
+ "type": "function",
+ "desc": "Sets the x/y position of an element to the location of the\ntarget element."
+ },
+ {
+ "name": "numericSort",
+ "sig": "()",
+ "type": "function",
+ "desc": "Numeric array sort function"
+ },
+ {
+ "name": "refreshCache",
+ "sig": "(Object groups)",
+ "type": "function",
+ "desc": "Refreshes the cache of the top-left and bottom-right points of the\ndrag and drop objects in the specified group(s). This is in the\nformat that is stored in the drag and drop instance, so typical\nusage is:\n<code>\nRoo.dd.DragDropMgr.refreshCache(ddinstance.groups);\n</code>\nAlternatively:\n<code>\nRoo.dd.DragDropMgr.refreshCache({group1:true, group2:true});\n</code>"
+ },
+ {
+ "name": "regDragDrop",
+ "sig": "(DragDrop oDD, String sGroup)",
+ "type": "function",
+ "desc": "Each DragDrop instance must be registered with the DragDropMgr.\nThis is executed in DragDrop.init()"
+ },
+ {
+ "name": "regHandle",
+ "sig": "(String sDDId, String sHandleId)",
+ "type": "function",
+ "desc": "Each DragDrop handle element must be registered. This is done\nautomatically when executing DragDrop.setHandleElId()"
+ },
+ {
+ "name": "startDrag",
+ "sig": "( x, y)",
+ "type": "function",
+ "desc": "Fired when either the drag pixel threshol or the mousedown hold\ntime threshold has been met."
+ },
+ {
+ "name": "stopEvent",
+ "sig": "(Event e)",
+ "type": "function",
+ "desc": "Utility to stop event propagation and event default, if these\nfeatures are turned on."
+ },
+ {
+ "name": "swapNode",
+ "sig": "( n1, n2)",
+ "type": "function",
+ "desc": "Swap two nodes. In IE, we use the native method, for others we\nemulate the IE behavior"
+ },
+ {
+ "name": "unlock",
+ "sig": "()",
+ "type": "function",
+ "desc": "Unlock all drag and drop functionality"
+ },
+ {
+ "name": "verifyEl",
+ "sig": "(HTMLElement el)",
+ "type": "function",
+ "desc": "This checks to make sure an element exists and is in the DOM. The\nmain purpose is to handle cases where innerHTML is used to remove\ndrag and drop objects from the DOM. IE provides an 'unspecified\nerror' when trying to access the offsetParent of such an element"
+ }
+ ]
+ },
+ "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": ""
+ },
+ {
+ "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": ""
+ },
{
"name": "listeners",
"type": "Object",
"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."
},
+ {
+ "name": "alignElWithMouse",
+ "sig": "(HTMLElement el, int iPageX, int iPageY)",
+ "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."
+ },
{
"name": "applyConfig",
"sig": "()",
"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."
},
+ {
+ "name": "autoOffset",
+ "sig": "(int iPageX, int iPageY)",
+ "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"
+ },
+ {
+ "name": "beforeDragDrop",
+ "sig": "(Roo.dd.DragDrop target, Event e, String id)",
+ "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."
+ },
+ {
+ "name": "beforeDragEnter",
+ "sig": "(Roo.dd.DragDrop target, Event e, String id)",
+ "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."
+ },
+ {
+ "name": "beforeDragOut",
+ "sig": "(Roo.dd.DragDrop target, Event e, String id)",
+ "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."
+ },
+ {
+ "name": "beforeDragOver",
+ "sig": "(Roo.dd.DragDrop target, Event e, String id)",
+ "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."
+ },
+ {
+ "name": "beforeInvalidDrop",
+ "sig": "(Roo.dd.DragDrop target, Event e, String id)",
+ "type": "function",
+ "desc": "An empty function by default, but provided so that you can perform a custom action after an invalid\ndrop has occurred."
+ },
+ {
+ "name": "cachePosition",
+ "sig": "( iPageX, iPageY)",
+ "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."
+ },
{
"name": "capture",
"sig": "(Observable o, Function fn, Object scope)",
"type": "function",
"desc": "Clears any tick interval defined for this instance"
},
+ {
+ "name": "createFrame",
+ "sig": "()",
+ "type": "function",
+ "desc": "Creates the proxy element if it does not yet exist"
+ },
{
"name": "endDrag",
"sig": "(Event e)",
"type": "function",
"desc": "toString method"
},
+ {
+ "name": "getDragData",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the data object associated with this drag source"
+ },
{
"name": "getDragEl",
"sig": "()",
"type": "function",
"desc": "Returns a reference to the linked element"
},
+ {
+ "name": "getProxy",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the drag source's underlying {@link Roo.dd.StatusProxy}"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"type": "function",
"desc": "Checks to see if this object has any listeners for a specified event"
},
+ {
+ "name": "hideProxy",
+ "sig": "()",
+ "type": "function",
+ "desc": "Hides the drag source's {@link Roo.dd.StatusProxy}"
+ },
{
"name": "init",
"sig": "( id, String sGroup, object config)",
"type": "function",
"desc": "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass"
},
+ {
+ "name": "initFrame",
+ "sig": "()",
+ "type": "function",
+ "desc": "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses"
+ },
{
"name": "initTarget",
"sig": "( id, String sGroup, object config)",
"type": "function",
"desc": "Override the onAvailable method to do what is needed after the initial\nposition was determined."
},
+ {
+ "name": "onBeforeDrag",
+ "sig": "(Object data, Event e)",
+ "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."
+ },
{
"name": "onDrag",
"sig": "(Event e)",
"type": "function",
"desc": "Event handler that fires when a drag/drop obj gets a mouseup"
},
+ {
+ "name": "onStartDrag",
+ "sig": "(Number x, Number y)",
+ "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."
+ },
{
"name": "padding",
"sig": "()",
"type": "function",
"desc": "resetConstraints must be called if you manually reposition a dd element."
},
+ {
+ "name": "setDelta",
+ "sig": "(int iDeltaX, int iDeltaY)",
+ "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)"
+ },
{
"name": "setDragElId",
"sig": "( id)",
"type": "function",
"desc": "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag"
},
+ {
+ "name": "setDragElPos",
+ "sig": "(int iPageX, int iPageY)",
+ "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."
+ },
{
"name": "setHandleElId",
"sig": "( id)",
}
]
},
- "Roo.dd.DragDropMgr": {
- "props": [],
- "events": [],
- "methods": [
- {
- "name": "getBestMatch",
- "sig": "(DragDrop[] dds)",
- "type": "function",
- "desc": "Helper function for getting the best match from the list of drag\nand drop objects returned by the drag and drop events when we are\nin INTERSECT mode. It returns either the first object that the\ncursor is over, or the object that has the greatest overlap with\nthe dragged element."
- },
- {
- "name": "getCss",
- "sig": "(String id)",
- "type": "function",
- "desc": "Returns the style property for the DOM element (i.e.,\ndocument.getElById(id).style)"
- },
- {
- "name": "getDDById",
- "sig": "(String id)",
- "type": "function",
- "desc": "Returns the DragDrop instance for a given id"
- },
- {
- "name": "getElement",
- "sig": "(String id)",
- "type": "function",
- "desc": "Returns the actual DOM element"
- },
- {
- "name": "getLocation",
- "sig": "(DragDrop oDD)",
- "type": "function",
- "desc": "Returns a Region object containing the drag and drop element's position\nand size, including the padding configured for it"
- },
- {
- "name": "getPosX",
- "sig": "( el)",
- "type": "function",
- "desc": "Returns the X position of an html element"
- },
- {
- "name": "getPosY",
- "sig": "( el)",
- "type": "function",
- "desc": "Returns the Y position of an html element"
- },
- {
- "name": "getRelated",
- "sig": "(DragDrop p_oDD, boolean bTargetsOnly)",
- "type": "function",
- "desc": "Returns the drag and drop instances that are in all groups the\npassed in instance belongs to."
- },
- {
- "name": "getScrollLeft",
- "sig": "()",
- "type": "function",
- "desc": "Gets the scrollLeft"
- },
- {
- "name": "getScrollTop",
- "sig": "()",
- "type": "function",
- "desc": "Gets the scrollTop"
- },
- {
- "name": "getStyle",
- "sig": "(HTMLElement el, string styleProp)",
- "type": "function",
- "desc": "Returns the specified element style property"
- },
- {
- "name": "handleWasClicked",
- "sig": "( node)",
- "type": "function",
- "desc": "Recursively searches the immediate parent and all child nodes for\nthe handle element in order to determine wheter or not it was\nclicked."
- },
- {
- "name": "isDragDrop",
- "sig": "(String id)",
- "type": "function",
- "desc": "Utility function to determine if a given element has been\nregistered as a drag drop item."
- },
- {
- "name": "isHandle",
- "sig": "(String id)",
- "type": "function",
- "desc": "Utility function to determine if a given element has been\nregistered as a drag drop handle for the given Drag Drop object."
- },
- {
- "name": "isLegalTarget",
- "sig": "(DragDrop the, DragDrop the)",
- "type": "function",
- "desc": "Returns true if the specified dd target is a legal target for\nthe specifice drag obj"
- },
- {
- "name": "isLocked",
- "sig": "()",
- "type": "function",
- "desc": "Is drag and drop locked?"
- },
- {
- "name": "isTypeOfDD",
- "sig": "(Object the)",
- "type": "function",
- "desc": "My goal is to be able to transparently determine if an object is\ntypeof DragDrop, and the exact subclass of DragDrop. typeof\nreturns \"object\", oDD.constructor.toString() always returns\n\"DragDrop\" and not the name of the subclass. So for now it just\nevaluates a well-known variable in DragDrop."
- },
- {
- "name": "lock",
- "sig": "()",
- "type": "function",
- "desc": "Lock all drag and drop functionality"
- },
- {
- "name": "moveToEl",
- "sig": "(HTMLElement moveEl, HTMLElement targetEl)",
- "type": "function",
- "desc": "Sets the x/y position of an element to the location of the\ntarget element."
- },
- {
- "name": "numericSort",
- "sig": "()",
- "type": "function",
- "desc": "Numeric array sort function"
- },
- {
- "name": "refreshCache",
- "sig": "(Object groups)",
- "type": "function",
- "desc": "Refreshes the cache of the top-left and bottom-right points of the\ndrag and drop objects in the specified group(s). This is in the\nformat that is stored in the drag and drop instance, so typical\nusage is:\n<code>\nRoo.dd.DragDropMgr.refreshCache(ddinstance.groups);\n</code>\nAlternatively:\n<code>\nRoo.dd.DragDropMgr.refreshCache({group1:true, group2:true});\n</code>"
- },
- {
- "name": "regDragDrop",
- "sig": "(DragDrop oDD, String sGroup)",
- "type": "function",
- "desc": "Each DragDrop instance must be registered with the DragDropMgr.\nThis is executed in DragDrop.init()"
- },
- {
- "name": "regHandle",
- "sig": "(String sDDId, String sHandleId)",
- "type": "function",
- "desc": "Each DragDrop handle element must be registered. This is done\nautomatically when executing DragDrop.setHandleElId()"
- },
- {
- "name": "startDrag",
- "sig": "( x, y)",
- "type": "function",
- "desc": "Fired when either the drag pixel threshol or the mousedown hold\ntime threshold has been met."
- },
- {
- "name": "stopEvent",
- "sig": "(Event e)",
- "type": "function",
- "desc": "Utility to stop event propagation and event default, if these\nfeatures are turned on."
- },
+ "Roo.dd.DragZone": {
+ "props": [
{
- "name": "swapNode",
- "sig": "( n1, n2)",
- "type": "function",
- "desc": "Swap two nodes. In IE, we use the native method, for others we\nemulate the IE behavior"
+ "name": "containerScroll",
+ "type": "Boolean",
+ "desc": "True to register this container with the Scrollmanager\nfor auto scrolling during drag operations.",
+ "memberOf": ""
},
{
- "name": "unlock",
- "sig": "()",
- "type": "function",
- "desc": "Unlock all drag and drop functionality"
+ "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": ""
},
- {
- "name": "verifyEl",
- "sig": "(HTMLElement el)",
- "type": "function",
- "desc": "This checks to make sure an element exists and is in the DOM. The\nmain purpose is to handle cases where innerHTML is used to remove\ndrag and drop objects from the DOM. IE provides an 'unspecified\nerror' when trying to access the offsetParent of such an element"
- }
- ]
- },
- "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": ""
+ "memberOf": "Roo.dd.DragSource"
},
{
"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": ""
+ "memberOf": "Roo.dd.DragSource"
},
{
"name": "listeners",
"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."
},
+ {
+ "name": "afterRepair",
+ "sig": "()",
+ "type": "function",
+ "desc": "Called after a repair of an invalid drop. By default, highlights this.dragData.ddel"
+ },
{
"name": "alignElWithMouse",
"sig": "(HTMLElement el, int iPageX, int iPageY)",
},
{
"name": "getDragData",
- "sig": "()",
+ "sig": "(EventObject e)",
"type": "function",
- "desc": "Returns the data object associated with this drag source"
+ "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."
},
{
"name": "getDragEl",
"type": "function",
"desc": "Returns the drag source's underlying {@link Roo.dd.StatusProxy}"
},
+ {
+ "name": "getRepairXY",
+ "sig": "(EventObject e)",
+ "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"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"type": "function",
"desc": "Abstract method called when this element is hovering over another\nDragDrop obj"
},
+ {
+ "name": "onInitDrag",
+ "sig": "(Number x, Number y)",
+ "type": "function",
+ "desc": "Called once drag threshold has been reached to initialize the proxy element. By default, it clones the\nthis.dragData.ddel"
+ },
{
"name": "onInvalidDrop",
"sig": "(Event e)",
}
]
},
- "Roo.dd.DragZone": {
+ "Roo.dd.DropTarget": {
"props": [
{
- "name": "containerScroll",
- "type": "Boolean",
- "desc": "True to register this container with the Scrollmanager\nfor auto scrolling during drag operations.",
+ "name": "overClass",
+ "type": "String",
+ "desc": "The CSS class applied to the drop target element while the drag source is over it (defaults to \"\").",
"memberOf": ""
},
{
- "name": "hlColor",
+ "name": "ddGroup",
"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 drag drop group to handle drop events for",
"memberOf": ""
},
{
"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"
+ "memberOf": ""
},
{
"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"
+ "memberOf": ""
+ },
+ {
+ "name": "success",
+ "type": "boolean",
+ "desc": "set this after drop listener..",
+ "memberOf": ""
+ },
+ {
+ "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": ""
},
{
"name": "listeners",
"memberOf": "Roo.util.Observable"
}
],
- "events": [],
- "methods": [
- {
- "name": "addEvents",
- "sig": "(Object object)",
- "type": "function",
- "desc": "Used to define events on this Observable"
- },
- {
- "name": "addInvalidHandleClass",
- "sig": "(string cssClass)",
- "type": "function",
- "desc": "Lets you specify a css class of elements that will not initiate a drag"
- },
- {
- "name": "addInvalidHandleId",
- "sig": "(string id)",
- "type": "function",
- "desc": "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag"
- },
- {
- "name": "addInvalidHandleType",
- "sig": "(string tagName)",
- "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."
- },
- {
- "name": "addListener",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
- "type": "function",
- "desc": "Appends an event handler to this component"
- },
+ "events": [
{
- "name": "addToGroup",
- "sig": "( sGroup)",
+ "name": "drop",
+ "sig": "function (source, e, data)\n{\n\n}",
"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."
+ "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"
},
{
- "name": "afterRepair",
- "sig": "()",
+ "name": "enter",
+ "sig": "function (source, e, data)\n{\n\n}",
"type": "function",
- "desc": "Called after a repair of an invalid drop. By default, highlights this.dragData.ddel"
+ "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.overClass and this.dropAllowed"
},
{
- "name": "alignElWithMouse",
- "sig": "(HTMLElement el, int iPageX, int iPageY)",
+ "name": "out",
+ "sig": "function (source, e, data)\n{\n\n}",
"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."
+ "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."
},
{
- "name": "applyConfig",
- "sig": "()",
+ "name": "over",
+ "sig": "function (source, e, data)\n{\n\n}",
"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": "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.dropAllowed"
+ }
+ ],
+ "methods": [
{
- "name": "autoOffset",
- "sig": "(int iPageX, int iPageY)",
+ "name": "addEvents",
+ "sig": "(Object object)",
"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"
+ "desc": "Used to define events on this Observable"
},
{
- "name": "beforeDragDrop",
- "sig": "(Roo.dd.DragDrop target, Event e, String id)",
+ "name": "addInvalidHandleClass",
+ "sig": "(string cssClass)",
"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."
+ "desc": "Lets you specify a css class of elements that will not initiate a drag"
},
{
- "name": "beforeDragEnter",
- "sig": "(Roo.dd.DragDrop target, Event e, String id)",
+ "name": "addInvalidHandleId",
+ "sig": "(string id)",
"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."
+ "desc": "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag"
},
{
- "name": "beforeDragOut",
- "sig": "(Roo.dd.DragDrop target, Event e, String id)",
+ "name": "addInvalidHandleType",
+ "sig": "(string tagName)",
"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."
+ "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."
},
{
- "name": "beforeDragOver",
- "sig": "(Roo.dd.DragDrop target, Event e, String id)",
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"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."
+ "desc": "Appends an event handler to this component"
},
{
- "name": "beforeInvalidDrop",
- "sig": "(Roo.dd.DragDrop target, Event e, String id)",
+ "name": "addToGroup",
+ "sig": "( sGroup)",
"type": "function",
- "desc": "An empty function by default, but provided so that you can perform a custom action after an invalid\ndrop has occurred."
+ "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."
},
{
- "name": "cachePosition",
- "sig": "( iPageX, iPageY)",
+ "name": "applyConfig",
+ "sig": "()",
"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."
+ "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."
},
{
"name": "capture",
"type": "function",
"desc": "Clears any tick interval defined for this instance"
},
- {
- "name": "createFrame",
- "sig": "()",
- "type": "function",
- "desc": "Creates the proxy element if it does not yet exist"
- },
{
"name": "endDrag",
"sig": "(Event e)",
"type": "function",
"desc": "toString method"
},
- {
- "name": "getDragData",
- "sig": "(EventObject e)",
- "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."
- },
{
"name": "getDragEl",
"sig": "()",
"type": "function",
"desc": "Returns a reference to the linked element"
},
- {
- "name": "getProxy",
- "sig": "()",
- "type": "function",
- "desc": "Returns the drag source's underlying {@link Roo.dd.StatusProxy}"
- },
- {
- "name": "getRepairXY",
- "sig": "(EventObject e)",
- "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"
- },
{
"name": "hasListener",
"sig": "(String eventName)",
"type": "function",
"desc": "Checks to see if this object has any listeners for a specified event"
},
- {
- "name": "hideProxy",
- "sig": "()",
- "type": "function",
- "desc": "Hides the drag source's {@link Roo.dd.StatusProxy}"
- },
{
"name": "init",
"sig": "( id, String sGroup, object config)",
"type": "function",
"desc": "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass"
},
- {
- "name": "initFrame",
- "sig": "()",
- "type": "function",
- "desc": "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses"
- },
{
"name": "initTarget",
"sig": "( id, String sGroup, object config)",
"type": "function",
"desc": "Override the onAvailable method to do what is needed after the initial\nposition was determined."
},
- {
- "name": "onBeforeDrag",
- "sig": "(Object data, Event e)",
- "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."
- },
{
"name": "onDrag",
"sig": "(Event e)",
"type": "function",
"desc": "Abstract method called when this element is hovering over another\nDragDrop obj"
},
- {
- "name": "onInitDrag",
- "sig": "(Number x, Number y)",
- "type": "function",
- "desc": "Called once drag threshold has been reached to initialize the proxy element. By default, it clones the\nthis.dragData.ddel"
- },
{
"name": "onInvalidDrop",
"sig": "(Event e)",
"type": "function",
"desc": "Event handler that fires when a drag/drop obj gets a mouseup"
},
- {
- "name": "onStartDrag",
- "sig": "(Number x, Number y)",
- "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."
- },
{
"name": "padding",
"sig": "()",
"type": "function",
"desc": "resetConstraints must be called if you manually reposition a dd element."
},
- {
- "name": "setDelta",
- "sig": "(int iDeltaX, int iDeltaY)",
- "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)"
- },
{
"name": "setDragElId",
"sig": "( id)",
"type": "function",
"desc": "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag"
},
- {
- "name": "setDragElPos",
- "sig": "(int iPageX, int iPageY)",
- "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."
- },
{
"name": "setHandleElId",
"sig": "( id)",
}
]
},
- "Roo.dd.DropTarget": {
+ "Roo.dd.DropZone": {
"props": [
{
"name": "overClass",
"type": "String",
"desc": "The CSS class applied to the drop target element while the drag source is over it (defaults to \"\").",
- "memberOf": ""
+ "memberOf": "Roo.dd.DropTarget"
},
{
"name": "ddGroup",
"type": "String",
"desc": "The drag drop group to handle drop events for",
- "memberOf": ""
+ "memberOf": "Roo.dd.DropTarget"
},
{
"name": "dropAllowed",
"type": "String",
"desc": "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
- "memberOf": ""
+ "memberOf": "Roo.dd.DropTarget"
},
{
"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": ""
+ "memberOf": "Roo.dd.DropTarget"
},
{
"name": "success",
"type": "boolean",
"desc": "set this after drop listener..",
- "memberOf": ""
+ "memberOf": "Roo.dd.DropTarget"
},
{
"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": ""
+ "memberOf": "Roo.dd.DropTarget"
},
{
"name": "listeners",
"type": "function",
"desc": "Returns a reference to the linked element"
},
+ {
+ "name": "getTargetFromEvent",
+ "sig": "(Event e)",
+ "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."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"type": "function",
"desc": "Lock this instance"
},
+ {
+ "name": "notifyDrop",
+ "sig": "(Roo.dd.DragSource source, Event e, Object data)",
+ "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}."
+ },
+ {
+ "name": "notifyEnter",
+ "sig": "(Roo.dd.DragSource source, Event e, Object data)",
+ "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."
+ },
+ {
+ "name": "notifyOut",
+ "sig": "(Roo.dd.DragSource source, Event e, Object data)",
+ "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."
+ },
+ {
+ "name": "notifyOver",
+ "sig": "(Roo.dd.DragSource source, Event e, Object data)",
+ "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}."
+ },
{
"name": "on",
"sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
"desc": "Override the onAvailable method to do what is needed after the initial\nposition was determined."
},
+ {
+ "name": "onContainerDrop",
+ "sig": "(Roo.dd.DragSource source, Event e, Object data)",
+ "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."
+ },
+ {
+ "name": "onContainerOver",
+ "sig": "(Roo.dd.DragSource source, Event e, Object data)",
+ "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."
+ },
{
"name": "onDrag",
"sig": "(Event e)",
"type": "function",
"desc": "Event handler that fires when a drag/drop obj gets a mouseup"
},
+ {
+ "name": "onNodeDrop",
+ "sig": "(Object nodeData, Roo.dd.DragSource source, Event e, Object data)",
+ "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."
+ },
+ {
+ "name": "onNodeEnter",
+ "sig": "(Object nodeData, Roo.dd.DragSource source, Event e, Object data)",
+ "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."
+ },
+ {
+ "name": "onNodeOut",
+ "sig": "(Object nodeData, Roo.dd.DragSource source, Event e, Object data)",
+ "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."
+ },
+ {
+ "name": "onNodeOver",
+ "sig": "(Object nodeData, Roo.dd.DragSource source, Event e, Object data)",
+ "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."
+ },
{
"name": "padding",
"sig": "()",
}
]
},
- "Roo.dd.DropZone": {
+ "Roo.dd.Registry": {
+ "props": [],
+ "events": [],
+ "methods": [
+ {
+ "name": "getHandle",
+ "sig": "(String|HTMLElement id)",
+ "type": "function",
+ "desc": "Returns the handle registered for a DOM Node by id"
+ },
+ {
+ "name": "getHandleFromEvent",
+ "sig": "(Event e)",
+ "type": "function",
+ "desc": "Returns the handle that is registered for the DOM node that is the target of the event"
+ },
+ {
+ "name": "getTarget",
+ "sig": "(String|HTMLElement id)",
+ "type": "function",
+ "desc": "Returns a custom data object that is registered for a DOM node by id"
+ },
+ {
+ "name": "getTargetFromEvent",
+ "sig": "(Event e)",
+ "type": "function",
+ "desc": "Returns a custom data object that is registered for the DOM node that is the target of the event"
+ },
+ {
+ "name": "register",
+ "sig": "(String|HTMLElement element, Object data)",
+ "type": "function",
+ "desc": "Register a drag drop element"
+ },
+ {
+ "name": "unregister",
+ "sig": "(String|HTMLElement element)",
+ "type": "function",
+ "desc": "Unregister a drag drop element"
+ }
+ ]
+ },
+ "Roo.dd.ScrollManager": {
+ "props": [],
+ "events": [],
+ "methods": [
+ {
+ "name": "refreshCache",
+ "sig": "()",
+ "type": "function",
+ "desc": "Manually trigger a cache refresh."
+ },
+ {
+ "name": "register",
+ "sig": "(String/HTMLElement/Element/Array el)",
+ "type": "function",
+ "desc": "Registers new overflow element(s) to auto scroll"
+ },
+ {
+ "name": "unregister",
+ "sig": "(String/HTMLElement/Element/Array el)",
+ "type": "function",
+ "desc": "Unregisters overflow element(s) so they are no longer scrolled"
+ }
+ ]
+ },
+ "Roo.dd.StatusProxy": {
"props": [
{
- "name": "overClass",
+ "name": "dropAllowed",
"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": "The CSS class to apply to the status element when drop is allowed (defaults to \"x-dd-drop-ok\").",
+ "memberOf": ""
},
{
- "name": "ddGroup",
+ "name": "dropNotAllowed",
"type": "String",
- "desc": "The drag drop group to handle drop events for",
- "memberOf": "Roo.dd.DropTarget"
+ "desc": "The CSS class to apply to the status element when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
+ "memberOf": ""
+ }
+ ],
+ "events": [],
+ "methods": [
+ {
+ "name": "getEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the underlying proxy {@link Roo.Layer}"
},
{
- "name": "dropAllowed",
+ "name": "getGhost",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the ghost element"
+ },
+ {
+ "name": "hide",
+ "sig": "(Boolean clear)",
+ "type": "function",
+ "desc": "Hides the proxy"
+ },
+ {
+ "name": "repair",
+ "sig": "(Array xy, Function callback, Object scope)",
+ "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."
+ },
+ {
+ "name": "reset",
+ "sig": "(Boolean clearGhost)",
+ "type": "function",
+ "desc": "Resets the status indicator to the default dropNotAllowed value"
+ },
+ {
+ "name": "setStatus",
+ "sig": "(String cssClass)",
+ "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."
+ },
+ {
+ "name": "show",
+ "sig": "()",
+ "type": "function",
+ "desc": "Displays this proxy"
+ },
+ {
+ "name": "stop",
+ "sig": "()",
+ "type": "function",
+ "desc": "Stops the repair animation if it's currently running"
+ },
+ {
+ "name": "sync",
+ "sig": "()",
+ "type": "function",
+ "desc": "Force the Layer to sync its shadow and shim positions to the element"
+ },
+ {
+ "name": "update",
+ "sig": "(String html)",
+ "type": "function",
+ "desc": "Updates the contents of the ghost element"
+ }
+ ]
+ },
+ "Roo.doc": {
+ "props": [],
+ "events": [],
+ "methods": []
+ },
+ "Roo.doc.Book": {
+ "props": [
+ {
+ "name": "title",
"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": "Title of the book",
+ "memberOf": ""
},
{
- "name": "dropNotAllowed",
+ "name": "abstract",
"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": "Abstract (or just add para's to the book, and it will get added to the abstract)",
+ "memberOf": ""
},
{
- "name": "success",
- "type": "boolean",
- "desc": "set this after drop listener..",
- "memberOf": "Roo.dd.DropTarget"
+ "name": "cls",
+ "type": "String",
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "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": "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",
],
"events": [
{
- "name": "drop",
- "sig": "function (source, e, data)\n{\n\n}",
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
"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"
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
},
{
- "name": "enter",
- "sig": "function (source, e, data)\n{\n\n}",
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
"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.overClass and this.dropAllowed"
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
},
{
- "name": "out",
- "sig": "function (source, e, data)\n{\n\n}",
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
"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."
+ "desc": "Fires before the component is rendered. Return false to stop the render."
},
{
- "name": "over",
- "sig": "function (source, e, data)\n{\n\n}",
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
"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.dropAllowed"
- }
- ],
- "methods": [
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
{
- "name": "addEvents",
- "sig": "(Object object)",
+ "name": "childrenrendered",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Used to define events on this Observable"
+ "desc": "Fires when the children have been rendered.."
},
{
- "name": "addInvalidHandleClass",
- "sig": "(string cssClass)",
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Lets you specify a css class of elements that will not initiate a drag"
+ "desc": "Fires after the component is destroyed."
},
{
- "name": "addInvalidHandleId",
- "sig": "(string id)",
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag"
+ "desc": "Fires after the component is disabled."
},
{
- "name": "addInvalidHandleType",
- "sig": "(string tagName)",
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
"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."
+ "desc": "Fires after the component is enabled."
},
{
- "name": "addListener",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Appends an event handler to this component"
+ "desc": "Fires after the component is hidden."
},
{
- "name": "addToGroup",
- "sig": "( sGroup)",
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
"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."
+ "desc": "Fires after the component is rendered."
},
{
- "name": "applyConfig",
- "sig": "()",
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
"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": "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",
"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."
},
{
- "name": "clearConstraints",
+ "name": "destroy",
"sig": "()",
"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}."
},
{
- "name": "clearTicks",
+ "name": "disable",
"sig": "()",
"type": "function",
- "desc": "Clears any tick interval defined for this instance"
+ "desc": "Disable this component."
},
- {
- "name": "endDrag",
- "sig": "(Event e)",
+ {
+ "name": "enable",
+ "sig": "()",
"type": "function",
- "desc": "Fired when we are done dragging the object"
+ "desc": "Enable this component."
},
{
"name": "fireEvent",
"desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "function toString() {\n [native code]\n}",
- "sig": "()",
+ "name": "focus",
+ "sig": "(Boolean selectText)",
"type": "function",
- "desc": "toString method"
+ "desc": "Try to focus this component."
},
{
- "name": "getDragEl",
+ "name": "getChildContainer",
"sig": "()",
"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": "Fetch the element to add children to"
},
{
"name": "getEl",
"sig": "()",
"type": "function",
- "desc": "Returns a reference to the linked element"
+ "desc": "Returns the underlying {@link Roo.Element}."
},
{
- "name": "getTargetFromEvent",
- "sig": "(Event e)",
+ "name": "getId",
+ "sig": "()",
"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."
+ "desc": "Returns the id of this component."
},
{
"name": "hasListener",
"desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "init",
- "sig": "( id, String sGroup, object config)",
- "type": "function",
- "desc": "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass"
- },
- {
- "name": "initTarget",
- "sig": "( id, String sGroup, object config)",
+ "name": "hide",
+ "sig": "()",
"type": "function",
- "desc": "Initializes Targeting functionality only... the object does not\nget a mousedown handler."
+ "desc": "Hide a component - adds 'hidden' class"
},
{
- "name": "isLocked",
+ "name": "initEvents",
"sig": "()",
"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": "Initialize Events for the element"
},
{
- "name": "isTarget",
+ "name": "isVisible",
"sig": "()",
"type": "function",
- "desc": "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false."
+ "desc": "Returns true if this component is visible."
},
{
- "name": "isValidHandleChild",
- "sig": "(HTMLElement node)",
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "Checks the tag exclusion list to see if this click should be ignored"
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
},
{
- "name": "lock",
+ "name": "purgeListeners",
"sig": "()",
"type": "function",
- "desc": "Lock this instance"
+ "desc": "Removes all listeners for this object"
},
{
- "name": "notifyDrop",
- "sig": "(Roo.dd.DragSource source, Event e, Object data)",
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
"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}."
+ "desc": "Removes <b>all</b> added captures from the Observable."
},
{
- "name": "notifyEnter",
- "sig": "(Roo.dd.DragSource source, Event e, Object data)",
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
"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."
+ "desc": "Removes a listener"
},
{
- "name": "notifyOut",
- "sig": "(Roo.dd.DragSource source, Event e, Object data)",
+ "name": "render",
+ "sig": "(String/HTMLElement/Element container)",
"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."
+ "desc": "If this is a lazy rendering component, render it to its container element."
},
{
- "name": "notifyOver",
- "sig": "(Roo.dd.DragSource source, Event e, Object data)",
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
"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}."
+ "desc": "Convenience function for setting disabled/enabled by boolean."
},
{
- "name": "on",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "name": "setVisible",
+ "sig": "(Boolean visible)",
"type": "function",
- "desc": "Appends an event handler to this element (shorthand for addListener)"
+ "desc": "Convenience function to hide or show this component by boolean."
},
{
- "name": "onAvailable",
+ "name": "show",
"sig": "()",
"type": "function",
- "desc": "Override the onAvailable method to do what is needed after the initial\nposition was determined."
- },
- {
- "name": "onContainerDrop",
- "sig": "(Roo.dd.DragSource source, Event e, Object data)",
- "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."
+ "desc": "Show a component - removes 'hidden' class"
},
{
- "name": "onContainerOver",
- "sig": "(Roo.dd.DragSource source, Event e, Object data)",
+ "name": "tooltipEl",
+ "sig": "()",
"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."
+ "desc": "Fetch the element to display the tooltip on."
},
{
- "name": "onDrag",
- "sig": "(Event e)",
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
"type": "function",
- "desc": "Abstract method called during the onMouseMove event while dragging an\nobject."
- },
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.doc.Entry": {
+ "props": [
{
- "name": "onDragDrop",
- "sig": "(Event e, String|DragDrop[] id)",
- "type": "function",
- "desc": "Abstract method called when this item is dropped on another DragDrop\nobj"
+ "name": "name",
+ "type": "",
+ "desc": "{String} name of method",
+ "memberOf": ""
},
{
- "name": "onDragEnter",
- "sig": "(Event e, String|DragDrop[] id)",
- "type": "function",
- "desc": "Abstract method called when this element fist begins hovering over\nanother DragDrop obj"
+ "name": "purpose",
+ "type": "",
+ "desc": "{String} short description of method.",
+ "memberOf": ""
},
{
- "name": "onDragOut",
- "sig": "(Event e, String|DragDrop[] id)",
- "type": "function",
- "desc": "Abstract method called when we are no longer hovering over an element"
+ "name": "cls",
+ "type": "String",
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "onDragOver",
- "sig": "(Event e, String|DragDrop[] id)",
- "type": "function",
- "desc": "Abstract method called when this element is hovering over another\nDragDrop obj"
+ "name": "style",
+ "type": "String",
+ "desc": "any extra css",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "onInvalidDrop",
- "sig": "(Event e)",
- "type": "function",
- "desc": "Abstract method called when this item is dropped on an area with no\ndrop target"
+ "name": "xattr",
+ "type": "Object",
+ "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "onMouseDown",
- "sig": "(Event e)",
- "type": "function",
- "desc": "Event handler that fires when a drag/drop obj gets a mousedown"
+ "name": "can_build_overlaid",
+ "type": "Boolean",
+ "desc": "True if element can be rebuild from a HTML page",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "onMouseUp",
- "sig": "(Event e)",
- "type": "function",
- "desc": "Event handler that fires when a drag/drop obj gets a mouseup"
+ "name": "dataId",
+ "type": "string",
+ "desc": "cutomer id",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "onNodeDrop",
- "sig": "(Object nodeData, Roo.dd.DragSource source, Event e, Object data)",
- "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."
+ "name": "tooltip",
+ "type": "string",
+ "desc": "Text for the tooltip",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "onNodeEnter",
- "sig": "(Object nodeData, Roo.dd.DragSource source, Event e, Object data)",
- "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."
+ "name": "container_method",
+ "type": "string",
+ "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "onNodeOut",
- "sig": "(Object nodeData, Roo.dd.DragSource source, Event e, Object data)",
- "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."
+ "name": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
},
{
- "name": "onNodeOver",
- "sig": "(Object nodeData, Roo.dd.DragSource source, Event e, Object data)",
- "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."
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
},
{
- "name": "padding",
- "sig": "()",
- "type": "function",
- "desc": "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object."
+ "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": "purgeListeners",
- "sig": "()",
- "type": "function",
- "desc": "Removes all listeners for this object"
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
},
{
- "name": "releaseCapture",
- "sig": "(Observable o)",
- "type": "function",
- "desc": "Removes <b>all</b> added captures from the Observable."
- },
+ "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"
+ }
+ ],
+ "events": [
{
- "name": "removeFromGroup",
- "sig": "(string sGroup)",
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Remove's this instance from the supplied interaction group"
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
},
{
- "name": "removeInvalidHandleClass",
- "sig": "(string cssClass)",
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Unsets an invalid css class"
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
},
{
- "name": "removeInvalidHandleId",
- "sig": "(string id)",
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Unsets an invalid handle id"
+ "desc": "Fires before the component is rendered. Return false to stop the render."
},
{
- "name": "removeInvalidHandleType",
- "sig": "(string tagName)",
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Unsets an excluded tag name set by addInvalidHandleType"
+ "desc": "Fires before the component is shown. Return false to stop the show."
},
{
- "name": "removeListener",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "childrenrendered",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Removes a listener"
+ "desc": "Fires when the children have been rendered.."
},
{
- "name": "resetConstraints",
- "sig": "(boolean maintainOffset)",
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "resetConstraints must be called if you manually reposition a dd element."
+ "desc": "Fires after the component is destroyed."
},
{
- "name": "setDragElId",
- "sig": "( id)",
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag"
+ "desc": "Fires after the component is disabled."
},
{
- "name": "setHandleElId",
- "sig": "( id)",
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
"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."
+ "desc": "Fires after the component is enabled."
},
{
- "name": "setInitPosition",
- "sig": "(int diffX, int diffY)",
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Stores the initial placement of the linked element."
+ "desc": "Fires after the component is hidden."
},
{
- "name": "setOuterHandleElId",
- "sig": "( id)",
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Allows you to set an element outside of the linked element as a drag\nhandle"
+ "desc": "Fires after the component is rendered."
},
{
- "name": "setPadding",
- "sig": "(int iTop, int iRight, int iBot, int iLeft)",
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
"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."
- },
+ "desc": "Fires after the component is shown."
+ }
+ ],
+ "methods": [
{
- "name": "setXConstraint",
- "sig": "(int iLeft, int iRight, int iTickSize)",
+ "name": "addEvents",
+ "sig": "(Object object)",
"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."
+ "desc": "Used to define events on this Observable"
},
{
- "name": "setYConstraint",
- "sig": "(int iUp, int iDown, int iTickSize)",
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"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."
+ "desc": "Appends an event handler to this component"
},
{
- "name": "startDrag",
- "sig": "(int X, int Y)",
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
"type": "function",
- "desc": "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met."
+ "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."
},
{
- "name": "un",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "destroy",
+ "sig": "()",
"type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
+ "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": "unlock",
+ "name": "disable",
"sig": "()",
"type": "function",
- "desc": "Unlock this instace"
+ "desc": "Disable this component."
},
{
- "name": "unreg",
+ "name": "enable",
"sig": "()",
"type": "function",
- "desc": "Remove all drag and drop hooks for this element"
- }
- ]
- },
- "Roo.dd.Registry": {
- "props": [],
- "events": [],
- "methods": [
+ "desc": "Enable this component."
+ },
{
- "name": "getHandle",
- "sig": "(String|HTMLElement id)",
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
"type": "function",
- "desc": "Returns the handle registered for a DOM Node by id"
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "getHandleFromEvent",
- "sig": "(Event e)",
+ "name": "focus",
+ "sig": "(Boolean selectText)",
"type": "function",
- "desc": "Returns the handle that is registered for the DOM node that is the target of the event"
+ "desc": "Try to focus this component."
},
{
- "name": "getTarget",
- "sig": "(String|HTMLElement id)",
+ "name": "getChildContainer",
+ "sig": "()",
"type": "function",
- "desc": "Returns a custom data object that is registered for a DOM node by id"
+ "desc": "Fetch the element to add children to"
},
{
- "name": "getTargetFromEvent",
- "sig": "(Event e)",
+ "name": "getEl",
+ "sig": "()",
"type": "function",
- "desc": "Returns a custom data object that is registered for the DOM node that is the target of the event"
+ "desc": "Returns the underlying {@link Roo.Element}."
},
{
- "name": "register",
- "sig": "(String|HTMLElement element, Object data)",
+ "name": "getId",
+ "sig": "()",
"type": "function",
- "desc": "Register a drag drop element"
+ "desc": "Returns the id of this component."
},
{
- "name": "unregister",
- "sig": "(String|HTMLElement element)",
+ "name": "hasListener",
+ "sig": "(String eventName)",
"type": "function",
- "desc": "Unregister a drag drop element"
- }
- ]
- },
- "Roo.dd.ScrollManager": {
- "props": [],
- "events": [],
- "methods": [
+ "desc": "Checks to see if this object has any listeners for a specified event"
+ },
{
- "name": "refreshCache",
+ "name": "hide",
"sig": "()",
"type": "function",
- "desc": "Manually trigger a cache refresh."
+ "desc": "Hide a component - adds 'hidden' class"
},
{
- "name": "register",
- "sig": "(String/HTMLElement/Element/Array el)",
+ "name": "initEvents",
+ "sig": "()",
"type": "function",
- "desc": "Registers new overflow element(s) to auto scroll"
+ "desc": "Initialize Events for the element"
},
{
- "name": "unregister",
- "sig": "(String/HTMLElement/Element/Array el)",
+ "name": "isVisible",
+ "sig": "()",
"type": "function",
- "desc": "Unregisters overflow element(s) so they are no longer scrolled"
- }
- ]
- },
- "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": ""
+ "desc": "Returns true if this component is visible."
},
{
- "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": ""
- }
- ],
- "events": [],
- "methods": [
- {
- "name": "getEl",
- "sig": "()",
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "Returns the underlying proxy {@link Roo.Layer}"
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
},
{
- "name": "getGhost",
+ "name": "purgeListeners",
"sig": "()",
"type": "function",
- "desc": "Returns the ghost element"
+ "desc": "Removes all listeners for this object"
},
{
- "name": "hide",
- "sig": "(Boolean clear)",
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
"type": "function",
- "desc": "Hides the proxy"
+ "desc": "Removes <b>all</b> added captures from the Observable."
},
{
- "name": "repair",
- "sig": "(Array xy, Function callback, Object scope)",
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
"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."
+ "desc": "Removes a listener"
},
{
- "name": "reset",
- "sig": "(Boolean clearGhost)",
+ "name": "render",
+ "sig": "(String/HTMLElement/Element container)",
"type": "function",
- "desc": "Resets the status indicator to the default dropNotAllowed value"
+ "desc": "If this is a lazy rendering component, render it to its container element."
},
{
- "name": "setStatus",
- "sig": "(String cssClass)",
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
"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."
+ "desc": "Convenience function for setting disabled/enabled by boolean."
},
{
- "name": "show",
- "sig": "()",
+ "name": "setVisible",
+ "sig": "(Boolean visible)",
"type": "function",
- "desc": "Displays this proxy"
+ "desc": "Convenience function to hide or show this component by boolean."
},
{
- "name": "stop",
+ "name": "show",
"sig": "()",
"type": "function",
- "desc": "Stops the repair animation if it's currently running"
+ "desc": "Show a component - removes 'hidden' class"
},
{
- "name": "sync",
+ "name": "tooltipEl",
"sig": "()",
"type": "function",
- "desc": "Force the Layer to sync its shadow and shim positions to the element"
+ "desc": "Fetch the element to display the tooltip on."
},
{
- "name": "update",
- "sig": "(String html)",
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
"type": "function",
- "desc": "Updates the contents of the ghost element"
+ "desc": "Removes a listener (shorthand for removeListener)"
}
]
},
- "Roo.doc": {
- "props": [],
- "events": [],
- "methods": []
- },
- "Roo.doc.Entry": {
+ "Roo.doc.Example": {
"props": [
{
- "name": "name",
- "type": "",
- "desc": "{String} name of method",
+ "name": "title",
+ "type": "String",
+ "desc": "short title describing example",
"memberOf": ""
},
{
- "name": "purpose",
- "type": "",
- "desc": "{String} short description of method.",
+ "name": "lang",
+ "type": "String",
+ "desc": "code language.",
+ "memberOf": "",
+ "optvals": [
+ "php",
+ "txt",
+ "sql"
+ ]
+ },
+ {
+ "name": "code",
+ "type": "String",
+ "desc": "example code",
+ "memberOf": ""
+ },
+ {
+ "name": "output",
+ "type": "String",
+ "desc": "The expected output from the code",
+ "memberOf": ""
+ },
+ {
+ "name": "outputlang",
+ "type": "String",
+ "desc": "php|txt|sql) output language",
"memberOf": ""
},
{
"desc": "cutomer id",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "name",
+ "type": "string",
+ "desc": "Specifies name attribute",
+ "memberOf": "Roo.bootstrap.Component"
+ },
{
"name": "tooltip",
"type": "string",
}
]
},
- "Roo.doc.Example": {
+ "Roo.doc.NavCategory": {
"props": [
{
- "name": "lang",
+ "name": "title",
+ "type": "string",
+ "desc": "",
+ "memberOf": ""
+ },
+ {
+ "name": "name",
+ "type": "string",
+ "desc": "Represent's an category on the left menu.\n- phpdoc @category elements map the pages to the categories\n this should be on the left side of the menu, when the\n contents are loaded, then it can expand this out, and add links\n for each of the methods.",
+ "memberOf": ""
+ },
+ {
+ "name": "cls",
"type": "String",
- "desc": "section type.",
- "memberOf": "",
+ "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": "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": [
- "phpcode",
- "programlisting"
+ "display",
+ "visibility"
]
},
{
- "name": "code",
+ "name": "actionMode",
"type": "String",
- "desc": "",
- "memberOf": ""
+ "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<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "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\n<b>before</b> 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 <b>all</b> 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": [
{
"name": "is_optional",
"type": "bool",
- "desc": "",
+ "desc": "is the argument optional",
"memberOf": ""
},
{
{
"name": "name",
"type": "String",
- "desc": "",
+ "desc": "name of the parameter",
"memberOf": ""
},
{
"desc": "return value",
"memberOf": ""
},
+ {
+ "name": "returndesc",
+ "type": "String",
+ "desc": "description of return value. (used in the return section if set..)",
+ "memberOf": ""
+ },
{
"name": "name",
"type": "String",
"constant"
]
},
+ {
+ "name": "memberof",
+ "type": "String",
+ "desc": "class name",
+ "memberOf": ""
+ },
+ {
+ "name": "is_static",
+ "type": "bool",
+ "desc": "is a static member",
+ "memberOf": ""
+ },
+ {
+ "name": "is_constructor",
+ "type": "bool",
+ "desc": "is a static member",
+ "memberOf": ""
+ },
{
"name": "cls",
"type": "String",
{
"name": "renderer",
"type": "Function",
- "desc": "(Optional) 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 uses the raw 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",
+ "desc": "(Optional) 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": ""
},
{
}
]
},
+ "Roo.mailer.Body": {
+ "props": [
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "class of the element",
+ "memberOf": ""
+ },
+ {
+ "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<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "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\n<b>before</b> 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 <b>all</b> 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.mailer.BodyContainer": {
"props": [
{
}
]
},
- "_calls": {
- "props": [
- {
- "name": "cls",
- "type": "String",
- "desc": "class of the element",
- "memberOf": ""
- },
- {
- "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<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf": "Roo.util.Observable"
- }
- ],
- "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\n<b>before</b> 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 <b>all</b> 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)"
- }
- ]
- },
"this": {
"props": [],
"events": [],
projects / roojs1 / blobdiff