"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": [],
"type": "function",
"desc": "Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)"
},
+ {
+ "name": "findScrollableParent",
+ "sig": "()",
+ "type": "function",
+ "desc": "Looks at the scrollable parent element"
+ },
{
"name": "fitToParent",
"sig": "(Boolean monitorResize, String/HTMLElment/Element targetParent)",
"type": "function",
"desc": "Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)"
},
+ {
+ "name": "findScrollableParent",
+ "sig": "()",
+ "type": "function",
+ "desc": "Looks at the scrollable parent element"
+ },
{
"name": "fitToParent",
"sig": "(Boolean monitorResize, String/HTMLElment/Element targetParent)",
}
],
"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}",
"type": "function",
"desc": "Checks to see if this object has any listeners for a specified event"
},
+ {
+ "name": "overlayStrings",
+ "sig": "(Object element, Object associative)",
+ "type": "function",
+ "desc": "Overlay a set of modified strings onto a component\nThis is dependant on our builder exporting the strings and 'named strings' elements."
+ },
{
"name": "preBuild",
"sig": "()",
"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",
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
"optvals": [
- "display",
- "visibility"
+ "el",
+ "parent"
]
},
- {
- "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.Body": {
- "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",
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
}
]
},
- "Roo.bootstrap.Button": {
+ "Roo.bootstrap.Body": {
"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",
- "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",
- "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",
- "type": "String",
- "desc": "default",
- "memberOf": ""
- },
- {
- "name": "inverse",
- "type": "Boolean",
- "desc": "",
- "memberOf": ""
- },
- {
- "name": "toggle",
- "type": "Boolean",
- "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": ""
- },
{
"name": "cls",
"type": "String",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
"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 button"
+ "desc": "Disable this component."
},
{
"name": "enable",
"sig": "()",
"type": "function",
- "desc": "Enables this button"
+ "desc": "Enable this component."
},
{
"name": "fireEvent",
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"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.Brick": {
"props": [
{
- "name": "size",
+ "name": "title",
"type": "String",
- "desc": "lg | sm | xs (default empty normal)",
+ "desc": "",
"memberOf": ""
},
{
- "name": "align",
+ "name": "html",
"type": "String",
- "desc": "vertical | justified (default none)",
+ "desc": "",
"memberOf": ""
},
{
- "name": "direction",
+ "name": "bgimage",
"type": "String",
- "desc": "up | down (default down)",
+ "desc": "",
"memberOf": ""
},
{
- "name": "toolbar",
- "type": "Boolean",
- "desc": "false | true",
+ "name": "cls",
+ "type": "String",
+ "desc": "",
"memberOf": ""
},
{
- "name": "btn",
- "type": "Boolean",
- "desc": "true | false",
+ "name": "href",
+ "type": "String",
+ "desc": "",
"memberOf": ""
},
{
- "name": "cls",
+ "name": "video",
"type": "String",
- "desc": "css class",
- "memberOf": "Roo.bootstrap.Component"
+ "desc": "",
+ "memberOf": ""
+ },
+ {
+ "name": "square",
+ "type": "Boolean",
+ "desc": "",
+ "memberOf": ""
},
{
"name": "style",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
"type": "function",
"desc": "Fires when the children have been rendered.."
},
+ {
+ "name": "click",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "When a Brick is click"
+ },
{
"name": "destroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
}
]
},
- "Roo.bootstrap.Calendar": {
+ "Roo.bootstrap.Button": {
"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",
+ "name": "html",
+ "type": "String",
+ "desc": "The button content",
"memberOf": ""
},
{
- "name": "startDay",
- "type": "Number",
- "desc": "Day index at which the week should begin, 0-based (defaults to 0, which is Sunday)",
- "memberOf": ""
+ "name": "weight",
+ "type": "String",
+ "desc": "default",
+ "memberOf": "",
+ "optvals": [
+ "default",
+ "primary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "link"
+ ]
},
{
- "name": "cls",
+ "name": "size",
"type": "String",
- "desc": "css class",
- "memberOf": "Roo.bootstrap.Component"
+ "desc": "",
+ "memberOf": "",
+ "optvals": [
+ "lg",
+ "sm",
+ "xs"
+ ]
},
{
- "name": "style",
+ "name": "tag",
"type": "String",
- "desc": "any extra css",
- "memberOf": "Roo.bootstrap.Component"
+ "desc": "",
+ "memberOf": "",
+ "optvals": [
+ "a",
+ "input",
+ "submit"
+ ]
},
{
- "name": "xattr",
- "type": "Object",
- "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "href",
+ "type": "String",
+ "desc": "empty or href",
+ "memberOf": ""
},
{
- "name": "can_build_overlaid",
+ "name": "disabled",
"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"
+ "desc": "default false;",
+ "memberOf": ""
},
{
- "name": "tooltip",
- "type": "string",
- "desc": "Text for the tooltip",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "isClose",
+ "type": "Boolean",
+ "desc": "default false;",
+ "memberOf": ""
},
{
- "name": "container_method",
- "type": "string",
- "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "name": "glyphicon",
+ "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",
+ "type": "String",
+ "desc": "default",
+ "memberOf": ""
+ },
+ {
+ "name": "inverse",
+ "type": "Boolean",
+ "desc": "",
+ "memberOf": ""
+ },
+ {
+ "name": "toggle",
+ "type": "Boolean",
+ "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": ""
+ },
+ {
+ "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
"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}",
"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."
+ },
+ {
+ "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": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"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.CheckBox": {
+ "Roo.bootstrap.ButtonGroup": {
"props": [
{
- "name": "valueOff",
+ "name": "size",
"type": "String",
- "desc": "The value that should go into the generated input element's value when unchecked.",
+ "desc": "lg | sm | xs (default empty normal)",
"memberOf": ""
},
{
- "name": "inputValue",
+ "name": "align",
"type": "String",
- "desc": "The value that should go into the generated input element's value when checked.",
+ "desc": "vertical | justified (default none)",
"memberOf": ""
},
{
- "name": "boxLabel",
+ "name": "direction",
"type": "String",
- "desc": "The text that appears beside the checkbox",
+ "desc": "up | down (default down)",
"memberOf": ""
},
{
- "name": "weight",
- "type": "String",
- "desc": "The text that appears beside the checkbox",
- "memberOf": "",
- "optvals": [
- "primary",
- "warning",
- "info",
- "danger",
- "success"
- ]
- },
- {
- "name": "checked",
+ "name": "toolbar",
"type": "Boolean",
- "desc": "initnal the element",
+ "desc": "false | true",
"memberOf": ""
},
{
- "name": "inline",
+ "name": "btn",
"type": "Boolean",
- "desc": "inline the element (default false)",
+ "desc": "true | false",
"memberOf": ""
},
{
- "name": "groupId",
+ "name": "cls",
"type": "String",
- "desc": "the checkbox group id // normal just use for checkbox",
- "memberOf": ""
- },
- {
- "name": "disabled",
- "type": "Boolean",
- "desc": "is it disabled",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "fieldLabel",
+ "name": "style",
"type": "String",
- "desc": "- the label associated",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "any extra css",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "inputType",
- "type": "String",
- "desc": "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "xattr",
+ "type": "Object",
+ "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "name",
- "type": "String",
- "desc": "name of the input",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "can_build_overlaid",
+ "type": "Boolean",
+ "desc": "True if element can be rebuild from a HTML page",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "placeholder",
+ "name": "dataId",
"type": "string",
- "desc": "- placeholder to put in text.",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "cutomer id",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "before",
+ "name": "name",
"type": "string",
- "desc": "- input group add on before",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "Specifies name attribute",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "after",
+ "name": "tooltip",
"type": "string",
- "desc": "- input group add on after",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "Text for the tooltip",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "size",
+ "name": "container_method",
"type": "string",
- "desc": "- (lg|sm) or leave empty..",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "xs",
- "type": "Number",
- "desc": "colspan out of 12 for mobile-sized screens",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
},
{
- "name": "sm",
- "type": "Number",
- "desc": "colspan out of 12 for tablet-sized screens",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
},
{
- "name": "md",
- "type": "Number",
- "desc": "colspan out of 12 for computer-sized screens",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
},
{
- "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",
- "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",
- "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": [
- "display",
- "visibility"
- ]
+ "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": "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": "()",
"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",
+ "name": "getVisibilityEl",
"sig": "()",
"type": "function",
- "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
+ "desc": "Get the element that will be used to show or hide"
},
{
"name": "hasListener",
"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.Column": {
+ "Roo.bootstrap.Calendar": {
"props": [
{
- "name": "xs",
- "type": "Number",
- "desc": "colspan out of 12 for mobile-sized screens or 0 for hidden",
- "memberOf": ""
- },
- {
- "name": "sm",
- "type": "Number",
- "desc": "colspan out of 12 for tablet-sized screens or 0 for hidden",
- "memberOf": ""
- },
- {
- "name": "md",
- "type": "Number",
- "desc": "colspan out of 12 for computer-sized screens or 0 for hidden",
- "memberOf": ""
- },
- {
- "name": "lg",
- "type": "Number",
- "desc": "colspan out of 12 for large computer-sized screens or 0 for hidden",
- "memberOf": ""
- },
- {
- "name": "xsoff",
- "type": "Number",
- "desc": "colspan offset out of 12 for mobile-sized screens or 0 for hidden",
- "memberOf": ""
- },
- {
- "name": "smoff",
- "type": "Number",
- "desc": "colspan offset out of 12 for tablet-sized screens or 0 for hidden",
- "memberOf": ""
- },
- {
- "name": "mdoff",
- "type": "Number",
- "desc": "colspan offset out of 12 for computer-sized screens or 0 for hidden",
- "memberOf": ""
- },
- {
- "name": "lgoff",
- "type": "Number",
- "desc": "colspan offset out of 12 for large computer-sized screens or 0 for hidden",
- "memberOf": ""
- },
- {
- "name": "hidden",
+ "name": "loadMask",
"type": "Boolean",
- "desc": "hide the element",
+ "desc": "default false",
"memberOf": "",
"optvals": [
"true",
]
},
{
- "name": "alert",
- "type": "String",
- "desc": "type alert (changes background / border...)",
- "memberOf": "",
- "optvals": [
- "success",
- "info",
- "warning",
- "danger"
- ]
- },
- {
- "name": "fa",
- "type": "String",
- "desc": "font awesome icon",
- "memberOf": "",
- "optvals": [
- "ban",
- "check",
- "..."
- ]
+ "name": "header",
+ "type": "Object",
+ "desc": "generate the user specific header of the calendar, default false",
+ "memberOf": ""
},
{
- "name": "fasize",
+ "name": "startDay",
"type": "Number",
- "desc": "font awsome size",
- "memberOf": "",
- "optvals": [
- "1",
- "2",
- "...."
- ]
- },
- {
- "name": "icon",
- "type": "String",
- "desc": "glyphicon name",
- "memberOf": "",
- "optvals": [
- "info-sign",
- "check",
- "..."
- ]
- },
- {
- "name": "html",
- "type": "String",
- "desc": "content of column.",
+ "desc": "Day index at which the week should begin, 0-based (defaults to 0, which is Sunday)",
"memberOf": ""
},
{
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
"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}",
"desc": "Fires after the component is rendered."
},
{
- "name": "show",
+ "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."
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
}
]
},
- "Roo.bootstrap.ComboBox": {
+ "Roo.bootstrap.CheckBox": {
"props": [
{
- "name": "append",
- "type": "Boolean",
- "desc": "default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
- },
- {
- "name": "autoFocus",
- "type": "Boolean",
- "desc": "auto focus the first item, default true",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
- },
- {
- "name": "tickable",
- "type": "Boolean",
- "desc": "ComboBox with tickable selections (true|false), default false",
- "memberOf": ""
- },
- {
- "name": "triggerList",
- "type": "Boolean",
- "desc": "trigger show the list or not (true|false) default true",
- "memberOf": ""
- },
- {
- "name": "showToggleBtn",
- "type": "Boolean",
- "desc": "show toggle button or not (true|false) default true",
- "memberOf": ""
- },
- {
- "name": "btnPosition",
- "type": "String",
- "desc": "set the position of the trigger button (left | right) default right",
- "memberOf": ""
- },
- {
- "name": "animate",
- "type": "Boolean",
- "desc": "default true",
- "memberOf": ""
- },
- {
- "name": "emptyResultText",
- "type": "Boolean",
- "desc": "only for touch device",
- "memberOf": ""
- },
- {
- "name": "lazyRender",
- "type": "Boolean",
- "desc": "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
- "memberOf": ""
- },
- {
- "name": "autoCreate",
- "type": "Boolean/Object",
- "desc": "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
- "memberOf": ""
- },
- {
- "name": "store",
- "type": "Roo.data.Store",
- "desc": "The data store to which this combo is bound (defaults to undefined)",
- "memberOf": ""
- },
- {
- "name": "title",
- "type": "String",
- "desc": "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
- "memberOf": ""
- },
- {
- "name": "tpl",
- "type": "String/Roo.Template",
- "desc": "The template to use to render the output",
- "memberOf": ""
- },
- {
- "name": "grow",
- "type": "Boolean",
- "desc": "",
- "memberOf": ""
- },
- {
- "name": "growMin",
- "type": "Number",
- "desc": "",
- "memberOf": ""
- },
- {
- "name": "growMax",
- "type": "Number",
- "desc": "",
- "memberOf": ""
- },
- {
- "name": "listWidth",
- "type": "Number",
- "desc": "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
- "memberOf": ""
- },
- {
- "name": "displayField",
- "type": "String",
- "desc": "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
- "memberOf": ""
- },
- {
- "name": "valueField",
- "type": "String",
- "desc": "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
- "memberOf": ""
- },
- {
- "name": "hiddenName",
- "type": "String",
- "desc": "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
- "memberOf": ""
- },
- {
- "name": "listClass",
- "type": "String",
- "desc": "CSS class to apply to the dropdown list element (defaults to '')",
- "memberOf": ""
- },
- {
- "name": "selectedClass",
- "type": "String",
- "desc": "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
- "memberOf": ""
- },
- {
- "name": "shadow",
- "type": "Boolean/String",
- "desc": "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
- "memberOf": ""
- },
- {
- "name": "listAlign",
- "type": "String",
- "desc": "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
- "memberOf": ""
- },
- {
- "name": "maxHeight",
- "type": "Number",
- "desc": "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
- "memberOf": ""
- },
- {
- "name": "triggerAction",
- "type": "String",
- "desc": "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
- "memberOf": ""
- },
- {
- "name": "minChars",
- "type": "Number",
- "desc": "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
- "memberOf": ""
- },
- {
- "name": "typeAhead",
- "type": "Boolean",
- "desc": "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
- "memberOf": ""
- },
- {
- "name": "queryDelay",
- "type": "Number",
- "desc": "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
- "memberOf": ""
- },
- {
- "name": "pageSize",
- "type": "Number",
- "desc": "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
- "memberOf": ""
- },
- {
- "name": "selectOnFocus",
- "type": "Boolean",
- "desc": "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
- "memberOf": ""
- },
- {
- "name": "queryParam",
- "type": "String",
- "desc": "Name of the query as it will be passed on the querystring (defaults to 'query')",
- "memberOf": ""
- },
- {
- "name": "loadingText",
+ "name": "valueOff",
"type": "String",
- "desc": "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
- "memberOf": ""
- },
- {
- "name": "resizable",
- "type": "Boolean",
- "desc": "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
- "memberOf": ""
- },
- {
- "name": "handleHeight",
- "type": "Number",
- "desc": "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
- "memberOf": ""
- },
- {
- "name": "editable",
- "type": "Boolean",
- "desc": "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
+ "desc": "The value that should go into the generated input element's value when unchecked.",
"memberOf": ""
},
{
- "name": "allQuery",
+ "name": "inputValue",
"type": "String",
- "desc": "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
+ "desc": "The value that should go into the generated input element's value when checked.",
"memberOf": ""
},
{
- "name": "mode",
+ "name": "boxLabel",
"type": "String",
- "desc": "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
- "memberOf": ""
- },
- {
- "name": "minListWidth",
- "type": "Number",
- "desc": "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
- "memberOf": ""
- },
- {
- "name": "forceSelection",
- "type": "Boolean",
- "desc": "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
- "memberOf": ""
- },
- {
- "name": "typeAheadDelay",
- "type": "Number",
- "desc": "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
+ "desc": "The text that appears beside the checkbox",
"memberOf": ""
},
{
- "name": "valueNotFoundText",
+ "name": "weight",
"type": "String",
- "desc": "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
- "memberOf": ""
- },
- {
- "name": "blockFocus",
- "type": "Boolean",
- "desc": "Prevents all focus calls, so it can work with things like HTML edtor bar",
- "memberOf": ""
+ "desc": "The text that appears beside the checkbox",
+ "memberOf": "",
+ "optvals": [
+ "primary",
+ "warning",
+ "info",
+ "danger",
+ "success"
+ ]
},
{
- "name": "disableClear",
+ "name": "checked",
"type": "Boolean",
- "desc": "Disable showing of clear button.",
+ "desc": "initnal the element",
"memberOf": ""
},
{
- "name": "alwaysQuery",
+ "name": "inline",
"type": "Boolean",
- "desc": "Disable caching of results, and always send query",
+ "desc": "inline the element (default false)",
"memberOf": ""
},
{
- "name": "multiple",
- "type": "Boolean",
- "desc": "ComboBobArray, default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
- },
- {
- "name": "invalidClass",
+ "name": "groupId",
"type": "String",
- "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "desc": "the checkbox group id // normal just use for checkbox",
"memberOf": ""
},
{
- "name": "validClass",
+ "name": "tooltip",
"type": "String",
- "desc": "The CSS class to use when marking a field valid (defaults to \"x-form-invalid\")",
+ "desc": "label tooltip",
"memberOf": ""
},
- {
- "name": "specialFilter",
- "type": "Boolean",
- "desc": "special filter default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
- },
- {
- "name": "mobileTouchView",
- "type": "Boolean",
- "desc": "show mobile touch view when using a mobile default true",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
- },
- {
- "name": "triggerClass",
- "type": "String",
- "desc": "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
- "memberOf": "Roo.bootstrap.TriggerField"
- },
- {
- "name": "caret",
- "type": "String",
- "desc": "a fontawesome for the trigger icon see http://fortawesome.github.io/Font-Awesome/icons/",
- "memberOf": "Roo.bootstrap.TriggerField",
- "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": "Roo.bootstrap.TriggerField"
- },
- {
- "name": "removable",
- "type": "Boolean",
- "desc": "special filter default false",
- "memberOf": "Roo.bootstrap.TriggerField",
- "optvals": [
- "true",
- "false"
- ]
- },
{
"name": "disabled",
"type": "Boolean",
"desc": "is it disabled",
"memberOf": "Roo.bootstrap.Input"
},
- {
- "name": "fieldLabel",
- "type": "String",
- "desc": "- the label associated",
- "memberOf": "Roo.bootstrap.Input"
- },
{
"name": "inputType",
"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",
{
"name": "labelWidth",
"type": "Number",
- "desc": "set the width of label (0-12)",
+ "desc": "set the width of label",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labellg",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelmd",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelsm",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelxs",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
"memberOf": "Roo.bootstrap.Input"
},
{
"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 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": "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",
{
"name": "regexText",
"type": "String",
- "desc": "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "desc": "-- Depricated - use Invalid Text",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
"memberOf": "Roo.bootstrap.Input"
},
{
"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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
}
],
"events": [
- {
- "name": "add",
- "sig": "function (combo)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the 'add' icon is pressed (add a listener to enable add button)"
- },
{
"name": "beforedestroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires before the component is hidden. Return false to stop the hide."
},
- {
- "name": "beforequery",
- "sig": "function (combo, query, forceAll, cancel, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:"
- },
{
"name": "beforerender",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires before the component is rendered. Return false to stop the render."
},
- {
- "name": "beforeselect",
- "sig": "function (combo, record, index)\n{\n\n}",
- "type": "function",
- "desc": "Fires before a list item is selected. Return false to cancel the selection."
- },
{
"name": "beforeshow",
"sig": "function (_self)\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}",
"desc": "Fires when the children have been rendered.."
},
{
- "name": "collapse",
- "sig": "function (combo)\n{\n\n}",
+ "name": "click",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the dropdown list is collapsed"
+ "desc": "Fires when the element is click."
},
{
"name": "destroy",
"type": "function",
"desc": "Fires after the component is disabled."
},
- {
- "name": "edit",
- "sig": "function (combo, record)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the 'edit' icon is pressed (add a listener to enable add button)"
- },
{
"name": "enable",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is enabled."
},
- {
- "name": "expand",
- "sig": "function (combo)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the dropdown list is expanded"
- },
{
"name": "focus",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the key up"
},
- {
- "name": "remove",
- "sig": "function (combo)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the remove value from the combobox array"
- },
{
"name": "render",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is rendered."
},
- {
- "name": "select",
- "sig": "function (combo, record, index)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a list item is selected"
- },
{
"name": "show",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is shown."
},
- {
- "name": "specialfilter",
- "sig": "function (combo)\n{\n\n}",
- "type": "function",
- "desc": "Fires when specialfilter"
- },
{
"name": "specialkey",
"sig": "function (_self, e)\n{\n\n}",
"type": "function",
"desc": "Clear any invalid styles/messages for this field"
},
- {
- "name": "clearValue",
- "sig": "()",
- "type": "function",
- "desc": "Clears any text/value currently set in the field"
- },
- {
- "name": "collapse",
- "sig": "()",
- "type": "function",
- "desc": "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion."
- },
{
"name": "destroy",
"sig": "()",
"type": "function",
"desc": "Disable this component."
},
- {
- "name": "doQuery",
- "sig": "(String query, Boolean forceAll)",
- "type": "function",
- "desc": "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed."
- },
{
"name": "enable",
"sig": "()",
"type": "function",
"desc": "Enable this component."
},
- {
- "name": "expand",
- "sig": "()",
- "type": "function",
- "desc": "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion."
- },
{
"name": "fireEvent",
"sig": "(String eventName, Object... args)",
"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": "()",
"name": "getValue",
"sig": "()",
"type": "function",
- "desc": "Returns the currently selected field value or empty string if no value is set."
+ "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
+ },
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
},
{
"name": "hasListener",
"type": "function",
"desc": "return the real input element."
},
- {
- "name": "isExpanded",
- "sig": "()",
- "type": "function",
- "desc": "Returns true if the dropdown list is expanded, else false."
- },
{
"name": "isVisible",
"sig": "()",
"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": "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": "Resets the current field value to the originally loaded value and clears any validation messages"
},
- {
- "name": "select",
- "sig": "(Number index, Boolean scrollIntoView)",
- "type": "function",
- "desc": "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue."
- },
- {
- "name": "selectByValue",
- "sig": "(String value, Boolean scrollIntoView)",
- "type": "function",
- "desc": "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue."
- },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
"type": "function",
"desc": "Convenience function for setting disabled/enabled by boolean."
},
- {
- "name": "setEditable",
- "sig": "(Boolean value)",
- "type": "function",
- "desc": "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time."
- },
- {
- "name": "setFromData",
- "sig": "(Object value)",
- "type": "function",
- "desc": "Sets the value of the field based on a object which is related to the record format for the store."
- },
{
"name": "setRawValue",
"sig": "(Mixed value)",
},
{
"name": "setValue",
- "sig": "(String value)",
+ "sig": "(Mixed value)",
"type": "function",
- "desc": "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set)."
+ "desc": "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}."
},
{
"name": "setVisible",
}
]
},
- "Roo.bootstrap.ComboBox2": {
+ "Roo.bootstrap.Column": {
"props": [
{
- "name": "append",
- "type": "Boolean",
- "desc": "default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
- },
- {
- "name": "autoFocus",
- "type": "Boolean",
- "desc": "auto focus the first item, default true",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "name": "xs",
+ "type": "Number",
+ "desc": "colspan out of 12 for mobile-sized screens or 0 for hidden",
+ "memberOf": ""
},
{
- "name": "tickable",
- "type": "Boolean",
- "desc": "ComboBox with tickable selections (true|false), default false",
+ "name": "sm",
+ "type": "Number",
+ "desc": "colspan out of 12 for tablet-sized screens or 0 for hidden",
"memberOf": ""
},
{
- "name": "btnPosition",
- "type": "String",
- "desc": "set the position of the trigger button (left | right) default right",
+ "name": "md",
+ "type": "Number",
+ "desc": "colspan out of 12 for computer-sized screens or 0 for hidden",
"memberOf": ""
},
{
- "name": "lazyRender",
- "type": "Boolean",
- "desc": "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
+ "name": "lg",
+ "type": "Number",
+ "desc": "colspan out of 12 for large computer-sized screens or 0 for hidden",
"memberOf": ""
},
{
- "name": "autoCreate",
- "type": "Boolean/Object",
- "desc": "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
+ "name": "xsoff",
+ "type": "Number",
+ "desc": "colspan offset out of 12 for mobile-sized screens or 0 for hidden",
"memberOf": ""
},
{
- "name": "store",
- "type": "Roo.data.Store",
- "desc": "The data store to which this combo is bound (defaults to undefined)",
+ "name": "smoff",
+ "type": "Number",
+ "desc": "colspan offset out of 12 for tablet-sized screens or 0 for hidden",
"memberOf": ""
},
{
- "name": "title",
- "type": "String",
- "desc": "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
+ "name": "mdoff",
+ "type": "Number",
+ "desc": "colspan offset out of 12 for computer-sized screens or 0 for hidden",
"memberOf": ""
},
{
- "name": "tpl",
- "type": "String/Roo.Template",
- "desc": "The template to use to render the output",
+ "name": "lgoff",
+ "type": "Number",
+ "desc": "colspan offset out of 12 for large computer-sized screens or 0 for hidden",
"memberOf": ""
},
{
- "name": "grow",
+ "name": "hidden",
"type": "Boolean",
- "desc": "",
- "memberOf": ""
+ "desc": "hide the element",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
- "name": "growMin",
- "type": "Number",
- "desc": "",
- "memberOf": ""
+ "name": "alert",
+ "type": "String",
+ "desc": "type alert (changes background / border...)",
+ "memberOf": "",
+ "optvals": [
+ "success",
+ "info",
+ "warning",
+ "danger"
+ ]
},
{
- "name": "growMax",
- "type": "Number",
- "desc": "",
- "memberOf": ""
+ "name": "fa",
+ "type": "String",
+ "desc": "font awesome icon",
+ "memberOf": "",
+ "optvals": [
+ "ban",
+ "check",
+ "..."
+ ]
},
{
- "name": "listWidth",
+ "name": "fasize",
"type": "Number",
- "desc": "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
- "memberOf": ""
- },
- {
- "name": "displayField",
- "type": "String",
- "desc": "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
- "memberOf": ""
+ "desc": "font awsome size",
+ "memberOf": "",
+ "optvals": [
+ "1",
+ "2",
+ "...."
+ ]
},
{
- "name": "valueField",
+ "name": "icon",
"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": ""
+ "desc": "glyphicon name",
+ "memberOf": "",
+ "optvals": [
+ "info-sign",
+ "check",
+ "..."
+ ]
},
{
- "name": "hiddenName",
+ "name": "html",
"type": "String",
- "desc": "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
+ "desc": "content of column.",
"memberOf": ""
},
{
- "name": "listClass",
+ "name": "cls",
"type": "String",
- "desc": "CSS class to apply to the dropdown list element (defaults to '')",
- "memberOf": ""
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "selectedClass",
+ "name": "style",
"type": "String",
- "desc": "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
- "memberOf": ""
+ "desc": "any extra css",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "shadow",
- "type": "Boolean/String",
- "desc": "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
- "memberOf": ""
+ "name": "xattr",
+ "type": "Object",
+ "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "listAlign",
- "type": "String",
- "desc": "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
- "memberOf": ""
+ "name": "can_build_overlaid",
+ "type": "Boolean",
+ "desc": "True if element can be rebuild from a HTML page",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "maxHeight",
- "type": "Number",
- "desc": "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
- "memberOf": ""
+ "name": "dataId",
+ "type": "string",
+ "desc": "cutomer id",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "triggerAction",
- "type": "String",
- "desc": "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
- "memberOf": ""
+ "name": "name",
+ "type": "string",
+ "desc": "Specifies name attribute",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "minChars",
- "type": "Number",
- "desc": "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
- "memberOf": ""
+ "name": "tooltip",
+ "type": "string",
+ "desc": "Text for the tooltip",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "typeAhead",
- "type": "Boolean",
- "desc": "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
- "memberOf": ""
+ "name": "container_method",
+ "type": "string",
+ "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "queryDelay",
- "type": "Number",
- "desc": "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
- "memberOf": ""
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
},
{
- "name": "pageSize",
- "type": "Number",
- "desc": "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
- "memberOf": ""
+ "name": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
},
{
- "name": "selectOnFocus",
+ "name": "allowDomMove",
"type": "Boolean",
- "desc": "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
- "memberOf": ""
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
},
{
- "name": "queryParam",
+ "name": "hideMode",
"type": "String",
- "desc": "Name of the query as it will be passed on the querystring (defaults to 'query')",
- "memberOf": ""
+ "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": "loadingText",
+ "name": "actionMode",
"type": "String",
- "desc": "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
- "memberOf": ""
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
},
{
- "name": "resizable",
- "type": "Boolean",
- "desc": "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
- "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": "handleHeight",
- "type": "Number",
- "desc": "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
- "memberOf": ""
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
},
{
- "name": "editable",
- "type": "Boolean",
- "desc": "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
- "memberOf": ""
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
},
{
- "name": "allQuery",
- "type": "String",
- "desc": "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
- "memberOf": ""
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
},
{
- "name": "mode",
- "type": "String",
- "desc": "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
- "memberOf": ""
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
},
{
- "name": "minListWidth",
- "type": "Number",
- "desc": "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
- "memberOf": ""
+ "name": "childrenrendered",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the children have been rendered.."
},
{
- "name": "forceSelection",
- "type": "Boolean",
- "desc": "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
- "memberOf": ""
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
},
{
- "name": "typeAheadDelay",
- "type": "Number",
- "desc": "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
- "memberOf": ""
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
},
{
- "name": "valueNotFoundText",
- "type": "String",
- "desc": "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
- "memberOf": ""
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
},
{
- "name": "blockFocus",
- "type": "Boolean",
- "desc": "Prevents all focus calls, so it can work with things like HTML edtor bar",
- "memberOf": ""
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
},
{
- "name": "disableClear",
- "type": "Boolean",
- "desc": "Disable showing of clear button.",
- "memberOf": ""
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
},
{
- "name": "alwaysQuery",
- "type": "Boolean",
- "desc": "Disable caching of results, and always send query",
- "memberOf": ""
+ "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": "multiple",
- "type": "Boolean",
- "desc": "ComboBobArray, default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this component"
},
{
- "name": "triggerClass",
- "type": "String",
- "desc": "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
- "memberOf": "Roo.bootstrap.TriggerField"
+ "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": "caret",
- "type": "String",
- "desc": "a fontawesome for the trigger icon see http://fortawesome.github.io/Font-Awesome/icons/",
- "memberOf": "Roo.bootstrap.TriggerField",
- "optvals": [
- "search",
- "calendar"
- ]
+ "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": "hideTrigger",
- "type": "Boolean",
- "desc": "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf": "Roo.bootstrap.TriggerField"
+ "name": "disable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Disable this component."
},
{
- "name": "removable",
- "type": "Boolean",
- "desc": "special filter default false",
- "memberOf": "Roo.bootstrap.TriggerField",
- "optvals": [
- "true",
- "false"
- ]
+ "name": "enable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Enable this component."
},
{
- "name": "disabled",
- "type": "Boolean",
- "desc": "is it disabled",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "fieldLabel",
- "type": "String",
- "desc": "- the label associated",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "focus",
+ "sig": "(Boolean selectText)",
+ "type": "function",
+ "desc": "Try to focus this component."
},
{
- "name": "inputType",
- "type": "String",
- "desc": "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "getChildContainer",
+ "sig": "()",
+ "type": "function",
+ "desc": "Fetch the element to add children to"
},
{
- "name": "name",
- "type": "String",
- "desc": "name of the input",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "getEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the underlying {@link Roo.Element}."
},
{
- "name": "placeholder",
- "type": "string",
- "desc": "- placeholder to put in text.",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "getId",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the id of this component."
},
{
- "name": "before",
- "type": "string",
- "desc": "- input group add on before",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
},
{
- "name": "after",
- "type": "string",
- "desc": "- input group add on after",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "size",
- "type": "string",
- "desc": "- (lg|sm) or leave empty..",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "hide",
+ "sig": "()",
+ "type": "function",
+ "desc": "Hide a component - adds 'hidden' class"
},
{
- "name": "xs",
- "type": "Number",
- "desc": "colspan out of 12 for mobile-sized screens",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "initEvents",
+ "sig": "()",
+ "type": "function",
+ "desc": "Initialize Events for the element"
},
{
- "name": "sm",
- "type": "Number",
- "desc": "colspan out of 12 for tablet-sized screens",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "isVisible",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if this component is visible."
},
{
- "name": "md",
- "type": "Number",
- "desc": "colspan out of 12 for computer-sized screens",
- "memberOf": "Roo.bootstrap.Input"
+ "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": "lg",
- "type": "Number",
- "desc": "colspan out of 12 for large computer-sized screens",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "purgeListeners",
+ "sig": "()",
+ "type": "function",
+ "desc": "Removes all listeners for this object"
},
{
- "name": "value",
- "type": "string",
- "desc": "default value of the input",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
},
{
- "name": "labelWidth",
- "type": "Number",
- "desc": "set the width of label (0-12)",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
},
{
- "name": "labelAlign",
- "type": "String",
- "desc": "",
- "memberOf": "Roo.bootstrap.Input",
- "optvals": [
- "top",
- "left"
- ]
+ "name": "render",
+ "sig": "(String/HTMLElement/Element container)",
+ "type": "function",
+ "desc": "If this is a lazy rendering component, render it to its container element."
},
{
- "name": "readOnly",
- "type": "Boolean",
- "desc": "Specifies that the field should be read-only",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
+ "type": "function",
+ "desc": "Convenience function for setting disabled/enabled by boolean."
},
{
- "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": "setVisible",
+ "sig": "(Boolean visible)",
+ "type": "function",
+ "desc": "Convenience function to hide or show this component by boolean."
},
{
- "name": "align",
- "type": "String",
- "desc": "Default left",
- "memberOf": "Roo.bootstrap.Input",
- "optvals": [
- "left",
- "center",
- "right"
- ]
+ "name": "show",
+ "sig": "()",
+ "type": "function",
+ "desc": "Show a component - removes 'hidden' class"
},
{
- "name": "forceFeedback",
+ "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.ComboBox": {
+ "props": [
+ {
+ "name": "append",
"type": "Boolean",
- "desc": "Default false",
- "memberOf": "Roo.bootstrap.Input",
+ "desc": "default false",
+ "memberOf": "",
"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": "autoFocus",
+ "type": "Boolean",
+ "desc": "auto focus the first item, default true",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
- "name": "validateOnBlur",
+ "name": "tickable",
"type": "Boolean",
- "desc": "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "ComboBox with tickable selections (true|false), default false",
+ "memberOf": ""
},
{
- "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": "triggerList",
+ "type": "Boolean",
+ "desc": "trigger show the list or not (true|false) default true",
+ "memberOf": ""
},
{
- "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": "showToggleBtn",
+ "type": "Boolean",
+ "desc": "show toggle button or not (true|false) default true",
+ "memberOf": ""
},
{
- "name": "invalidClass",
+ "name": "btnPosition",
"type": "String",
- "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "set the position of the trigger button (left | right) default right",
+ "memberOf": ""
},
{
- "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": "animate",
+ "type": "Boolean",
+ "desc": "default true",
+ "memberOf": ""
},
{
- "name": "hasFeedback",
+ "name": "emptyResultText",
"type": "Boolean",
- "desc": "default true",
- "memberOf": "Roo.bootstrap.Input",
- "optvals": [
- "true",
- "false"
- ]
+ "desc": "only for touch device",
+ "memberOf": ""
},
{
- "name": "invalidFeedbackIcon",
+ "name": "triggerText",
"type": "String",
- "desc": "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "multiple combobox trigger button text default 'Select'",
+ "memberOf": ""
},
{
- "name": "validFeedbackIcon",
+ "name": "emptyTitle",
"type": "String",
- "desc": "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "default ''",
+ "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": "lazyRender",
+ "type": "Boolean",
+ "desc": "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
+ "memberOf": ""
},
{
- "name": "vtype",
+ "name": "autoCreate",
+ "type": "Boolean/Object",
+ "desc": "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
+ "memberOf": ""
+ },
+ {
+ "name": "store",
+ "type": "Roo.data.Store",
+ "desc": "The data store to which this combo is bound (defaults to undefined)",
+ "memberOf": ""
+ },
+ {
+ "name": "title",
"type": "String",
- "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
+ "memberOf": ""
},
{
- "name": "disableKeyFilter",
- "type": "Boolean",
- "desc": "True to disable input keystroke filtering (defaults to false)",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "tpl",
+ "type": "String/Roo.Template",
+ "desc": "The template to use to render the output",
+ "memberOf": ""
},
{
- "name": "allowBlank",
+ "name": "grow",
"type": "Boolean",
- "desc": "False to validate that the value length > 0 (defaults to true)",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "",
+ "memberOf": ""
},
{
- "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": "growMin",
+ "type": "Number",
+ "desc": "",
+ "memberOf": ""
},
{
- "name": "minLength",
+ "name": "growMax",
"type": "Number",
- "desc": "Minimum input field length required (defaults to 0)",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "",
+ "memberOf": ""
},
{
- "name": "maxLength",
+ "name": "listWidth",
"type": "Number",
- "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
+ "memberOf": ""
},
{
- "name": "minLengthText",
+ "name": "displayField",
"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": "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
+ "memberOf": ""
},
{
- "name": "maxLengthText",
+ "name": "valueField",
"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"
+ "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": "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": "modalTitle",
+ "type": "String",
+ "desc": "The title of the dialog that pops up on mobile views.",
+ "memberOf": ""
},
{
- "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": "hiddenName",
+ "type": "String",
+ "desc": "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
+ "memberOf": ""
},
{
- "name": "regexText",
+ "name": "listClass",
"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": "CSS class to apply to the dropdown list element (defaults to '')",
+ "memberOf": ""
},
{
- "name": "cls",
+ "name": "selectedClass",
"type": "String",
- "desc": "css class",
- "memberOf": "Roo.bootstrap.Component"
+ "desc": "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
+ "memberOf": ""
},
{
- "name": "style",
+ "name": "shadow",
+ "type": "Boolean/String",
+ "desc": "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
+ "memberOf": ""
+ },
+ {
+ "name": "listAlign",
"type": "String",
- "desc": "any extra css",
- "memberOf": "Roo.bootstrap.Component"
+ "desc": "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
+ "memberOf": ""
},
{
- "name": "xattr",
- "type": "Object",
- "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "maxHeight",
+ "type": "Number",
+ "desc": "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
+ "memberOf": ""
},
{
- "name": "can_build_overlaid",
- "type": "Boolean",
- "desc": "True if element can be rebuild from a HTML page",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "triggerAction",
+ "type": "String",
+ "desc": "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
+ "memberOf": ""
},
{
- "name": "dataId",
- "type": "string",
- "desc": "cutomer id",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "minChars",
+ "type": "Number",
+ "desc": "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
+ "memberOf": ""
},
{
- "name": "tooltip",
- "type": "string",
- "desc": "Text for the tooltip",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "typeAhead",
+ "type": "Boolean",
+ "desc": "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
+ "memberOf": ""
},
{
- "name": "container_method",
- "type": "string",
- "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "queryDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
+ "memberOf": ""
},
{
- "name": "disableClass",
- "type": "String",
- "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf": "Roo.Component"
+ "name": "pageSize",
+ "type": "Number",
+ "desc": "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
+ "memberOf": ""
},
{
- "name": "allowDomMove",
+ "name": "selectOnFocus",
"type": "Boolean",
- "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf": "Roo.Component"
+ "desc": "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
+ "memberOf": ""
},
{
- "name": "hideMode",
+ "name": "queryParam",
"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"
- ]
+ "desc": "Name of the query as it will be passed on the querystring (defaults to 'query')",
+ "memberOf": ""
},
{
- "name": "actionMode",
+ "name": "loadingText",
"type": "String",
- "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
- "memberOf": "Roo.Component"
+ "desc": "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
+ "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": "add",
- "sig": "function (combo)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the 'add' icon is pressed (add a listener to enable add button)"
+ "name": "resizable",
+ "type": "Boolean",
+ "desc": "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
+ "memberOf": ""
},
{
- "name": "beforedestroy",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ "name": "handleHeight",
+ "type": "Number",
+ "desc": "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
+ "memberOf": ""
},
{
- "name": "beforehide",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires before the component is hidden. Return false to stop the hide."
+ "name": "editable",
+ "type": "Boolean",
+ "desc": "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
+ "memberOf": ""
},
{
- "name": "beforequery",
- "sig": "function (combo, query, forceAll, cancel, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:"
+ "name": "allQuery",
+ "type": "String",
+ "desc": "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
+ "memberOf": ""
},
{
- "name": "beforerender",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires before the component is rendered. Return false to stop the render."
+ "name": "mode",
+ "type": "String",
+ "desc": "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
+ "memberOf": ""
},
{
- "name": "beforeselect",
- "sig": "function (combo, record, index)\n{\n\n}",
- "type": "function",
- "desc": "Fires before a list item is selected. Return false to cancel the selection."
+ "name": "minListWidth",
+ "type": "Number",
+ "desc": "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
+ "memberOf": ""
},
{
- "name": "beforeshow",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires before the component is shown. Return false to stop the show."
+ "name": "forceSelection",
+ "type": "Boolean",
+ "desc": "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
+ "memberOf": ""
},
{
- "name": "blur",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when this field loses input focus."
+ "name": "typeAheadDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
+ "memberOf": ""
},
{
- "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": "valueNotFoundText",
+ "type": "String",
+ "desc": "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
+ "memberOf": ""
},
{
- "name": "childrenrendered",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the children have been rendered.."
+ "name": "blockFocus",
+ "type": "Boolean",
+ "desc": "Prevents all focus calls, so it can work with things like HTML edtor bar",
+ "memberOf": ""
},
{
- "name": "collapse",
- "sig": "function (combo)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the dropdown list is collapsed"
+ "name": "disableClear",
+ "type": "Boolean",
+ "desc": "Disable showing of clear button.",
+ "memberOf": ""
},
{
- "name": "destroy",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is destroyed."
+ "name": "alwaysQuery",
+ "type": "Boolean",
+ "desc": "Disable caching of results, and always send query",
+ "memberOf": ""
},
{
- "name": "disable",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is disabled."
+ "name": "multiple",
+ "type": "Boolean",
+ "desc": "ComboBobArray, default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
- "name": "edit",
- "sig": "function (combo, record)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the 'edit' icon is pressed (add a listener to enable add button)"
+ "name": "invalidClass",
+ "type": "String",
+ "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf": ""
},
{
- "name": "enable",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is enabled."
+ "name": "validClass",
+ "type": "String",
+ "desc": "The CSS class to use when marking a field valid (defaults to \"x-form-invalid\")",
+ "memberOf": ""
},
{
- "name": "expand",
- "sig": "function (combo)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the dropdown list is expanded"
+ "name": "specialFilter",
+ "type": "Boolean",
+ "desc": "special filter default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
- "name": "focus",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when this field receives input focus."
+ "name": "mobileTouchView",
+ "type": "Boolean",
+ "desc": "show mobile touch view when using a mobile default true",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
- "name": "hide",
+ "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": "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
+ "memberOf": "Roo.bootstrap.TriggerField"
+ },
+ {
+ "name": "caret",
+ "type": "String",
+ "desc": "a fontawesome for the trigger icon see http://fortawesome.github.io/Font-Awesome/icons/",
+ "memberOf": "Roo.bootstrap.TriggerField",
+ "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": "Roo.bootstrap.TriggerField"
+ },
+ {
+ "name": "removable",
+ "type": "Boolean",
+ "desc": "special filter default false",
+ "memberOf": "Roo.bootstrap.TriggerField",
+ "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": "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",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labellg",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelmd",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelsm",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelxs",
+ "type": "Number",
+ "desc": "set the width of label (1-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": "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": "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": "-- Depricated - use Invalid Text",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "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": "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "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": "add",
+ "sig": "function (combo)\n{\n\n}",
+ "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}",
+ "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": "beforequery",
+ "sig": "function (combo, query, forceAll, cancel, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:"
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeselect",
+ "sig": "function (combo, record, index)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a list item is selected. Return false to cancel the selection."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "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}",
+ "type": "function",
+ "desc": "Fires when the children have been rendered.."
+ },
+ {
+ "name": "collapse",
+ "sig": "function (combo)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the dropdown list is collapsed"
+ },
+ {
+ "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": "edit",
+ "sig": "function (combo, record)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the 'edit' icon is pressed (add a listener to enable add button)"
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "expand",
+ "sig": "function (combo)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the dropdown list is expanded"
+ },
+ {
+ "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": "remove",
+ "sig": "function (combo)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the remove value from the combobox array"
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "select",
+ "sig": "function (combo, record, index)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a list item is selected"
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ },
+ {
+ "name": "specialfilter",
+ "sig": "function (combo)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when specialfilter"
+ },
+ {
+ "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": "tick",
+ "sig": "function (combo)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when tick the element"
+ },
+ {
+ "name": "touchviewdisplay",
+ "sig": "function (combo, cfg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when touch view require special display (default is using displayField)"
+ },
+ {
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been validated with no errors."
+ }
+ ],
+ "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": "clearInvalid",
+ "sig": "()",
+ "type": "function",
+ "desc": "Clear any invalid styles/messages for this field"
+ },
+ {
+ "name": "clearValue",
+ "sig": "()",
+ "type": "function",
+ "desc": "Clears any text/value currently set in the field"
+ },
+ {
+ "name": "collapse",
+ "sig": "()",
+ "type": "function",
+ "desc": "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion."
+ },
+ {
+ "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": "doQuery",
+ "sig": "(String query, Boolean forceAll)",
+ "type": "function",
+ "desc": "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed."
+ },
+ {
+ "name": "enable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Enable this component."
+ },
+ {
+ "name": "expand",
+ "sig": "()",
+ "type": "function",
+ "desc": "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion."
+ },
+ {
+ "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": "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 currently selected field value or empty string if no value is set."
+ },
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
+ {
+ "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": "inputEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "return the real input element."
+ },
+ {
+ "name": "isExpanded",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if the dropdown list is expanded, else false."
+ },
+ {
+ "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": "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": "reset",
+ "sig": "()",
+ "type": "function",
+ "desc": "Resets the current field value to the originally loaded value and clears any validation messages"
+ },
+ {
+ "name": "select",
+ "sig": "(Number index, Boolean scrollIntoView)",
+ "type": "function",
+ "desc": "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue."
+ },
+ {
+ "name": "selectByValue",
+ "sig": "(String value, Boolean scrollIntoView)",
+ "type": "function",
+ "desc": "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue."
+ },
+ {
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
+ "type": "function",
+ "desc": "Convenience function for setting disabled/enabled by boolean."
+ },
+ {
+ "name": "setEditable",
+ "sig": "(Boolean value)",
+ "type": "function",
+ "desc": "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time."
+ },
+ {
+ "name": "setFromData",
+ "sig": "(Object value)",
+ "type": "function",
+ "desc": "Sets the value of the field based on a object which is related to the record format for the store."
+ },
+ {
+ "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": "(String value)",
+ "type": "function",
+ "desc": "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set)."
+ },
+ {
+ "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)"
+ },
+ {
+ "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.Component": {
+ "props": [
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "css class",
+ "memberOf": ""
+ },
+ {
+ "name": "style",
+ "type": "String",
+ "desc": "any extra css",
+ "memberOf": ""
+ },
+ {
+ "name": "xattr",
+ "type": "Object",
+ "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf": ""
+ },
+ {
+ "name": "can_build_overlaid",
+ "type": "Boolean",
+ "desc": "True if element can be rebuild from a HTML page",
+ "memberOf": ""
+ },
+ {
+ "name": "dataId",
+ "type": "string",
+ "desc": "cutomer id",
+ "memberOf": ""
+ },
+ {
+ "name": "name",
+ "type": "string",
+ "desc": "Specifies name attribute",
+ "memberOf": ""
+ },
+ {
+ "name": "tooltip",
+ "type": "string",
+ "desc": "Text for the tooltip",
+ "memberOf": ""
+ },
+ {
+ "name": "container_method",
+ "type": "string",
+ "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf": ""
+ },
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
+ {
+ "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.Container": {
+ "props": [
+ {
+ "name": "jumbotron",
+ "type": "Boolean",
+ "desc": "is it a jumbotron element",
+ "memberOf": ""
+ },
+ {
+ "name": "html",
+ "type": "String",
+ "desc": "content of element",
+ "memberOf": ""
+ },
+ {
+ "name": "well",
+ "type": "String",
+ "desc": "a well, large, small or medium.",
+ "memberOf": "",
+ "optvals": [
+ "lg",
+ "sm",
+ "md"
+ ]
+ },
+ {
+ "name": "panel",
+ "type": "String",
+ "desc": "render as panel - type - primary/success.....",
+ "memberOf": "",
+ "optvals": [
+ "default",
+ "primary",
+ "success",
+ "info",
+ "warning",
+ "danger"
+ ]
+ },
+ {
+ "name": "header",
+ "type": "String",
+ "desc": "content of header (for panel)",
+ "memberOf": ""
+ },
+ {
+ "name": "footer",
+ "type": "String",
+ "desc": "content of footer (for panel)",
+ "memberOf": ""
+ },
+ {
+ "name": "sticky",
+ "type": "String",
+ "desc": "block to use as footer or body- needs css-bootstrap/sticky-footer.css",
+ "memberOf": "",
+ "optvals": [
+ "footer",
+ "wrap",
+ "push"
+ ]
+ },
+ {
+ "name": "tag",
+ "type": "String",
+ "desc": "type of HTML tag.",
+ "memberOf": "",
+ "optvals": [
+ "header",
+ "aside",
+ "section"
+ ]
+ },
+ {
+ "name": "alert",
+ "type": "String",
+ "desc": "type alert (changes background / border...)",
+ "memberOf": "",
+ "optvals": [
+ "success",
+ "info",
+ "warning",
+ "danger"
+ ]
+ },
+ {
+ "name": "fa",
+ "type": "String",
+ "desc": "font awesome icon",
+ "memberOf": ""
+ },
+ {
+ "name": "icon",
+ "type": "String",
+ "desc": "glyphicon name",
+ "memberOf": "",
+ "optvals": [
+ "info-sign",
+ "check",
+ "..."
+ ]
+ },
+ {
+ "name": "hidden",
+ "type": "Boolean",
+ "desc": "hide the element",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "expandable",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "expanded",
+ "type": "Boolean",
+ "desc": "default true",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "rheader",
+ "type": "String",
+ "desc": "contet on the right of header",
+ "memberOf": ""
+ },
+ {
+ "name": "clickable",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "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 (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "When a element is chick"
+ },
+ {
+ "name": "collapse",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "After the panel has been collapsed"
+ },
+ {
+ "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": "expand",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "After the panel has been expand"
+ },
+ {
+ "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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
+ {
+ "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.DateField": {
+ "props": [
+ {
+ "name": "weekStart",
+ "type": "Number",
+ "desc": "default 0",
+ "memberOf": ""
+ },
+ {
+ "name": "viewMode",
+ "type": "String",
+ "desc": "default empty, (months|years)",
+ "memberOf": ""
+ },
+ {
+ "name": "minViewMode",
+ "type": "String",
+ "desc": "default empty, (months|years)",
+ "memberOf": ""
+ },
+ {
+ "name": "startDate",
+ "type": "Number",
+ "desc": "default -Infinity",
+ "memberOf": ""
+ },
+ {
+ "name": "endDate",
+ "type": "Number",
+ "desc": "default Infinity",
+ "memberOf": ""
+ },
+ {
+ "name": "todayHighlight",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": ""
+ },
+ {
+ "name": "todayBtn",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": ""
+ },
+ {
+ "name": "calendarWeeks",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": ""
+ },
+ {
+ "name": "daysOfWeekDisabled",
+ "type": "Object",
+ "desc": "default empty",
+ "memberOf": ""
+ },
+ {
+ "name": "singleMode",
+ "type": "Boolean",
+ "desc": "default false (true | false)",
+ "memberOf": ""
+ },
+ {
+ "name": "keyboardNavigation",
+ "type": "Boolean",
+ "desc": "default true",
+ "memberOf": ""
+ },
+ {
+ "name": "language",
+ "type": "String",
+ "desc": "default en",
+ "memberOf": ""
+ },
+ {
+ "name": "format",
+ "type": "String",
+ "desc": "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').",
+ "memberOf": ""
+ },
+ {
+ "name": "altFormats",
+ "type": "String",
+ "desc": "Multiple date formats separated by \"|\" to try when parsing a user input value and it doesn't match the defined\nformat (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d').",
+ "memberOf": ""
+ },
+ {
+ "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",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labellg",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelmd",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelsm",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelxs",
+ "type": "Number",
+ "desc": "set the width of label (1-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": "-- Depricated - use Invalid Text",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "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": "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "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": "beforeselect",
+ "sig": "function (_self, date)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when before select a date."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "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}",
+ "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": "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}",
+ "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, date)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field show."
+ },
+ {
+ "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": [
+ {
+ "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": "clearInvalid",
+ "sig": "()",
+ "type": "function",
+ "desc": "Clear any invalid styles/messages for this field"
+ },
+ {
+ "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": "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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
+ {
+ "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": "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": "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": "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)",
+ "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)"
+ },
+ {
+ "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.DateSplitField": {
+ "props": [
+ {
+ "name": "fieldLabel",
+ "type": "string",
+ "desc": "- the label associated",
+ "memberOf": ""
+ },
+ {
+ "name": "labelWidth",
+ "type": "Number",
+ "desc": "set the width of label (0-12)",
+ "memberOf": ""
+ },
+ {
+ "name": "labelAlign",
+ "type": "String",
+ "desc": "",
+ "memberOf": "",
+ "optvals": [
+ "top",
+ "left"
+ ]
+ },
+ {
+ "name": "dayAllowBlank",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "monthAllowBlank",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "yearAllowBlank",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "dayPlaceholder",
+ "type": "string",
+ "desc": "",
+ "memberOf": ""
+ },
+ {
+ "name": "monthPlaceholder",
+ "type": "string",
+ "desc": "",
+ "memberOf": ""
+ },
+ {
+ "name": "yearPlaceholder",
+ "type": "string",
+ "desc": "",
+ "memberOf": ""
+ },
+ {
+ "name": "dayFormat",
+ "type": "string",
+ "desc": "default 'd'",
+ "memberOf": ""
+ },
+ {
+ "name": "monthFormat",
+ "type": "string",
+ "desc": "default 'm'",
+ "memberOf": ""
+ },
+ {
+ "name": "yearFormat",
+ "type": "string",
+ "desc": "default 'Y'",
+ "memberOf": ""
+ },
+ {
+ "name": "labellg",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": ""
+ },
+ {
+ "name": "labelmd",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": ""
+ },
+ {
+ "name": "labelsm",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": ""
+ },
+ {
+ "name": "labelxs",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "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": "days",
+ "sig": "function (_self, days)\n{\n\n}",
+ "type": "function",
+ "desc": "getting the data of days"
+ },
+ {
+ "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": "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}",
+ "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."
+ },
+ {
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been validated with no errors."
+ },
+ {
+ "name": "years",
+ "sig": "function (_self, years)\n{\n\n}",
+ "type": "function",
+ "desc": "getting the data of years"
+ }
+ ],
+ "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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
+ {
+ "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": "markInvalid",
+ "sig": "(String msg)",
+ "type": "function",
+ "desc": "Mark this field as invalid"
+ },
+ {
+ "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.DocumentManager": {
+ "props": [
+ {
+ "name": "paramName",
+ "type": "String",
+ "desc": "default 'imageUpload'",
+ "memberOf": ""
+ },
+ {
+ "name": "toolTipName",
+ "type": "String",
+ "desc": "default 'filename'",
+ "memberOf": ""
+ },
+ {
+ "name": "method",
+ "type": "String",
+ "desc": "default POST",
+ "memberOf": ""
+ },
+ {
+ "name": "url",
+ "type": "String",
+ "desc": "action url",
+ "memberOf": ""
+ },
+ {
+ "name": "boxes",
+ "type": "Number",
+ "desc": "number of boxes, 0 is no limit.. default 0",
+ "memberOf": ""
+ },
+ {
+ "name": "multiple",
+ "type": "Boolean",
+ "desc": "multiple upload default true",
+ "memberOf": ""
+ },
+ {
+ "name": "thumbSize",
+ "type": "Number",
+ "desc": "default 300",
+ "memberOf": ""
+ },
+ {
+ "name": "fieldLabel",
+ "type": "String",
+ "desc": "",
+ "memberOf": ""
+ },
+ {
+ "name": "labelWidth",
+ "type": "Number",
+ "desc": "default 4",
+ "memberOf": ""
+ },
+ {
+ "name": "labelAlign",
+ "type": "String",
+ "desc": "default left",
+ "memberOf": "",
+ "optvals": [
+ "left",
+ "top"
+ ]
+ },
+ {
+ "name": "editable",
+ "type": "Boolean",
+ "desc": "allow edit when upload a image default true",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "labellg",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": ""
+ },
+ {
+ "name": "labelmd",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": ""
+ },
+ {
+ "name": "labelsm",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": ""
+ },
+ {
+ "name": "labelxs",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "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": "afterupload",
+ "sig": "function (_self, xhr)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire when xhr load exception"
+ },
+ {
+ "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": "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": "click",
+ "sig": "function (_self, file)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire after click the image"
+ },
+ {
+ "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": "edit",
+ "sig": "function (_self, file)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire when upload a image and editable set to true"
+ },
+ {
+ "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 xhr load exception"
+ },
+ {
+ "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 when initial the DocumentManager"
+ },
+ {
+ "name": "inspect",
+ "sig": "function (_self, file)\n{\n\n}",
+ "type": "function",
+ "desc": "inspect selected file"
+ },
+ {
+ "name": "prepare",
+ "sig": "function (_self, formData)\n{\n\n}",
+ "type": "function",
+ "desc": "prepare the form data"
+ },
+ {
+ "name": "previewrendered",
+ "sig": "function (_self, file)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire when preview rendered"
+ },
+ {
+ "name": "process",
+ "sig": "function (_self, file)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire before process file"
+ },
+ {
+ "name": "refresh",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire after refresh the file"
+ },
+ {
+ "name": "remove",
+ "sig": "function (_self, file)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire when remove the file"
+ },
+ {
+ "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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
+ {
+ "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.DocumentSlider": {
+ "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "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 (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire after click"
+ },
+ {
+ "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": "initial",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire after initEvent"
+ },
+ {
+ "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."
+ },
+ {
+ "name": "update",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire after update"
+ }
+ ],
+ "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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
+ {
+ "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.DocumentViewer": {
+ "props": [
+ {
+ "name": "showDownload",
+ "type": "Boolean",
+ "desc": "show download button (default true)",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "showTrash",
+ "type": "Boolean",
+ "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",
+ "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "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 (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire after click"
+ },
+ {
+ "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 after download button"
+ },
+ {
+ "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": "initial",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire after initEvent"
+ },
+ {
+ "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."
+ },
+ {
+ "name": "trash",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire after trash button"
+ }
+ ],
+ "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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
+ {
+ "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.Element": {
+ "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",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "clickable",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "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 (_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 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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
+ {
+ "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.FieldLabel": {
+ "props": [
+ {
+ "name": "html",
+ "type": "String",
+ "desc": "contents of the element",
+ "memberOf": ""
+ },
+ {
+ "name": "tag",
+ "type": "String",
+ "desc": "tag of the element default label",
+ "memberOf": ""
+ },
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "class of the element",
+ "memberOf": ""
+ },
+ {
+ "name": "target",
+ "type": "String",
+ "desc": "label target",
+ "memberOf": ""
+ },
+ {
+ "name": "allowBlank",
+ "type": "Boolean",
+ "desc": "target allowBlank default true",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "invalidClass",
+ "type": "String",
+ "desc": "default \"text-warning\"",
+ "memberOf": ""
+ },
+ {
+ "name": "validClass",
+ "type": "String",
+ "desc": "default \"text-success\"",
+ "memberOf": ""
+ },
+ {
+ "name": "iconTooltip",
+ "type": "String",
+ "desc": "default \"This field is required\"",
+ "memberOf": ""
+ },
+ {
+ "name": "indicatorpos",
+ "type": "String",
+ "desc": "default left",
+ "memberOf": "",
+ "optvals": [
+ "left",
+ "right"
+ ]
+ },
+ {
+ "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "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": "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}",
+ "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."
+ },
+ {
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been validated with no errors."
+ }
+ ],
+ "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": "get",
+ "sig": "(string target)",
+ "type": "function",
+ "desc": "fetch a FieldLabel Group based on the target"
+ },
+ {
+ "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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
+ {
+ "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": "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": "purgeListeners",
+ "sig": "()",
+ "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": "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.Form": {
+ "props": [
+ {
+ "name": "method",
+ "type": "String",
+ "desc": "GET | POST (default POST)",
+ "memberOf": ""
+ },
+ {
+ "name": "labelAlign",
+ "type": "String",
+ "desc": "top | left (default top)",
+ "memberOf": ""
+ },
+ {
+ "name": "align",
+ "type": "String",
+ "desc": "left | right - for navbars",
+ "memberOf": ""
+ },
+ {
+ "name": "loadMask",
+ "type": "Boolean",
+ "desc": "load mask when submit (default true)",
+ "memberOf": ""
+ },
+ {
+ "name": "url",
+ "type": "String",
+ "desc": "The URL to use for form actions if one isn't supplied in the action options.",
+ "memberOf": ""
+ },
+ {
+ "name": "fileUpload",
+ "type": "Boolean",
+ "desc": "Set to true if this form is a file upload.",
+ "memberOf": ""
+ },
+ {
+ "name": "baseParams",
+ "type": "Object",
+ "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": ""
+ },
+ {
+ "name": "errorMask",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "maskOffset",
+ "type": "Number",
+ "desc": "Default 100",
+ "memberOf": ""
+ },
+ {
+ "name": "maskBody",
+ "type": "Boolean",
+ "desc": "",
+ "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "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": "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 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": "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 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": "clearInvalid",
+ "sig": "()",
+ "type": "function",
+ "desc": "Clears all invalid messages in this form."
+ },
+ {
+ "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": "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": "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": "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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
+ {
+ "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": "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": "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": "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)",
+ "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.Graph": {
+ "props": [
+ {
+ "name": "graphtype",
+ "type": "String",
+ "desc": "bar | vbar | pie",
+ "memberOf": ""
+ },
+ {
+ "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
+ {
+ "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",
+ "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
+ {
+ "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.HtmlEditor": {
+ "props": [
+ {
+ "name": "toolbars",
+ "type": "Array",
+ "desc": "Array of toolbars. - defaults to just the Standard one",
+ "memberOf": ""
+ },
+ {
+ "name": "buttons",
+ "type": "Array",
+ "desc": "Array of toolbar's buttons. - defaults to empty",
+ "memberOf": ""
+ },
+ {
+ "name": "resizable",
+ "type": "String",
+ "desc": "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.",
+ "memberOf": ""
+ },
+ {
+ "name": "height",
+ "type": "Number",
+ "desc": "(in pixels)",
+ "memberOf": ""
+ },
+ {
+ "name": "width",
+ "type": "Number",
+ "desc": "(in pixels)",
+ "memberOf": ""
+ },
+ {
+ "name": "stylesheets",
+ "type": "Array",
+ "desc": "url of stylesheets. set to [] to disable stylesheets.",
+ "memberOf": ""
+ },
+ {
+ "name": "cols",
+ "type": "Number",
+ "desc": "Specifies the visible width of a text area",
+ "memberOf": "Roo.bootstrap.TextArea"
+ },
+ {
+ "name": "rows",
+ "type": "Number",
+ "desc": "Specifies the visible number of lines in a text area",
+ "memberOf": "Roo.bootstrap.TextArea"
+ },
+ {
+ "name": "wrap",
+ "type": "string",
+ "desc": "Specifies how the text in a text area is to be wrapped when submitted in a form",
+ "memberOf": "Roo.bootstrap.TextArea",
+ "optvals": [
+ "soft",
+ "hard"
+ ]
+ },
+ {
+ "name": "resize",
+ "type": "string",
+ "desc": "",
+ "memberOf": "Roo.bootstrap.TextArea",
+ "optvals": [
+ "none",
+ "both",
+ "horizontal",
+ "vertical",
+ "inherit",
+ "initial"
+ ]
+ },
+ {
+ "name": "html",
+ "type": "string",
+ "desc": "text",
+ "memberOf": "Roo.bootstrap.TextArea"
+ },
+ {
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "is it disabled",
+ "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",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labellg",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelmd",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelsm",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelxs",
+ "type": "Number",
+ "desc": "set the width of label (1-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": "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": "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": "-- Depricated - use Invalid Text",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "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": "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "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": "activate",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event."
+ },
+ {
+ "name": "autosave",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Auto save the htmlEditor value as a file into 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": "beforepush",
+ "sig": "function (_self, html)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push."
+ },
+ {
+ "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": "beforesync",
+ "sig": "function (_self, html)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync."
+ },
+ {
+ "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": "editmodechange",
+ "sig": "function (_self, sourceEdit)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the editor switches edit modes"
+ },
+ {
+ "name": "editorevent",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "firstfocus",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when on first focus - needed by toolbars.."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "initialize",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the editor is fully initialized (including the iframe)"
+ },
+ {
+ "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": "push",
+ "sig": "function (_self, html)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the iframe editor is updated with content from the textarea."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "savedpreview",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "preview the saved version of htmlEditor"
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ },
+ {
+ "name": "sync",
+ "sig": "function (_self, html)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the textarea is updated with content from the editor iframe."
+ },
+ {
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been validated with no errors."
+ }
+ ],
+ "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": "clearInvalid",
+ "sig": "()",
+ "type": "function",
+ "desc": "Clear any invalid styles/messages for this field"
+ },
+ {
+ "name": "createToolbar",
+ "sig": "(HtmlEditor editor)",
+ "type": "function",
+ "desc": "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons."
+ },
+ {
+ "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": "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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
+ {
+ "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": "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": "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": "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)",
+ "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": "toggleSourceEdit",
+ "sig": "(Boolean sourceEdit)",
+ "type": "function",
+ "desc": "Toggles the editor between standard and source edit mode."
+ },
+ {
+ "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)"
+ },
+ {
+ "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.Img": {
+ "props": [
+ {
+ "name": "imgResponsive",
+ "type": "Boolean",
+ "desc": "false | true",
+ "memberOf": ""
+ },
+ {
+ "name": "border",
+ "type": "String",
+ "desc": "rounded | circle | thumbnail",
+ "memberOf": ""
+ },
+ {
+ "name": "src",
+ "type": "String",
+ "desc": "image source",
+ "memberOf": ""
+ },
+ {
+ "name": "alt",
+ "type": "String",
+ "desc": "image alternative text",
+ "memberOf": ""
+ },
+ {
+ "name": "href",
+ "type": "String",
+ "desc": "a tag href",
+ "memberOf": ""
+ },
+ {
+ "name": "target",
+ "type": "String",
+ "desc": "target for a href.",
+ "memberOf": "",
+ "optvals": [
+ "_self",
+ "_blank",
+ "_parent",
+ "_top"
+ ]
+ },
+ {
+ "name": "xsUrl",
+ "type": "String",
+ "desc": "xs image source",
+ "memberOf": ""
+ },
+ {
+ "name": "smUrl",
+ "type": "String",
+ "desc": "sm image source",
+ "memberOf": ""
+ },
+ {
+ "name": "mdUrl",
+ "type": "String",
+ "desc": "md image source",
+ "memberOf": ""
+ },
+ {
+ "name": "lgUrl",
+ "type": "String",
+ "desc": "lg image source",
+ "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
+ {
+ "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": "setSrc",
+ "sig": "(String url)",
+ "type": "function",
+ "desc": "Sets the url of the image - used to update it"
+ },
+ {
+ "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.Input": {
+ "props": [
+ {
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "is it disabled",
+ "memberOf": ""
+ },
+ {
+ "name": "inputType",
+ "type": "String",
+ "desc": "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
+ "memberOf": ""
+ },
+ {
+ "name": "name",
+ "type": "String",
+ "desc": "name of the input",
+ "memberOf": ""
+ },
+ {
+ "name": "fieldLabel",
+ "type": "string",
+ "desc": "- the label associated",
+ "memberOf": ""
+ },
+ {
+ "name": "placeholder",
+ "type": "string",
+ "desc": "- placeholder to put in text.",
+ "memberOf": ""
+ },
+ {
+ "name": "before",
+ "type": "string",
+ "desc": "- input group add on before",
+ "memberOf": ""
+ },
+ {
+ "name": "after",
+ "type": "string",
+ "desc": "- input group add on after",
+ "memberOf": ""
+ },
+ {
+ "name": "size",
+ "type": "string",
+ "desc": "- (lg|sm) or leave empty..",
+ "memberOf": ""
+ },
+ {
+ "name": "xs",
+ "type": "Number",
+ "desc": "colspan out of 12 for mobile-sized screens",
+ "memberOf": ""
+ },
+ {
+ "name": "sm",
+ "type": "Number",
+ "desc": "colspan out of 12 for tablet-sized screens",
+ "memberOf": ""
+ },
+ {
+ "name": "md",
+ "type": "Number",
+ "desc": "colspan out of 12 for computer-sized screens",
+ "memberOf": ""
+ },
+ {
+ "name": "lg",
+ "type": "Number",
+ "desc": "colspan out of 12 for large computer-sized screens",
+ "memberOf": ""
+ },
+ {
+ "name": "value",
+ "type": "string",
+ "desc": "default value of the input",
+ "memberOf": ""
+ },
+ {
+ "name": "labelWidth",
+ "type": "Number",
+ "desc": "set the width of label",
+ "memberOf": ""
+ },
+ {
+ "name": "labellg",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": ""
+ },
+ {
+ "name": "labelmd",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": ""
+ },
+ {
+ "name": "labelsm",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": ""
+ },
+ {
+ "name": "labelxs",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": ""
+ },
+ {
+ "name": "labelAlign",
+ "type": "String",
+ "desc": "",
+ "memberOf": "",
+ "optvals": [
+ "top",
+ "left"
+ ]
+ },
+ {
+ "name": "readOnly",
+ "type": "Boolean",
+ "desc": "Specifies that the field should be read-only",
+ "memberOf": ""
+ },
+ {
+ "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": ""
+ },
+ {
+ "name": "indicatorpos",
+ "type": "String",
+ "desc": "default left",
+ "memberOf": "",
+ "optvals": [
+ "left",
+ "right"
+ ]
+ },
+ {
+ "name": "align",
+ "type": "String",
+ "desc": "Default left",
+ "memberOf": "",
+ "optvals": [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ {
+ "name": "forceFeedback",
+ "type": "Boolean",
+ "desc": "Default false",
+ "memberOf": "",
+ "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": ""
+ },
+ {
+ "name": "validateOnBlur",
+ "type": "Boolean",
+ "desc": "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf": ""
+ },
+ {
+ "name": "validationDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf": ""
+ },
+ {
+ "name": "focusClass",
+ "type": "String",
+ "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf": ""
+ },
+ {
+ "name": "invalidClass",
+ "type": "String",
+ "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf": ""
+ },
+ {
+ "name": "validClass",
+ "type": "String",
+ "desc": "The CSS class to use when marking a field valid (defaults to \"x-form-invalid\")",
+ "memberOf": ""
+ },
+ {
+ "name": "hasFeedback",
+ "type": "Boolean",
+ "desc": "default true",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "invalidFeedbackIcon",
+ "type": "String",
+ "desc": "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf": ""
+ },
+ {
+ "name": "validFeedbackIcon",
+ "type": "String",
+ "desc": "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf": ""
+ },
+ {
+ "name": "selectOnFocus",
+ "type": "Boolean",
+ "desc": "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "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": ""
+ },
+ {
+ "name": "vtype",
+ "type": "String",
+ "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf": ""
+ },
+ {
+ "name": "disableKeyFilter",
+ "type": "Boolean",
+ "desc": "True to disable input keystroke filtering (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "allowBlank",
+ "type": "Boolean",
+ "desc": "False to validate that the value length > 0 (defaults to true)",
+ "memberOf": ""
+ },
+ {
+ "name": "blankText",
+ "type": "String",
+ "desc": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf": ""
+ },
+ {
+ "name": "minLength",
+ "type": "Number",
+ "desc": "Minimum input field length required (defaults to 0)",
+ "memberOf": ""
+ },
+ {
+ "name": "maxLength",
+ "type": "Number",
+ "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf": ""
+ },
+ {
+ "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": ""
+ },
+ {
+ "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": ""
+ },
+ {
+ "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": ""
+ },
+ {
+ "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": ""
+ },
+ {
+ "name": "regexText",
+ "type": "String",
+ "desc": "-- Depricated - use Invalid Text",
+ "memberOf": ""
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "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": "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "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": "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}",
+ "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": "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}",
+ "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."
+ },
+ {
+ "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": [
+ {
+ "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": "clearInvalid",
+ "sig": "()",
+ "type": "function",
+ "desc": "Clear any invalid styles/messages for this field"
+ },
+ {
+ "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": "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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
+ {
+ "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": "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": "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": "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)",
+ "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)"
+ },
+ {
+ "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.LayoutMasonry": {
+ "props": [
+ {
+ "name": "isLayoutInstant",
+ "type": "Boolean",
+ "desc": "= no animation?",
+ "memberOf": ""
+ },
+ {
+ "name": "boxWidth",
+ "type": "Number",
+ "desc": "width of the columns",
+ "memberOf": ""
+ },
+ {
+ "name": "boxHeight",
+ "type": "Number",
+ "desc": "- 0 for square, or fix it at a certian height",
+ "memberOf": ""
+ },
+ {
+ "name": "padWidth",
+ "type": "Number",
+ "desc": "padding below box..",
+ "memberOf": ""
+ },
+ {
+ "name": "gutter",
+ "type": "Number",
+ "desc": "gutter width..",
+ "memberOf": ""
+ },
+ {
+ "name": "maxCols",
+ "type": "Number",
+ "desc": "maximum number of columns",
+ "memberOf": ""
+ },
+ {
+ "name": "isAutoInitial",
+ "type": "Boolean",
+ "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",
+ "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "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": "layout",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire after layout the items"
+ },
+ {
+ "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": "addBrick",
+ "sig": "(Roo.bootstrap.MasonryBrick the)",
+ "type": "function",
+ "desc": "adds a Masonry Brick"
+ },
+ {
+ "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": "clearAll",
+ "sig": "()",
+ "type": "function",
+ "desc": "clear all the Masonry Brick"
+ },
+ {
+ "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": "get",
+ "sig": "(string the)",
+ "type": "function",
+ "desc": "fetch a Masonry Layout based on the masonry layout ID"
+ },
+ {
+ "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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
+ {
+ "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": "register",
+ "sig": "(Roo.bootstrap.MasonryBrick the)",
+ "type": "function",
+ "desc": "register a Masonry Brick"
+ },
+ {
+ "name": "register",
+ "sig": "(Roo.bootstrap.LayoutMasonry the)",
+ "type": "function",
+ "desc": "register a Masonry Layout"
+ },
+ {
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
+ },
+ {
+ "name": "removeBrick",
+ "sig": "(Roo.bootstrap.MasonryBrick the)",
+ "type": "function",
+ "desc": "remove a Masonry Brick"
+ },
+ {
+ "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.LayoutMasonryAuto": {
+ "props": [
+ {
+ "name": "isFitWidth",
+ "type": "Boolean",
+ "desc": "- resize the width..",
+ "memberOf": ""
+ },
+ {
+ "name": "isOriginLeft",
+ "type": "Boolean",
+ "desc": "= left align?",
+ "memberOf": ""
+ },
+ {
+ "name": "isOriginTop",
+ "type": "Boolean",
+ "desc": "= top align?",
+ "memberOf": ""
+ },
+ {
+ "name": "isLayoutInstant",
+ "type": "Boolean",
+ "desc": "= no animation?",
+ "memberOf": ""
+ },
+ {
+ "name": "isResizingContainer",
+ "type": "Boolean",
+ "desc": "= not sure if this is used..",
+ "memberOf": ""
+ },
+ {
+ "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": "defalut true",
+ "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
+ {
+ "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.Link": {
+ "props": [
+ {
+ "name": "alt",
+ "type": "String",
+ "desc": "image alternative text",
+ "memberOf": ""
+ },
+ {
+ "name": "href",
+ "type": "String",
+ "desc": "a tag href",
+ "memberOf": ""
+ },
+ {
+ "name": "target",
+ "type": "String",
+ "desc": "target for a href.",
+ "memberOf": "",
+ "optvals": [
+ "_self",
+ "_blank",
+ "_parent",
+ "_top"
+ ]
+ },
+ {
+ "name": "html",
+ "type": "String",
+ "desc": "the content of the link.",
+ "memberOf": ""
+ },
+ {
+ "name": "anchor",
+ "type": "String",
+ "desc": "name for the anchor link",
+ "memberOf": ""
+ },
+ {
+ "name": "fa",
+ "type": "String",
+ "desc": "- favicon",
+ "memberOf": ""
+ },
+ {
+ "name": "preventDefault",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
+ {
+ "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.LocationPicker": {
+ "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",
+ "type": "String",
+ "desc": "default google.maps.MapTypeId.ROADMAP",
+ "memberOf": ""
+ },
+ {
+ "name": "mapTypeControl",
+ "type": "Boolean",
+ "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": ""
+ },
+ {
+ "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "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": "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 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 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."
+ },
+ {
+ "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": "Fires when the map resize."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the map show."
+ }
+ ],
+ "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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
+ {
+ "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.MasonryBrick": {
+ "props": [
+ {
+ "name": "title",
+ "type": "String",
+ "desc": "",
+ "memberOf": ""
+ },
+ {
+ "name": "html",
+ "type": "String",
+ "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": "",
+ "memberOf": ""
+ },
+ {
+ "name": "size",
+ "type": "String",
+ "desc": "",
+ "memberOf": "",
+ "optvals": [
+ "xs",
+ "sm",
+ "md",
+ "md-left",
+ "md-right",
+ "tall",
+ "wide"
+ ]
+ },
+ {
+ "name": "placetitle",
+ "type": "String",
+ "desc": "",
+ "memberOf": "",
+ "optvals": [
+ "center",
+ "bottom"
+ ]
+ },
+ {
+ "name": "isFitContainer",
+ "type": "Boolean",
+ "desc": "defalut true",
+ "memberOf": ""
+ },
+ {
+ "name": "preventDefault",
+ "type": "Boolean",
+ "desc": "defalut false",
+ "memberOf": ""
+ },
+ {
+ "name": "inverse",
+ "type": "Boolean",
+ "desc": "defalut false",
+ "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "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 (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "When a MasonryBrick is clcik"
+ },
+ {
+ "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": "get",
+ "sig": "(string the)",
+ "type": "function",
+ "desc": "fetch a masonry brick based on the masonry brick ID"
+ },
+ {
+ "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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
+ {
+ "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": "register",
+ "sig": "(Roo.bootstrap.MasonryBrick the)",
+ "type": "function",
+ "desc": "register a Masonry Brick"
+ },
+ {
+ "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": {
+ "props": [
+ {
+ "name": "type",
+ "type": "String",
+ "desc": "type of menu",
+ "memberOf": "",
+ "optvals": [
+ "dropdown",
+ "treeview",
+ "submenu"
+ ]
+ },
+ {
+ "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",
+ "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "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, 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}",
+ "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": "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",
+ "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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
+ {
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
+ },
+ {
+ "name": "hide",
+ "sig": "(Boolean deep)",
+ "type": "function",
+ "desc": "Hides this menu and optionally all parent menus"
+ },
+ {
+ "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": "(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)",
+ "type": "function",
+ "desc": "Displays this menu at a specific xy position"
+ },
+ {
+ "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.MenuItem": {
+ "props": [
+ {
+ "name": "html",
+ "type": "String",
+ "desc": "the menu label",
+ "memberOf": ""
+ },
+ {
+ "name": "href",
+ "type": "String",
+ "desc": "the link",
+ "memberOf": ""
+ },
+ {
+ "name": "preventDefault",
+ "type": "Boolean",
+ "desc": "do not trigger A href on clicks (default false).",
+ "memberOf": ""
+ },
+ {
+ "name": "isContainer",
+ "type": "Boolean",
+ "desc": "is it a container - just returns a drop down item..",
+ "memberOf": ""
+ },
+ {
+ "name": "active",
+ "type": "Boolean",
+ "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": "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "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 hidden."
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
},
{
- "name": "invalid",
- "sig": "function (_self, msg)\n{\n\n}",
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the field has been marked as invalid."
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
},
{
- "name": "keyup",
+ "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 (_self, e)\n{\n\n}",
"type": "function",
- "desc": "Fires after the key up"
+ "desc": "The raw click event for the entire grid."
},
{
- "name": "remove",
- "sig": "function (combo)\n{\n\n}",
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the remove value from the combobox array"
+ "desc": "Fires after the component is destroyed."
},
{
- "name": "render",
+ "name": "disable",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is rendered."
+ "desc": "Fires after the component is disabled."
},
{
- "name": "select",
- "sig": "function (combo, record, index)\n{\n\n}",
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a list item is selected"
+ "desc": "Fires after the component is enabled."
},
{
- "name": "show",
+ "name": "hide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is shown."
+ "desc": "Fires after the component is hidden."
},
{
- "name": "specialkey",
- "sig": "function (_self, e)\n{\n\n}",
+ "name": "render",
+ "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 after the component is rendered."
},
{
- "name": "valid",
+ "name": "show",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the field has been validated with no errors."
+ "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": "clearValue",
- "sig": "()",
- "type": "function",
- "desc": "Clears any text/value currently set in the field"
- },
- {
- "name": "collapse",
- "sig": "()",
- "type": "function",
- "desc": "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion."
- },
{
"name": "destroy",
"sig": "()",
"type": "function",
"desc": "Disable this component."
},
- {
- "name": "doQuery",
- "sig": "(String query, Boolean forceAll)",
- "type": "function",
- "desc": "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed."
- },
{
"name": "enable",
"sig": "()",
"type": "function",
"desc": "Enable this component."
},
- {
- "name": "expand",
- "sig": "()",
- "type": "function",
- "desc": "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion."
- },
{
"name": "fireEvent",
"sig": "(String eventName, Object... args)",
"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",
+ "name": "getVisibilityEl",
"sig": "()",
"type": "function",
- "desc": "Returns the currently selected field value or empty string if no value is set."
+ "desc": "Get the element that will be used to show or hide"
},
{
"name": "hasListener",
"desc": "Initialize Events for the element"
},
{
- "name": "inputEl",
+ "name": "isVisible",
"sig": "()",
"type": "function",
- "desc": "return the real input element."
+ "desc": "Returns true if this component is visible."
},
{
- "name": "isExpanded",
+ "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": "Returns true if the dropdown list is expanded, else false."
+ "desc": "Removes all listeners for this object"
},
{
- "name": "isVisible",
+ "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": "Returns true if this component is visible."
+ "desc": "Show a component - removes 'hidden' class"
},
{
- "name": "markInvalid",
- "sig": "(String msg)",
+ "name": "tooltipEl",
+ "sig": "()",
"type": "function",
- "desc": "Mark this field as invalid"
+ "desc": "Fetch the element to display the tooltip on."
},
{
- "name": "markValid",
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.bootstrap.MenuMgr": {
+ "props": [],
+ "events": [],
+ "methods": [
+ {
+ "name": "get",
+ "sig": "(String/Object menu)",
+ "type": "function",
+ "desc": "Returns a {@link Roo.menu.Menu} object"
+ },
+ {
+ "name": "hideAll",
"sig": "()",
"type": "function",
- "desc": "Mark this field as valid"
+ "desc": "Hides all menus that are currently visible"
+ }
+ ]
+ },
+ "Roo.bootstrap.MenuSeparator": {
+ "props": [
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "on",
+ "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "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 element (shorthand for addListener)"
+ "desc": "Appends an event handler to this component"
},
{
- "name": "onTriggerClick",
- "sig": "(EventObject e)",
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
"type": "function",
- "desc": "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function."
+ "desc": "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": "purgeListeners",
+ "name": "destroy",
"sig": "()",
"type": "function",
- "desc": "Removes all listeners for this object"
+ "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": "releaseCapture",
- "sig": "(Observable o)",
+ "name": "disable",
+ "sig": "()",
"type": "function",
- "desc": "Removes <b>all</b> added captures from the Observable."
+ "desc": "Disable this component."
},
{
- "name": "removeListener",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "enable",
+ "sig": "()",
"type": "function",
- "desc": "Removes a listener"
+ "desc": "Enable this component."
},
{
- "name": "render",
- "sig": "(String/HTMLElement/Element container)",
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
"type": "function",
- "desc": "If this is a lazy rendering component, render it to its container element."
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "reset",
+ "name": "focus",
+ "sig": "(Boolean selectText)",
+ "type": "function",
+ "desc": "Try to focus this component."
+ },
+ {
+ "name": "getChildContainer",
"sig": "()",
"type": "function",
- "desc": "Resets the current field value to the originally loaded value and clears any validation messages"
+ "desc": "Fetch the element to add children to"
},
{
- "name": "select",
- "sig": "(Number index, Boolean scrollIntoView)",
+ "name": "getEl",
+ "sig": "()",
"type": "function",
- "desc": "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue."
+ "desc": "Returns the underlying {@link Roo.Element}."
},
{
- "name": "selectByValue",
- "sig": "(String value, Boolean scrollIntoView)",
+ "name": "getId",
+ "sig": "()",
"type": "function",
- "desc": "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue."
+ "desc": "Returns the id of this component."
},
{
- "name": "setDisabled",
- "sig": "(Boolean disabled)",
+ "name": "getVisibilityEl",
+ "sig": "()",
"type": "function",
- "desc": "Convenience function for setting disabled/enabled by boolean."
+ "desc": "Get the element that will be used to show or hide"
},
{
- "name": "setEditable",
- "sig": "(Boolean value)",
+ "name": "hasListener",
+ "sig": "(String eventName)",
"type": "function",
- "desc": "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time."
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "setFromData",
- "sig": "(Object value)",
+ "name": "hide",
+ "sig": "()",
"type": "function",
- "desc": "Sets the value of the field based on a object which is related to the record format for the store."
+ "desc": "Hide a component - adds 'hidden' class"
},
{
- "name": "setRawValue",
- "sig": "(Mixed value)",
+ "name": "initEvents",
+ "sig": "()",
"type": "function",
- "desc": "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}."
+ "desc": "Initialize Events for the element"
},
{
- "name": "setValue",
- "sig": "(String value)",
+ "name": "isVisible",
+ "sig": "()",
"type": "function",
- "desc": "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set)."
+ "desc": "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": "(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.ComboBox_old": {
+ "Roo.bootstrap.MessageBar": {
"props": [
{
- "name": "append",
+ "name": "html",
+ "type": "String",
+ "desc": "contents of the MessageBar",
+ "memberOf": ""
+ },
+ {
+ "name": "weight",
+ "type": "String",
+ "desc": "default info",
+ "memberOf": "",
+ "optvals": [
+ "info",
+ "success",
+ "warning",
+ "danger"
+ ]
+ },
+ {
+ "name": "beforeClass",
+ "type": "String",
+ "desc": "insert the bar before the given class",
+ "memberOf": ""
+ },
+ {
+ "name": "closable",
"type": "Boolean",
"desc": "default false",
"memberOf": "",
]
},
{
- "name": "autoFocus",
+ "name": "fixed",
"type": "Boolean",
- "desc": "auto focus the first item, default true",
+ "desc": "default false, fix the bar at the top",
"memberOf": "",
"optvals": [
"true",
]
},
{
- "name": "lazyRender",
- "type": "Boolean",
- "desc": "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
- "memberOf": ""
- },
- {
- "name": "autoCreate",
- "type": "Boolean/Object",
- "desc": "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
- "memberOf": ""
- },
- {
- "name": "store",
- "type": "Roo.data.Store",
- "desc": "The data store to which this combo is bound (defaults to undefined)",
- "memberOf": ""
+ "name": "cls",
+ "type": "String",
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "title",
+ "name": "style",
"type": "String",
- "desc": "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
- "memberOf": ""
+ "desc": "any extra css",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "tpl",
- "type": "String/Roo.Template",
- "desc": "The template to use to render the output",
- "memberOf": ""
+ "name": "xattr",
+ "type": "Object",
+ "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "grow",
+ "name": "can_build_overlaid",
"type": "Boolean",
- "desc": "",
- "memberOf": ""
- },
- {
- "name": "growMin",
- "type": "Number",
- "desc": "",
- "memberOf": ""
- },
- {
- "name": "growMax",
- "type": "Number",
- "desc": "",
- "memberOf": ""
+ "desc": "True if element can be rebuild from a HTML page",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "listWidth",
- "type": "Number",
- "desc": "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
- "memberOf": ""
+ "name": "dataId",
+ "type": "string",
+ "desc": "cutomer id",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "displayField",
- "type": "String",
- "desc": "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
- "memberOf": ""
+ "name": "name",
+ "type": "string",
+ "desc": "Specifies name attribute",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "valueField",
- "type": "String",
- "desc": "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
- "memberOf": ""
+ "name": "tooltip",
+ "type": "string",
+ "desc": "Text for the tooltip",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "hiddenName",
- "type": "String",
- "desc": "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
- "memberOf": ""
+ "name": "container_method",
+ "type": "string",
+ "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "listClass",
- "type": "String",
- "desc": "CSS class to apply to the dropdown list element (defaults to '')",
- "memberOf": ""
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
},
{
- "name": "selectedClass",
+ "name": "disableClass",
"type": "String",
- "desc": "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
- "memberOf": ""
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
},
{
- "name": "shadow",
- "type": "Boolean/String",
- "desc": "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
- "memberOf": ""
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
},
{
- "name": "listAlign",
+ "name": "hideMode",
"type": "String",
- "desc": "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
- "memberOf": ""
- },
- {
- "name": "maxHeight",
- "type": "Number",
- "desc": "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
- "memberOf": ""
+ "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": "triggerAction",
+ "name": "actionMode",
"type": "String",
- "desc": "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
- "memberOf": ""
- },
- {
- "name": "minChars",
- "type": "Number",
- "desc": "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
- "memberOf": ""
- },
- {
- "name": "typeAhead",
- "type": "Boolean",
- "desc": "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
- "memberOf": ""
- },
- {
- "name": "queryDelay",
- "type": "Number",
- "desc": "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
- "memberOf": ""
- },
- {
- "name": "pageSize",
- "type": "Number",
- "desc": "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
- "memberOf": ""
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
},
{
- "name": "selectOnFocus",
- "type": "Boolean",
- "desc": "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
- "memberOf": ""
- },
+ "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": "queryParam",
- "type": "String",
- "desc": "Name of the query as it will be passed on the querystring (defaults to 'query')",
- "memberOf": ""
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
},
{
- "name": "loadingText",
- "type": "String",
- "desc": "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
- "memberOf": ""
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
},
{
- "name": "resizable",
- "type": "Boolean",
- "desc": "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
- "memberOf": ""
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
},
{
- "name": "handleHeight",
- "type": "Number",
- "desc": "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
- "memberOf": ""
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
},
{
- "name": "editable",
- "type": "Boolean",
- "desc": "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
- "memberOf": ""
+ "name": "childrenrendered",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the children have been rendered.."
},
{
- "name": "allQuery",
- "type": "String",
- "desc": "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
- "memberOf": ""
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
},
{
- "name": "mode",
- "type": "String",
- "desc": "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
- "memberOf": ""
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
},
{
- "name": "minListWidth",
- "type": "Number",
- "desc": "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
- "memberOf": ""
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
},
{
- "name": "forceSelection",
- "type": "Boolean",
- "desc": "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
- "memberOf": ""
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
},
{
- "name": "typeAheadDelay",
- "type": "Number",
- "desc": "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
- "memberOf": ""
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
},
{
- "name": "valueNotFoundText",
- "type": "String",
- "desc": "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
- "memberOf": ""
- },
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ }
+ ],
+ "methods": [
{
- "name": "blockFocus",
- "type": "Boolean",
- "desc": "Prevents all focus calls, so it can work with things like HTML edtor bar",
- "memberOf": ""
+ "name": "addEvents",
+ "sig": "(Object object)",
+ "type": "function",
+ "desc": "Used to define events on this Observable"
},
{
- "name": "disableClear",
- "type": "Boolean",
- "desc": "Disable showing of clear button.",
- "memberOf": ""
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this component"
},
{
- "name": "alwaysQuery",
- "type": "Boolean",
- "desc": "Disable caching of results, and always send query",
- "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": "multiple",
- "type": "Boolean",
- "desc": "ComboBobArray, default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "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": "triggerClass",
- "type": "String",
- "desc": "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
- "memberOf": "Roo.bootstrap.TriggerField"
+ "name": "disable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Disable this component."
},
{
- "name": "caret",
- "type": "String",
- "desc": "a fontawesome for the trigger icon see http://fortawesome.github.io/Font-Awesome/icons/",
- "memberOf": "Roo.bootstrap.TriggerField",
- "optvals": [
- "search",
- "calendar"
- ]
+ "name": "enable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Enable this component."
},
{
- "name": "hideTrigger",
- "type": "Boolean",
- "desc": "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf": "Roo.bootstrap.TriggerField"
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "removable",
- "type": "Boolean",
- "desc": "special filter default false",
- "memberOf": "Roo.bootstrap.TriggerField",
- "optvals": [
- "true",
- "false"
- ]
+ "name": "focus",
+ "sig": "(Boolean selectText)",
+ "type": "function",
+ "desc": "Try to focus this component."
},
{
- "name": "disabled",
- "type": "Boolean",
- "desc": "is it disabled",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "getChildContainer",
+ "sig": "()",
+ "type": "function",
+ "desc": "Fetch the element to add children to"
},
{
- "name": "fieldLabel",
- "type": "String",
- "desc": "- the label associated",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "getEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the underlying {@link Roo.Element}."
},
{
- "name": "inputType",
- "type": "String",
- "desc": "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "getId",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the id of this component."
},
{
- "name": "name",
- "type": "String",
- "desc": "name of the input",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
},
{
- "name": "placeholder",
- "type": "string",
- "desc": "- placeholder to put in text.",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "before",
- "type": "string",
- "desc": "- input group add on before",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "hide",
+ "sig": "()",
+ "type": "function",
+ "desc": "Hide a component - adds 'hidden' class"
},
{
- "name": "after",
- "type": "string",
- "desc": "- input group add on after",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "initEvents",
+ "sig": "()",
+ "type": "function",
+ "desc": "Initialize Events for the element"
},
{
- "name": "size",
- "type": "string",
- "desc": "- (lg|sm) or leave empty..",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "isVisible",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if this component is visible."
},
{
- "name": "xs",
- "type": "Number",
- "desc": "colspan out of 12 for mobile-sized screens",
- "memberOf": "Roo.bootstrap.Input"
+ "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": "sm",
- "type": "Number",
- "desc": "colspan out of 12 for tablet-sized screens",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "purgeListeners",
+ "sig": "()",
+ "type": "function",
+ "desc": "Removes all listeners for this object"
},
{
- "name": "md",
- "type": "Number",
- "desc": "colspan out of 12 for computer-sized screens",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
},
{
- "name": "lg",
- "type": "Number",
- "desc": "colspan out of 12 for large computer-sized screens",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
},
{
- "name": "value",
- "type": "string",
- "desc": "default value of the input",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "render",
+ "sig": "(String/HTMLElement/Element container)",
+ "type": "function",
+ "desc": "If this is a lazy rendering component, render it to its container element."
},
{
- "name": "labelWidth",
- "type": "Number",
- "desc": "set the width of label (0-12)",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
+ "type": "function",
+ "desc": "Convenience function for setting disabled/enabled by boolean."
},
{
- "name": "labelAlign",
- "type": "String",
- "desc": "",
- "memberOf": "Roo.bootstrap.Input",
- "optvals": [
- "top",
- "left"
- ]
+ "name": "setVisible",
+ "sig": "(Boolean visible)",
+ "type": "function",
+ "desc": "Convenience function to hide or show this component by boolean."
},
{
- "name": "readOnly",
- "type": "Boolean",
- "desc": "Specifies that the field should be read-only",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "show",
+ "sig": "()",
+ "type": "function",
+ "desc": "Show a component - removes 'hidden' class"
},
{
- "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": "tooltipEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Fetch the element to display the tooltip on."
},
{
- "name": "align",
- "type": "String",
- "desc": "Default left",
- "memberOf": "Roo.bootstrap.Input",
- "optvals": [
- "left",
- "center",
- "right"
- ]
- },
+ "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": "forceFeedback",
- "type": "Boolean",
- "desc": "Default false",
- "memberOf": "Roo.bootstrap.Input",
- "optvals": [
- "true",
- "false"
- ]
+ "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": "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": "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": "validateOnBlur",
- "type": "Boolean",
- "desc": "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "getDialog",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns a reference to the underlying {@link Roo.BasicDialog} element"
},
{
- "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": "hide",
+ "sig": "()",
+ "type": "function",
+ "desc": "Hides the message box if it is displayed"
},
{
- "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": "isVisible",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if the message box is currently displayed"
},
{
- "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": "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": "validClass",
- "type": "String",
- "desc": "The CSS class to use when marking a field valid (defaults to \"x-form-invalid\")",
- "memberOf": "Roo.bootstrap.Input"
+ "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": "hasFeedback",
- "type": "Boolean",
- "desc": "default true",
- "memberOf": "Roo.bootstrap.Input",
- "optvals": [
- "true",
- "false"
- ]
+ "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": "invalidFeedbackIcon",
- "type": "String",
- "desc": "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf": "Roo.bootstrap.Input"
+ "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": "validFeedbackIcon",
- "type": "String",
- "desc": "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "updateText",
+ "sig": "(String text)",
+ "type": "function",
+ "desc": "Updates the message box body text"
},
{
- "name": "maskRe",
+ "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": "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "Title of dialog",
+ "memberOf": ""
},
{
- "name": "vtype",
+ "name": "html",
"type": "String",
- "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "- the body of the dialog (for simple ones) - you can also use template..",
+ "memberOf": ""
},
{
- "name": "disableKeyFilter",
- "type": "Boolean",
- "desc": "True to disable input keystroke filtering (defaults to false)",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "tmpl",
+ "type": "Roo.Template",
+ "desc": "- a template with variables. to use it, add a handler in show:method adn",
+ "memberOf": ""
},
{
- "name": "allowBlank",
+ "name": "specificTitle",
"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"
+ "desc": "default false",
+ "memberOf": ""
},
{
- "name": "maxLength",
- "type": "Number",
- "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "buttons",
+ "type": "Array",
+ "desc": "Array of buttons or standard button set..",
+ "memberOf": ""
},
{
- "name": "minLengthText",
+ "name": "buttonPosition",
"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": "default right",
+ "memberOf": "",
+ "optvals": [
+ "left",
+ "right",
+ "center"
+ ]
},
{
- "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": "animate",
+ "type": "Boolean",
+ "desc": "default true",
+ "memberOf": ""
},
{
- "name": "validator",
- "type": "Function",
- "desc": "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "allow_close",
+ "type": "Boolean",
+ "desc": "default true",
+ "memberOf": ""
},
{
- "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": "fitwindow",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": ""
},
{
- "name": "regexText",
+ "name": "size",
"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": "default empty",
+ "memberOf": "",
+ "optvals": [
+ "sm",
+ "lg"
+ ]
},
{
"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": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
}
],
"events": [
- {
- "name": "add",
- "sig": "function (combo)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the 'add' icon is pressed (add a listener to enable add button)"
- },
{
"name": "beforedestroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires before the component is hidden. Return false to stop the hide."
},
- {
- "name": "beforequery",
- "sig": "function (combo, query, forceAll, cancel, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:"
- },
{
"name": "beforerender",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires before the component is rendered. Return false to stop the render."
},
- {
- "name": "beforeselect",
- "sig": "function (combo, record, index)\n{\n\n}",
- "type": "function",
- "desc": "Fires before a list item is selected. Return false to cancel the selection."
- },
{
"name": "beforeshow",
"sig": "function (_self)\n{\n\n}",
"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}",
+ "name": "btnclick",
+ "sig": "function (e)\n{\n\n}",
"type": "function",
- "desc": "Fires just before the field blurs if the field value has changed."
+ "desc": "The raw btnclick event for the button"
},
{
"name": "childrenrendered",
"type": "function",
"desc": "Fires when the children have been rendered.."
},
- {
- "name": "collapse",
- "sig": "function (combo)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the dropdown list is collapsed"
- },
{
"name": "destroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is disabled."
},
- {
- "name": "edit",
- "sig": "function (combo, record)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the 'edit' icon is pressed (add a listener to enable add button)"
- },
{
"name": "enable",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is enabled."
},
- {
- "name": "expand",
- "sig": "function (combo)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the dropdown list is expanded"
- },
- {
- "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": "remove",
- "sig": "function (combo)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the remove value from the combobox array"
- },
{
"name": "render",
"sig": "function (_self)\n{\n\n}",
"desc": "Fires after the component is rendered."
},
{
- "name": "select",
- "sig": "function (combo, record, index)\n{\n\n}",
+ "name": "resize",
+ "sig": "function (_self, e)\n{\n\n}",
"type": "function",
- "desc": "Fires when a list item is selected"
+ "desc": "Fire when dialog resize"
},
{
"name": "show",
"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": [
"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": "clearInvalid",
- "sig": "()",
- "type": "function",
- "desc": "Clear any invalid styles/messages for this field"
- },
- {
- "name": "clearValue",
- "sig": "()",
+ "name": "applyBody",
+ "sig": "(Obj data)",
"type": "function",
- "desc": "Clears any text/value currently set in the field"
+ "desc": "Set the body of the Dialog using the template"
},
{
- "name": "collapse",
- "sig": "()",
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
"type": "function",
- "desc": "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion."
+ "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",
"type": "function",
"desc": "Disable this component."
},
- {
- "name": "doQuery",
- "sig": "(String query, Boolean forceAll)",
- "type": "function",
- "desc": "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed."
- },
{
"name": "enable",
"sig": "()",
"type": "function",
"desc": "Enable this component."
},
- {
- "name": "expand",
- "sig": "()",
- "type": "function",
- "desc": "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion."
- },
{
"name": "fireEvent",
"sig": "(String eventName, Object... args)",
"desc": "Returns the id of this component."
},
{
- "name": "getName",
+ "name": "getVisibilityEl",
"sig": "()",
"type": "function",
- "desc": "Returns the name of the field"
+ "desc": "Get the element that will be used to show or hide"
},
{
- "name": "getRawValue",
+ "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": "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}."
+ "desc": "Hide a component - adds 'hidden' class"
},
{
- "name": "getValue",
+ "name": "initEvents",
"sig": "()",
"type": "function",
- "desc": "Returns the currently selected field value or empty string if no value is set."
+ "desc": "Initialize Events for the element"
},
{
- "name": "hasListener",
- "sig": "(String eventName)",
+ "name": "isVisible",
+ "sig": "()",
"type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
+ "desc": "Returns true if this component is visible."
},
{
- "name": "hide",
+ "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": "Hide a component - adds 'hidden' class"
+ "desc": "Removes all listeners for this object"
},
{
- "name": "initEvents",
+ "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": "setBody",
+ "sig": "(String str)",
+ "type": "function",
+ "desc": "Set the body of the Dialog"
+ },
+ {
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
+ "type": "function",
+ "desc": "Convenience function for setting disabled/enabled by boolean."
+ },
+ {
+ "name": "setTitle",
+ "sig": "(String str)",
+ "type": "function",
+ "desc": "Set the title of the Dialog"
+ },
+ {
+ "name": "setVisible",
+ "sig": "(Boolean visible)",
+ "type": "function",
+ "desc": "Convenience function to hide or show this component by boolean."
+ },
+ {
+ "name": "show",
"sig": "()",
"type": "function",
- "desc": "Initialize Events for the element"
+ "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.MoneyField": {
+ "props": [
+ {
+ "name": "allowDecimals",
+ "type": "Boolean",
+ "desc": "False to disallow decimal values (defaults to true)",
+ "memberOf": ""
+ },
+ {
+ "name": "decimalSeparator",
+ "type": "String",
+ "desc": "Character(s) to allow as the decimal separator (defaults to '.')",
+ "memberOf": ""
+ },
+ {
+ "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": "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")",
+ "memberOf": ""
+ },
+ {
+ "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": "cast int if true (defalut true)",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "defaults",
+ "type": "String",
+ "desc": "currency of the MoneyField\nvalue should be in lkey",
+ "memberOf": ""
+ },
+ {
+ "name": "thousandsDelimiter",
+ "type": "String",
+ "desc": "Symbol of thousandsDelimiter",
+ "memberOf": ""
+ },
+ {
+ "name": "append",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": "Roo.bootstrap.ComboBox",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
- "name": "inputEl",
- "sig": "()",
- "type": "function",
- "desc": "return the real input element."
+ "name": "autoFocus",
+ "type": "Boolean",
+ "desc": "auto focus the first item, default true",
+ "memberOf": "Roo.bootstrap.ComboBox",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
- "name": "isExpanded",
- "sig": "()",
- "type": "function",
- "desc": "Returns true if the dropdown list is expanded, else false."
+ "name": "tickable",
+ "type": "Boolean",
+ "desc": "ComboBox with tickable selections (true|false), default false",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "isVisible",
- "sig": "()",
- "type": "function",
- "desc": "Returns true if this component is visible."
+ "name": "triggerList",
+ "type": "Boolean",
+ "desc": "trigger show the list or not (true|false) default true",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "markInvalid",
- "sig": "(String msg)",
- "type": "function",
- "desc": "Mark this field as invalid"
+ "name": "showToggleBtn",
+ "type": "Boolean",
+ "desc": "show toggle button or not (true|false) default true",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "markValid",
- "sig": "()",
- "type": "function",
- "desc": "Mark this field as valid"
+ "name": "btnPosition",
+ "type": "String",
+ "desc": "set the position of the trigger button (left | right) default right",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "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": "animate",
+ "type": "Boolean",
+ "desc": "default true",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "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": "emptyResultText",
+ "type": "Boolean",
+ "desc": "only for touch device",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "purgeListeners",
- "sig": "()",
- "type": "function",
- "desc": "Removes all listeners for this object"
+ "name": "triggerText",
+ "type": "String",
+ "desc": "multiple combobox trigger button text default 'Select'",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "releaseCapture",
- "sig": "(Observable o)",
- "type": "function",
- "desc": "Removes <b>all</b> added captures from the Observable."
+ "name": "emptyTitle",
+ "type": "String",
+ "desc": "default ''",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "removeListener",
- "sig": "(String eventName, Function handler, Object scope)",
- "type": "function",
- "desc": "Removes a listener"
+ "name": "lazyRender",
+ "type": "Boolean",
+ "desc": "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "render",
- "sig": "(String/HTMLElement/Element container)",
- "type": "function",
- "desc": "If this is a lazy rendering component, render it to its container element."
+ "name": "autoCreate",
+ "type": "Boolean/Object",
+ "desc": "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "reset",
- "sig": "()",
- "type": "function",
- "desc": "Resets the current field value to the originally loaded value and clears any validation messages"
+ "name": "store",
+ "type": "Roo.data.Store",
+ "desc": "The data store to which this combo is bound (defaults to undefined)",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "select",
- "sig": "(Number index, Boolean scrollIntoView)",
- "type": "function",
- "desc": "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue."
+ "name": "title",
+ "type": "String",
+ "desc": "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "selectByValue",
- "sig": "(String value, Boolean scrollIntoView)",
- "type": "function",
- "desc": "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue."
+ "name": "tpl",
+ "type": "String/Roo.Template",
+ "desc": "The template to use to render the output",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "setDisabled",
- "sig": "(Boolean disabled)",
- "type": "function",
- "desc": "Convenience function for setting disabled/enabled by boolean."
+ "name": "grow",
+ "type": "Boolean",
+ "desc": "",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "setEditable",
- "sig": "(Boolean value)",
- "type": "function",
- "desc": "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time."
+ "name": "growMin",
+ "type": "Number",
+ "desc": "",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "setFromData",
- "sig": "(Object value)",
- "type": "function",
- "desc": "Sets the value of the field based on a object which is related to the record format for the store."
+ "name": "growMax",
+ "type": "Number",
+ "desc": "",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "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": "listWidth",
+ "type": "Number",
+ "desc": "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "setValue",
- "sig": "(String value)",
- "type": "function",
- "desc": "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set)."
+ "name": "displayField",
+ "type": "String",
+ "desc": "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "setVisible",
- "sig": "(Boolean visible)",
- "type": "function",
- "desc": "Convenience function to hide or show this component by boolean."
+ "name": "valueField",
+ "type": "String",
+ "desc": "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "show",
- "sig": "()",
- "type": "function",
- "desc": "Show a component - removes 'hidden' class"
+ "name": "modalTitle",
+ "type": "String",
+ "desc": "The title of the dialog that pops up on mobile views.",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "tooltipEl",
- "sig": "()",
- "type": "function",
- "desc": "Fetch the element to display the tooltip on."
+ "name": "hiddenName",
+ "type": "String",
+ "desc": "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "un",
- "sig": "(String eventName, Function handler, Object scope)",
- "type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
+ "name": "listClass",
+ "type": "String",
+ "desc": "CSS class to apply to the dropdown list element (defaults to '')",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "validate",
- "sig": "()",
- "type": "function",
- "desc": "Validates the field value"
+ "name": "selectedClass",
+ "type": "String",
+ "desc": "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "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.Component": {
- "props": [
+ "name": "shadow",
+ "type": "Boolean/String",
+ "desc": "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
+ "memberOf": "Roo.bootstrap.ComboBox"
+ },
{
- "name": "cls",
+ "name": "listAlign",
"type": "String",
- "desc": "css class",
- "memberOf": ""
+ "desc": "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "style",
+ "name": "maxHeight",
+ "type": "Number",
+ "desc": "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
+ "memberOf": "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name": "triggerAction",
"type": "String",
- "desc": "any extra css",
- "memberOf": ""
+ "desc": "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "xattr",
- "type": "Object",
- "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf": ""
+ "name": "minChars",
+ "type": "Number",
+ "desc": "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "can_build_overlaid",
+ "name": "typeAhead",
"type": "Boolean",
- "desc": "True if element can be rebuild from a HTML page",
- "memberOf": ""
+ "desc": "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "dataId",
- "type": "string",
- "desc": "cutomer id",
- "memberOf": ""
+ "name": "queryDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "name",
- "type": "string",
- "desc": "Specifies name attribute",
- "memberOf": ""
+ "name": "pageSize",
+ "type": "Number",
+ "desc": "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "tooltip",
- "type": "string",
- "desc": "Text for the tooltip",
- "memberOf": ""
+ "name": "selectOnFocus",
+ "type": "Boolean",
+ "desc": "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "container_method",
- "type": "string",
- "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf": ""
+ "name": "queryParam",
+ "type": "String",
+ "desc": "Name of the query as it will be passed on the querystring (defaults to 'query')",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "disableClass",
+ "name": "loadingText",
"type": "String",
- "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf": "Roo.Component"
+ "desc": "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "allowDomMove",
+ "name": "resizable",
"type": "Boolean",
- "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf": "Roo.Component"
+ "desc": "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "hideMode",
+ "name": "handleHeight",
+ "type": "Number",
+ "desc": "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
+ "memberOf": "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name": "editable",
+ "type": "Boolean",
+ "desc": "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
+ "memberOf": "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name": "allQuery",
"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"
- ]
+ "desc": "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "actionMode",
+ "name": "mode",
"type": "String",
- "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
- "memberOf": "Roo.Component"
+ "desc": "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "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": "minListWidth",
+ "type": "Number",
+ "desc": "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
+ "memberOf": "Roo.bootstrap.ComboBox"
+ },
{
- "name": "beforedestroy",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ "name": "forceSelection",
+ "type": "Boolean",
+ "desc": "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "beforehide",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires before the component is hidden. Return false to stop the hide."
+ "name": "typeAheadDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "beforerender",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires before the component is rendered. Return false to stop the render."
+ "name": "valueNotFoundText",
+ "type": "String",
+ "desc": "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "beforeshow",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires before the component is shown. Return false to stop the show."
+ "name": "blockFocus",
+ "type": "Boolean",
+ "desc": "Prevents all focus calls, so it can work with things like HTML edtor bar",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "childrenrendered",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the children have been rendered.."
+ "name": "disableClear",
+ "type": "Boolean",
+ "desc": "Disable showing of clear button.",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "destroy",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is destroyed."
+ "name": "alwaysQuery",
+ "type": "Boolean",
+ "desc": "Disable caching of results, and always send query",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "disable",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is disabled."
+ "name": "multiple",
+ "type": "Boolean",
+ "desc": "ComboBobArray, default false",
+ "memberOf": "Roo.bootstrap.ComboBox",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
- "name": "enable",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is enabled."
+ "name": "invalidClass",
+ "type": "String",
+ "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "hide",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is hidden."
+ "name": "validClass",
+ "type": "String",
+ "desc": "The CSS class to use when marking a field valid (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.bootstrap.ComboBox"
},
{
- "name": "render",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is rendered."
+ "name": "specialFilter",
+ "type": "Boolean",
+ "desc": "special filter default false",
+ "memberOf": "Roo.bootstrap.ComboBox",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
- "name": "show",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is shown."
- }
- ],
- "methods": [
+ "name": "mobileTouchView",
+ "type": "Boolean",
+ "desc": "show mobile touch view when using a mobile default true",
+ "memberOf": "Roo.bootstrap.ComboBox",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
{
- "name": "addEvents",
- "sig": "(Object object)",
- "type": "function",
- "desc": "Used to define events on this Observable"
+ "name": "useNativeIOS",
+ "type": "Boolean",
+ "desc": "render it as classic select for ios, not support dynamic load data (default false)",
+ "memberOf": "Roo.bootstrap.ComboBox",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
- "name": "addListener",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
- "type": "function",
- "desc": "Appends an event handler to this component"
+ "name": "triggerClass",
+ "type": "String",
+ "desc": "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
+ "memberOf": "Roo.bootstrap.TriggerField"
},
{
- "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": "caret",
+ "type": "String",
+ "desc": "a fontawesome for the trigger icon see http://fortawesome.github.io/Font-Awesome/icons/",
+ "memberOf": "Roo.bootstrap.TriggerField",
+ "optvals": [
+ "search",
+ "calendar"
+ ]
},
{
- "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": "hideTrigger",
+ "type": "Boolean",
+ "desc": "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf": "Roo.bootstrap.TriggerField"
},
{
- "name": "disable",
- "sig": "()",
- "type": "function",
- "desc": "Disable this component."
+ "name": "removable",
+ "type": "Boolean",
+ "desc": "special filter default false",
+ "memberOf": "Roo.bootstrap.TriggerField",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
- "name": "enable",
- "sig": "()",
- "type": "function",
- "desc": "Enable this component."
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "is it disabled",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "fireEvent",
- "sig": "(String eventName, Object... args)",
- "type": "function",
- "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ "name": "inputType",
+ "type": "String",
+ "desc": "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "focus",
- "sig": "(Boolean selectText)",
- "type": "function",
- "desc": "Try to focus this component."
+ "name": "name",
+ "type": "String",
+ "desc": "name of the input",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "getChildContainer",
- "sig": "()",
- "type": "function",
- "desc": "Fetch the element to add children to"
+ "name": "fieldLabel",
+ "type": "string",
+ "desc": "- the label associated",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "getEl",
- "sig": "()",
- "type": "function",
- "desc": "Returns the underlying {@link Roo.Element}."
+ "name": "placeholder",
+ "type": "string",
+ "desc": "- placeholder to put in text.",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "getId",
- "sig": "()",
- "type": "function",
- "desc": "Returns the id of this component."
+ "name": "before",
+ "type": "string",
+ "desc": "- input group add on before",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "hasListener",
- "sig": "(String eventName)",
- "type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
+ "name": "after",
+ "type": "string",
+ "desc": "- input group add on after",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "hide",
- "sig": "()",
- "type": "function",
- "desc": "Hide a component - adds 'hidden' class"
+ "name": "size",
+ "type": "string",
+ "desc": "- (lg|sm) or leave empty..",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "initEvents",
- "sig": "()",
- "type": "function",
- "desc": "Initialize Events for the element"
+ "name": "xs",
+ "type": "Number",
+ "desc": "colspan out of 12 for mobile-sized screens",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "isVisible",
- "sig": "()",
- "type": "function",
- "desc": "Returns true if this component is visible."
+ "name": "sm",
+ "type": "Number",
+ "desc": "colspan out of 12 for tablet-sized screens",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "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": "md",
+ "type": "Number",
+ "desc": "colspan out of 12 for computer-sized screens",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "purgeListeners",
- "sig": "()",
- "type": "function",
- "desc": "Removes all listeners for this object"
+ "name": "lg",
+ "type": "Number",
+ "desc": "colspan out of 12 for large computer-sized screens",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "releaseCapture",
- "sig": "(Observable o)",
- "type": "function",
- "desc": "Removes <b>all</b> added captures from the Observable."
+ "name": "value",
+ "type": "string",
+ "desc": "default value of the input",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "removeListener",
- "sig": "(String eventName, Function handler, Object scope)",
- "type": "function",
- "desc": "Removes a listener"
+ "name": "labelWidth",
+ "type": "Number",
+ "desc": "set the width of label",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "render",
- "sig": "(String/HTMLElement/Element container)",
- "type": "function",
- "desc": "If this is a lazy rendering component, render it to its container element."
+ "name": "labellg",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "setDisabled",
- "sig": "(Boolean disabled)",
- "type": "function",
- "desc": "Convenience function for setting disabled/enabled by boolean."
+ "name": "labelmd",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "setVisible",
- "sig": "(Boolean visible)",
- "type": "function",
- "desc": "Convenience function to hide or show this component by boolean."
+ "name": "labelsm",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "show",
- "sig": "()",
- "type": "function",
- "desc": "Show a component - removes 'hidden' class"
+ "name": "labelxs",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "tooltipEl",
- "sig": "()",
- "type": "function",
- "desc": "Fetch the element to display the tooltip on."
+ "name": "labelAlign",
+ "type": "String",
+ "desc": "",
+ "memberOf": "Roo.bootstrap.Input",
+ "optvals": [
+ "top",
+ "left"
+ ]
},
{
- "name": "un",
- "sig": "(String eventName, Function handler, Object scope)",
- "type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
- }
- ]
- },
- "Roo.bootstrap.Container": {
- "props": [
- {
- "name": "jumbotron",
+ "name": "readOnly",
"type": "Boolean",
- "desc": "is it a jumbotron element",
- "memberOf": ""
+ "desc": "Specifies that the field should be read-only",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "html",
+ "name": "autocomplete",
"type": "String",
- "desc": "content of element",
- "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": "well",
+ "name": "indicatorpos",
"type": "String",
- "desc": "a well, large, small or medium.",
- "memberOf": "",
+ "desc": "default left",
+ "memberOf": "Roo.bootstrap.Input",
"optvals": [
- "lg",
- "sm",
- "md"
+ "left",
+ "right"
]
},
{
- "name": "panel",
+ "name": "align",
"type": "String",
- "desc": "render as a panel.",
- "memberOf": "",
+ "desc": "Default left",
+ "memberOf": "Roo.bootstrap.Input",
"optvals": [
- "primary",
- "success",
- "info",
- "warning",
- "danger"
+ "left",
+ "center",
+ "right"
]
},
{
- "name": "header",
- "type": "String",
- "desc": "content of header (for panel)",
- "memberOf": ""
+ "name": "forceFeedback",
+ "type": "Boolean",
+ "desc": "Default false",
+ "memberOf": "Roo.bootstrap.Input",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
- "name": "footer",
- "type": "String",
- "desc": "content of footer (for panel)",
- "memberOf": ""
+ "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": "sticky",
+ "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": "block to use as footer or body- needs css-bootstrap/sticky-footer.css",
- "memberOf": "",
+ "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "hasFeedback",
+ "type": "Boolean",
+ "desc": "default true",
+ "memberOf": "Roo.bootstrap.Input",
"optvals": [
- "footer",
- "wrap",
- "push"
+ "true",
+ "false"
]
},
{
- "name": "tag",
+ "name": "invalidFeedbackIcon",
"type": "String",
- "desc": "type of HTML tag.",
- "memberOf": "",
- "optvals": [
- "header",
- "aside",
- "section"
- ]
+ "desc": "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "alert",
+ "name": "validFeedbackIcon",
"type": "String",
- "desc": "type alert (changes background / border...)",
- "memberOf": "",
- "optvals": [
- "success",
- "info",
- "warning",
- "danger"
- ]
+ "desc": "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "fa",
+ "name": "maskRe",
"type": "String",
- "desc": "font awesome icon",
- "memberOf": "",
- "optvals": [
- "ban",
- "check",
- "..."
- ]
+ "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": "icon",
+ "name": "vtype",
"type": "String",
- "desc": "glyphicon name",
- "memberOf": "",
- "optvals": [
- "info-sign",
- "check",
- "..."
- ]
+ "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "hidden",
+ "name": "disableKeyFilter",
"type": "Boolean",
- "desc": "hide the element",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "desc": "True to disable input keystroke filtering (defaults to false)",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "expandable",
+ "name": "allowBlank",
"type": "Boolean",
- "desc": "default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "desc": "False to validate that the value length > 0 (defaults to true)",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "expanded",
- "type": "Boolean",
- "desc": "default true",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "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": "rheader",
+ "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": "contet on the right of header",
- "memberOf": ""
+ "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": "-- Depricated - use Invalid Text",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to display if {@link #validator} 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": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
}
],
"events": [
+ {
+ "name": "add",
+ "sig": "function (combo)\n{\n\n}",
+ "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}",
"type": "function",
"desc": "Fires before the component is hidden. Return false to stop the hide."
},
+ {
+ "name": "beforequery",
+ "sig": "function (combo, query, forceAll, cancel, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:"
+ },
{
"name": "beforerender",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires before the component is rendered. Return false to stop the render."
},
+ {
+ "name": "beforeselect",
+ "sig": "function (combo, record, index)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a list item is selected. Return false to cancel the selection."
+ },
{
"name": "beforeshow",
"sig": "function (_self)\n{\n\n}",
"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}",
},
{
"name": "collapse",
- "sig": "function (_self)\n{\n\n}",
+ "sig": "function (combo)\n{\n\n}",
"type": "function",
- "desc": "After the panel has been collapsed"
+ "desc": "Fires when the dropdown list is collapsed"
},
{
"name": "destroy",
"type": "function",
"desc": "Fires after the component is disabled."
},
+ {
+ "name": "edit",
+ "sig": "function (combo, record)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the 'edit' icon is pressed (add a listener to enable add button)"
+ },
{
"name": "enable",
"sig": "function (_self)\n{\n\n}",
},
{
"name": "expand",
+ "sig": "function (combo)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the dropdown list is expanded"
+ },
+ {
+ "name": "focus",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "After the panel has been expand"
+ "desc": "Fires when this field receives input focus."
},
{
"name": "hide",
"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": "remove",
+ "sig": "function (combo)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the remove value from the combobox array"
+ },
{
"name": "render",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is rendered."
},
+ {
+ "name": "select",
+ "sig": "function (combo, record, index)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a list item is selected"
+ },
{
"name": "show",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is shown."
+ },
+ {
+ "name": "specialfilter",
+ "sig": "function (combo)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when specialfilter"
+ },
+ {
+ "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": "tick",
+ "sig": "function (combo)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when tick the element"
+ },
+ {
+ "name": "touchviewdisplay",
+ "sig": "function (combo, cfg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when touch view require special display (default is using displayField)"
+ },
+ {
+ "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": "clearValue",
+ "sig": "()",
+ "type": "function",
+ "desc": "Clears any text/value currently set in the field"
+ },
+ {
+ "name": "collapse",
+ "sig": "()",
+ "type": "function",
+ "desc": "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion."
+ },
{
"name": "destroy",
"sig": "()",
"type": "function",
"desc": "Disable this component."
},
+ {
+ "name": "doQuery",
+ "sig": "(String query, Boolean forceAll)",
+ "type": "function",
+ "desc": "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed."
+ },
{
"name": "enable",
"sig": "()",
"type": "function",
"desc": "Enable this component."
},
+ {
+ "name": "expand",
+ "sig": "()",
+ "type": "function",
+ "desc": "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion."
+ },
{
"name": "fireEvent",
"sig": "(String eventName, Object... args)",
"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 currently selected field value or empty string if no value is set."
+ },
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"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": "isExpanded",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if the dropdown list is expanded, else false."
+ },
{
"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": "select",
+ "sig": "(Number index, Boolean scrollIntoView)",
+ "type": "function",
+ "desc": "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue."
+ },
+ {
+ "name": "selectByValue",
+ "sig": "(String value, Boolean scrollIntoView)",
+ "type": "function",
+ "desc": "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue."
+ },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
"type": "function",
"desc": "Convenience function for setting disabled/enabled by boolean."
},
+ {
+ "name": "setEditable",
+ "sig": "(Boolean value)",
+ "type": "function",
+ "desc": "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time."
+ },
+ {
+ "name": "setFromData",
+ "sig": "(Object value)",
+ "type": "function",
+ "desc": "Sets the value of the field based on a object which is related to the record format for the store."
+ },
+ {
+ "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": "(String value)",
+ "type": "function",
+ "desc": "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set)."
+ },
{
"name": "setVisible",
"sig": "(Boolean visible)",
"sig": "(String eventName, Function handler, Object scope)",
"type": "function",
"desc": "Removes a listener (shorthand for removeListener)"
- }
- ]
- },
- "Roo.bootstrap.DateField": {
- "props": [
- {
- "name": "weekStart",
- "type": "Number",
- "desc": "default 0",
- "memberOf": ""
- },
- {
- "name": "viewMode",
- "type": "String",
- "desc": "default empty, (months|years)",
- "memberOf": ""
- },
- {
- "name": "minViewMode",
- "type": "String",
- "desc": "default empty, (months|years)",
- "memberOf": ""
- },
- {
- "name": "startDate",
- "type": "Number",
- "desc": "default -Infinity",
- "memberOf": ""
- },
- {
- "name": "endDate",
- "type": "Number",
- "desc": "default Infinity",
- "memberOf": ""
- },
- {
- "name": "todayHighlight",
- "type": "Boolean",
- "desc": "default false",
- "memberOf": ""
- },
- {
- "name": "todayBtn",
- "type": "Boolean",
- "desc": "default false",
- "memberOf": ""
- },
- {
- "name": "calendarWeeks",
- "type": "Boolean",
- "desc": "default false",
- "memberOf": ""
},
{
- "name": "daysOfWeekDisabled",
- "type": "Object",
- "desc": "default empty",
- "memberOf": ""
- },
- {
- "name": "singleMode",
- "type": "Boolean",
- "desc": "default false (true | false)",
- "memberOf": ""
+ "name": "validate",
+ "sig": "()",
+ "type": "function",
+ "desc": "Validates the field value"
},
{
- "name": "keyboardNavigation",
- "type": "Boolean",
- "desc": "default true",
- "memberOf": ""
- },
+ "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.MonthField": {
+ "props": [
{
"name": "language",
"type": "String",
"desc": "default en",
"memberOf": ""
},
- {
- "name": "format",
- "type": "String",
- "desc": "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').",
- "memberOf": ""
- },
- {
- "name": "altFormats",
- "type": "String",
- "desc": "Multiple date formats separated by \"|\" to try when parsing a user input value and it doesn't match the defined\nformat (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d').",
- "memberOf": ""
- },
{
"name": "disabled",
"type": "Boolean",
"desc": "is it disabled",
"memberOf": "Roo.bootstrap.Input"
},
- {
- "name": "fieldLabel",
- "type": "String",
- "desc": "- the label associated",
- "memberOf": "Roo.bootstrap.Input"
- },
{
"name": "inputType",
"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",
{
"name": "labelWidth",
"type": "Number",
- "desc": "set the width of label (0-12)",
+ "desc": "set the width of label",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labellg",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelmd",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelsm",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelxs",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
"memberOf": "Roo.bootstrap.Input"
},
{
"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",
{
"name": "regexText",
"type": "String",
- "desc": "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "desc": "-- Depricated - use Invalid Text",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
"memberOf": "Roo.bootstrap.Input"
},
{
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
},
{
"name": "select",
- "sig": "function (_self, date)\n{\n\n}",
+ "sig": "function (_self, oldvalue, newvalue)\n{\n\n}",
"type": "function",
"desc": "Fires when select a date."
},
"type": "function",
"desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
}
]
},
- "Roo.bootstrap.DocumentManager": {
+ "Roo.bootstrap.NavGroup": {
"props": [
{
- "name": "paramName",
- "type": "String",
- "desc": "default 'imageUpload'",
- "memberOf": ""
- },
- {
- "name": "method",
- "type": "String",
- "desc": "default POST",
- "memberOf": ""
- },
- {
- "name": "url",
+ "name": "align",
"type": "String",
- "desc": "action url",
- "memberOf": ""
- },
- {
- "name": "boxes",
- "type": "Number",
- "desc": "number of boxes, 0 is no limit.. default 0",
- "memberOf": ""
+ "desc": "",
+ "memberOf": "",
+ "optvals": [
+ "left",
+ "right"
+ ]
},
{
- "name": "multiple",
+ "name": "inverse",
"type": "Boolean",
- "desc": "multiple upload default true",
- "memberOf": ""
- },
- {
- "name": "thumbSize",
- "type": "Number",
- "desc": "default 300",
- "memberOf": ""
- },
- {
- "name": "fieldLabel",
- "type": "String",
"desc": "",
"memberOf": ""
},
{
- "name": "labelWidth",
- "type": "Number",
- "desc": "default 4",
- "memberOf": ""
- },
- {
- "name": "labelAlign",
+ "name": "type",
"type": "String",
- "desc": "default left",
+ "desc": "default nav",
"memberOf": "",
"optvals": [
- "left",
- "top"
+ "nav",
+ "pills",
+ "tab"
]
},
{
- "name": "editable",
- "type": "Boolean",
- "desc": "allow edit when upload a image default true",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "name": "navId",
+ "type": "String",
+ "desc": "- reference Id for navbar.",
+ "memberOf": ""
},
{
"name": "cls",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
"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",
- "sig": "function (_self)\n{\n\n}",
+ "name": "changed",
+ "sig": "function (_self, selected, prev)\n{\n\n}",
"type": "function",
- "desc": "Fires before the component is shown. Return false to stop the show."
+ "desc": "Fires when the active item changes"
},
{
"name": "childrenrendered",
"type": "function",
"desc": "Fires when the children have been rendered.."
},
- {
- "name": "click",
- "sig": "function (_self, file)\n{\n\n}",
- "type": "function",
- "desc": "Fire after click the image"
- },
{
"name": "destroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is disabled."
},
- {
- "name": "edit",
- "sig": "function (_self, file)\n{\n\n}",
- "type": "function",
- "desc": "Fire when upload a image and editable set to true"
- },
{
"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 xhr load exception"
- },
{
"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 when initial the DocumentManager"
- },
- {
- "name": "inspect",
- "sig": "function (_self, file)\n{\n\n}",
- "type": "function",
- "desc": "inspect selected file"
- },
- {
- "name": "prepare",
- "sig": "function (_self, formData)\n{\n\n}",
- "type": "function",
- "desc": "prepare the form data"
- },
- {
- "name": "refresh",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fire after refresh the file"
- },
- {
- "name": "remove",
- "sig": "function (_self, file)\n{\n\n}",
- "type": "function",
- "desc": "Fire when remove the file"
- },
{
"name": "render",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Used to define events on this Observable"
},
+ {
+ "name": "addItem",
+ "sig": "(Roo.bootstrap.NavItem the)",
+ "type": "function",
+ "desc": "adds a Navigation item"
+ },
{
"name": "addListener",
"sig": "(String eventName, Function handler, Object scope, Object options)",
"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": "clearAll",
+ "sig": "()",
+ "type": "function",
+ "desc": "clear all the Navigation item"
+ },
{
"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"
+ },
+ {
+ "name": "getActive",
+ "sig": "()",
+ "type": "function",
+ "desc": "gets the active Navigation item"
+ },
{
"name": "getChildContainer",
"sig": "()",
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"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": "If this is a lazy rendering component, render it to its container element."
},
+ {
+ "name": "setActiveItem",
+ "sig": "(Roo.bootstrap.NavItem the)",
+ "type": "function",
+ "desc": "sets the active Navigation item"
+ },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
}
]
},
- "Roo.bootstrap.DocumentViewer": {
+ "Roo.bootstrap.NavHeaderbar": {
"props": [
+ {
+ "name": "brand",
+ "type": "String",
+ "desc": "what is brand",
+ "memberOf": ""
+ },
+ {
+ "name": "position",
+ "type": "String",
+ "desc": "position",
+ "memberOf": "",
+ "optvals": [
+ "fixed-top",
+ "fixed-bottom",
+ "static-top"
+ ]
+ },
+ {
+ "name": "brand_href",
+ "type": "String",
+ "desc": "href of the brand",
+ "memberOf": ""
+ },
+ {
+ "name": "srButton",
+ "type": "Boolean",
+ "desc": "generate the (screen reader / mobile) sr-only button default true",
+ "memberOf": ""
+ },
+ {
+ "name": "autohide",
+ "type": "Boolean",
+ "desc": "a top nav bar header that hides on scroll.",
+ "memberOf": ""
+ },
+ {
+ "name": "desktopCenter",
+ "type": "Boolean",
+ "desc": "should the header be centered on desktop using a container class",
+ "memberOf": ""
+ },
+ {
+ "name": "mobilerow",
+ "type": "Roo.bootstrap.Row",
+ "desc": "- a row to display on mobile only..",
+ "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",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
"desc": "Fires before the component is shown. Return false to stop the show."
},
{
- "name": "childrenrendered",
- "sig": "function (_self)\n{\n\n}",
+ "name": "beforetoggle",
+ "sig": "function (e)\n{\n\n}",
"type": "function",
- "desc": "Fires when the children have been rendered.."
+ "desc": "Fire before toggle the menu"
},
{
- "name": "click",
+ "name": "childrenrendered",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fire after click"
+ "desc": "Fires when the children have been rendered.."
},
{
"name": "destroy",
"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": [
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
}
]
},
- "Roo.bootstrap.Element": {
+ "Roo.bootstrap.NavItem": {
"props": [
+ {
+ "name": "href",
+ "type": "String",
+ "desc": "link to",
+ "memberOf": ""
+ },
{
"name": "html",
"type": "String",
- "desc": "contents of the element",
+ "desc": "content of button",
"memberOf": ""
},
{
- "name": "tag",
+ "name": "badge",
"type": "String",
- "desc": "tag of the element",
+ "desc": "text inside badge",
"memberOf": ""
},
{
- "name": "cls",
+ "name": "badgecls",
"type": "String",
- "desc": "class of the element",
+ "desc": "the extra classes for the badge",
+ "memberOf": "",
+ "optvals": [
+ "bg-green",
+ "bg-red",
+ "bg-yellow"
+ ]
+ },
+ {
+ "name": "glyphicon",
+ "type": "String",
+ "desc": "name of glyphicon",
+ "memberOf": ""
+ },
+ {
+ "name": "icon",
+ "type": "String",
+ "desc": "name of font awesome icon",
+ "memberOf": ""
+ },
+ {
+ "name": "active",
+ "type": "Boolean",
+ "desc": "Is item active",
+ "memberOf": ""
+ },
+ {
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "Is item disabled",
"memberOf": ""
},
{
]
},
{
- "name": "clickable",
+ "name": "tabId",
+ "type": "String",
+ "desc": "the tab that this item activates.",
+ "memberOf": ""
+ },
+ {
+ "name": "tagtype",
+ "type": "String",
+ "desc": "render as a href or span?",
+ "memberOf": "",
+ "optvals": [
+ "a",
+ "span"
+ ]
+ },
+ {
+ "name": "animateRef",
"type": "Boolean",
- "desc": "default false",
+ "desc": "link to element default false",
"memberOf": "",
"optvals": [
"true",
"false"
]
},
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
+ },
{
"name": "style",
"type": "String",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
"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 item active state changes"
+ },
{
"name": "childrenrendered",
"sig": "function (_self)\n{\n\n}",
},
{
"name": "click",
- "sig": "function (_self, e)\n{\n\n}",
+ "sig": "function (e)\n{\n\n}",
"type": "function",
- "desc": "When a element is chick"
+ "desc": "The raw click event for the entire grid."
},
{
"name": "destroy",
"type": "function",
"desc": "Fires after the component is rendered."
},
+ {
+ "name": "scrollto",
+ "sig": "function (_self, options, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when scroll to element"
+ },
{
"name": "show",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
}
]
},
- "Roo.bootstrap.Form": {
+ "Roo.bootstrap.NavProgressBar": {
"props": [
- {
- "name": "method",
- "type": "String",
- "desc": "GET | POST (default POST)",
- "memberOf": ""
- },
- {
- "name": "labelAlign",
- "type": "String",
- "desc": "top | left (default top)",
- "memberOf": ""
- },
- {
- "name": "align",
- "type": "String",
- "desc": "left | right - for navbars",
- "memberOf": ""
- },
- {
- "name": "loadMask",
- "type": "Boolean",
- "desc": "load mask when submit (default true)",
- "memberOf": ""
- },
- {
- "name": "url",
- "type": "String",
- "desc": "The URL to use for form actions if one isn't supplied in the action options.",
- "memberOf": ""
- },
- {
- "name": "fileUpload",
- "type": "Boolean",
- "desc": "Set to true if this form is a file upload.",
- "memberOf": ""
- },
- {
- "name": "baseParams",
- "type": "Object",
- "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": ""
- },
{
"name": "cls",
"type": "String",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
}
],
"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 before the component is shown. Return false to stop the show."
},
{
- "name": "childrenrendered",
- "sig": "function (_self)\n{\n\n}",
+ "name": "changed",
+ "sig": "function (_self, selected, prev)\n{\n\n}",
"type": "function",
- "desc": "Fires when the children have been rendered.."
+ "desc": "Fires when the active item changes"
},
{
- "name": "clientvalidation",
- "sig": "function (_self, valid)\n{\n\n}",
+ "name": "childrenrendered",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "If the monitorValid config option is true, this event fires repetitively to notify of valid state"
+ "desc": "Fires when the children have been rendered.."
},
{
"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": "()",
"desc": "Returns the id of this component."
},
{
- "name": "getValues",
- "sig": "(Boolean asString)",
+ "name": "getVisibilityEl",
+ "sig": "()",
"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."
+ "desc": "Get the element that will be used to show or hide"
},
{
"name": "hasListener",
"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.Graph": {
+ "Roo.bootstrap.NavProgressItem": {
"props": [
{
- "name": "graphtype",
+ "name": "rid",
"type": "String",
- "desc": "bar | vbar | pie",
- "memberOf": ""
- },
- {
- "name": "g_x",
- "type": "number",
- "desc": "coodinator | centre x (pie)",
+ "desc": "the reference id",
"memberOf": ""
},
{
- "name": "g_y",
- "type": "number",
- "desc": "coodinator | centre y (pie)",
- "memberOf": ""
+ "name": "active",
+ "type": "Boolean",
+ "desc": "Is item active default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
- "name": "g_r",
- "type": "number",
- "desc": "radius (pie)",
- "memberOf": ""
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "Is item active default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
- "name": "g_height",
- "type": "number",
- "desc": "height of the chart (respected by all elements in the set)",
+ "name": "html",
+ "type": "String",
+ "desc": "",
"memberOf": ""
},
{
- "name": "g_width",
- "type": "number",
- "desc": "width of the chart (respected by all elements in the set)",
- "memberOf": ""
+ "name": "position",
+ "type": "String",
+ "desc": "text position default bottom",
+ "memberOf": "",
+ "optvals": [
+ "top",
+ "bottom"
+ ]
},
{
- "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 }",
+ "name": "icon",
+ "type": "String",
+ "desc": "show icon instead of number",
"memberOf": ""
},
{
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
},
{
"name": "click",
- "sig": "function (e)\n{\n\n}",
+ "sig": "function (_self, e)\n{\n\n}",
"type": "function",
- "desc": "The img click event for the img."
+ "desc": "The raw click event for the entire grid."
},
{
"name": "destroy",
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
}
]
},
- "Roo.bootstrap.Header": {
+ "Roo.bootstrap.NavSidebar": {
"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",
"type": "String",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"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": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
}
]
},
- "Roo.bootstrap.HtmlEditor": {
+ "Roo.bootstrap.NavSidebarItem": {
"props": [
{
- "name": "toolbars",
- "type": "Array",
- "desc": "Array of toolbars. - defaults to just the Standard one",
- "memberOf": ""
- },
- {
- "name": "resizable",
+ "name": "href",
"type": "String",
- "desc": "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.",
- "memberOf": ""
- },
- {
- "name": "height",
- "type": "Number",
- "desc": "(in pixels)",
- "memberOf": ""
- },
- {
- "name": "width",
- "type": "Number",
- "desc": "(in pixels)",
- "memberOf": ""
- },
- {
- "name": "stylesheets",
- "type": "Array",
- "desc": "url of stylesheets. set to [] to disable stylesheets.",
- "memberOf": ""
- },
- {
- "name": "cols",
- "type": "Number",
- "desc": "Specifies the visible width of a text area",
- "memberOf": "Roo.bootstrap.TextArea"
- },
- {
- "name": "rows",
- "type": "Number",
- "desc": "Specifies the visible number of lines in a text area",
- "memberOf": "Roo.bootstrap.TextArea"
- },
- {
- "name": "wrap",
- "type": "string",
- "desc": "Specifies how the text in a text area is to be wrapped when submitted in a form",
- "memberOf": "Roo.bootstrap.TextArea",
- "optvals": [
- "soft",
- "hard"
- ]
- },
- {
- "name": "resize",
- "type": "string",
- "desc": "",
- "memberOf": "Roo.bootstrap.TextArea",
- "optvals": [
- "none",
- "both",
- "horizontal",
- "vertical",
- "inherit",
- "initial"
- ]
+ "desc": "link to",
+ "memberOf": "Roo.bootstrap.NavItem"
},
{
"name": "html",
- "type": "string",
- "desc": "text",
- "memberOf": "Roo.bootstrap.TextArea"
- },
- {
- "name": "disabled",
- "type": "Boolean",
- "desc": "is it disabled",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "fieldLabel",
"type": "String",
- "desc": "- the label associated",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "content of button",
+ "memberOf": "Roo.bootstrap.NavItem"
},
{
- "name": "name",
+ "name": "badge",
"type": "String",
- "desc": "name of the input",
- "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": "text inside badge",
+ "memberOf": "Roo.bootstrap.NavItem"
},
{
- "name": "labelAlign",
+ "name": "badgecls",
"type": "String",
- "desc": "",
- "memberOf": "Roo.bootstrap.Input",
+ "desc": "the extra classes for the badge",
+ "memberOf": "Roo.bootstrap.NavItem",
"optvals": [
- "top",
- "left"
+ "bg-green",
+ "bg-red",
+ "bg-yellow"
]
},
{
- "name": "readOnly",
- "type": "Boolean",
- "desc": "Specifies that the field should be read-only",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "autocomplete",
+ "name": "glyphicon",
"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": "name of glyphicon",
+ "memberOf": "Roo.bootstrap.NavItem"
},
{
- "name": "align",
+ "name": "icon",
"type": "String",
- "desc": "Default left",
- "memberOf": "Roo.bootstrap.Input",
- "optvals": [
- "left",
- "center",
- "right"
- ]
+ "desc": "name of font awesome icon",
+ "memberOf": "Roo.bootstrap.NavItem"
},
{
- "name": "forceFeedback",
+ "name": "active",
"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": "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"
+ "desc": "Is item active",
+ "memberOf": "Roo.bootstrap.NavItem"
},
{
- "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": "disabled",
+ "type": "Boolean",
+ "desc": "Is item disabled",
+ "memberOf": "Roo.bootstrap.NavItem"
},
{
- "name": "hasFeedback",
+ "name": "preventDefault",
"type": "Boolean",
- "desc": "default true",
- "memberOf": "Roo.bootstrap.Input",
+ "desc": "default false",
+ "memberOf": "Roo.bootstrap.NavItem",
"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",
+ "name": "tabId",
"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"
+ "desc": "the tab that this item activates.",
+ "memberOf": "Roo.bootstrap.NavItem"
},
{
- "name": "vtype",
+ "name": "tagtype",
"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": "render as a href or span?",
+ "memberOf": "Roo.bootstrap.NavItem",
+ "optvals": [
+ "a",
+ "span"
+ ]
},
{
- "name": "allowBlank",
+ "name": "animateRef",
"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": "link to element default false",
+ "memberOf": "Roo.bootstrap.NavItem",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
"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": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
}
],
"events": [
- {
- "name": "activate",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event."
- },
- {
- "name": "autosave",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Auto save the htmlEditor value as a file into Events"
- },
{
"name": "beforedestroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires before the component is hidden. Return false to stop the hide."
},
- {
- "name": "beforepush",
- "sig": "function (_self, html)\n{\n\n}",
- "type": "function",
- "desc": "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push."
- },
{
"name": "beforerender",
"sig": "function (_self)\n{\n\n}",
"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": "beforesync",
- "sig": "function (_self, html)\n{\n\n}",
- "type": "function",
- "desc": "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync."
- },
- {
- "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": "editmodechange",
- "sig": "function (_self, sourceEdit)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the editor switches edit modes"
- },
- {
- "name": "editorevent",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks."
- },
- {
- "name": "enable",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is enabled."
- },
- {
- "name": "firstfocus",
+ "name": "beforeshow",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when on first focus - needed by toolbars.."
+ "desc": "Fires before the component is shown. Return false to stop the show."
},
{
- "name": "hide",
- "sig": "function (_self)\n{\n\n}",
+ "name": "changed",
+ "sig": "function (_self, state)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is hidden."
+ "desc": "Fires when the active item active state changes"
},
{
- "name": "initialize",
+ "name": "childrenrendered",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the editor is fully initialized (including the iframe)"
+ "desc": "Fires when the children have been rendered.."
},
{
- "name": "invalid",
- "sig": "function (_self, msg)\n{\n\n}",
+ "name": "click",
+ "sig": "function (e)\n{\n\n}",
"type": "function",
- "desc": "Fires after the field has been marked as invalid."
+ "desc": "The raw click event for the entire grid."
},
{
- "name": "keyup",
- "sig": "function (_self, e)\n{\n\n}",
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the key up"
+ "desc": "Fires after the component is destroyed."
},
{
- "name": "push",
- "sig": "function (_self, html)\n{\n\n}",
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the iframe editor is updated with content from the textarea."
+ "desc": "Fires after the component is disabled."
},
{
- "name": "render",
+ "name": "enable",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is rendered."
+ "desc": "Fires after the component is enabled."
},
{
- "name": "savedpreview",
+ "name": "hide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "preview the saved version of htmlEditor"
+ "desc": "Fires after the component is hidden."
},
{
- "name": "show",
+ "name": "render",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is shown."
+ "desc": "Fires after the component is rendered."
},
{
- "name": "sync",
- "sig": "function (_self, html)\n{\n\n}",
+ "name": "scrollto",
+ "sig": "function (_self, options, e)\n{\n\n}",
"type": "function",
- "desc": "Fires when the textarea is updated with content from the editor iframe."
+ "desc": "Fires when scroll to element"
},
{
- "name": "valid",
+ "name": "show",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the field has been validated with no errors."
+ "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": "createToolbar",
- "sig": "(HtmlEditor editor)",
- "type": "function",
- "desc": "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons."
- },
{
"name": "destroy",
"sig": "()",
"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",
+ "name": "getVisibilityEl",
"sig": "()",
"type": "function",
- "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
+ "desc": "Get the element that will be used to show or hide"
},
{
"name": "hasListener",
"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)",
"type": "function",
"desc": "Show a component - removes 'hidden' class"
},
- {
- "name": "toggleSourceEdit",
- "sig": "(Boolean sourceEdit)",
- "type": "function",
- "desc": "Toggles the editor between standard and source edit mode."
- },
{
"name": "tooltipEl",
"sig": "()",
"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.Img": {
+ "Roo.bootstrap.NavSimplebar": {
"props": [
{
- "name": "imgResponsive",
+ "name": "inverse",
"type": "Boolean",
- "desc": "false | true",
- "memberOf": ""
- },
- {
- "name": "border",
- "type": "String",
- "desc": "rounded | circle | thumbnail",
- "memberOf": ""
- },
- {
- "name": "src",
- "type": "String",
- "desc": "image source",
+ "desc": "is inverted color",
"memberOf": ""
},
{
- "name": "alt",
+ "name": "type",
"type": "String",
- "desc": "image alternative text",
- "memberOf": ""
+ "desc": "",
+ "memberOf": "",
+ "optvals": [
+ "nav",
+ "pills",
+ "tabs"
+ ]
},
{
- "name": "href",
- "type": "String",
- "desc": "a tag href",
+ "name": "arrangement",
+ "type": "Boolean",
+ "desc": "stacked | justified",
"memberOf": ""
},
{
- "name": "target",
+ "name": "align",
"type": "String",
- "desc": "target for a href.",
+ "desc": "alignment",
"memberOf": "",
"optvals": [
- "_self",
- "_blank",
- "_parent",
- "_top"
+ "left",
+ "right"
]
},
{
- "name": "xsUrl",
- "type": "String",
- "desc": "xs image source",
- "memberOf": ""
- },
- {
- "name": "smUrl",
- "type": "String",
- "desc": "sm image source",
- "memberOf": ""
+ "name": "main",
+ "type": "Boolean",
+ "desc": "main nav bar? default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
- "name": "mdUrl",
- "type": "String",
- "desc": "md image source",
- "memberOf": ""
+ "name": "loadMask",
+ "type": "Boolean",
+ "desc": "loadMask on the bar",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
- "name": "lgUrl",
+ "name": "tag",
"type": "String",
- "desc": "lg image source",
- "memberOf": ""
+ "desc": "default is nav",
+ "memberOf": "",
+ "optvals": [
+ "header",
+ "footer",
+ "nav",
+ "div"
+ ]
},
{
"name": "cls",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
"desc": "Fires before the component is shown. Return false to stop the show."
},
{
- "name": "childrenrendered",
- "sig": "function (_self)\n{\n\n}",
+ "name": "beforetoggle",
+ "sig": "function (e)\n{\n\n}",
"type": "function",
- "desc": "Fires when the children have been rendered.."
+ "desc": "Fire before toggle the menu"
},
{
- "name": "click",
- "sig": "function (e)\n{\n\n}",
+ "name": "childrenrendered",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "The img click event for the img."
+ "desc": "Fires when the children have been rendered.."
},
{
"name": "destroy",
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"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.Input": {
- "props": [
- {
- "name": "disabled",
- "type": "Boolean",
- "desc": "is it disabled",
- "memberOf": ""
- },
- {
- "name": "fieldLabel",
- "type": "String",
- "desc": "- the label associated",
- "memberOf": ""
- },
- {
- "name": "inputType",
- "type": "String",
- "desc": "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
- "memberOf": ""
- },
- {
- "name": "name",
- "type": "String",
- "desc": "name of the input",
- "memberOf": ""
- },
- {
- "name": "placeholder",
- "type": "string",
- "desc": "- placeholder to put in text.",
- "memberOf": ""
- },
- {
- "name": "before",
- "type": "string",
- "desc": "- input group add on before",
- "memberOf": ""
- },
- {
- "name": "after",
- "type": "string",
- "desc": "- input group add on after",
- "memberOf": ""
- },
- {
- "name": "size",
- "type": "string",
- "desc": "- (lg|sm) or leave empty..",
- "memberOf": ""
- },
- {
- "name": "xs",
- "type": "Number",
- "desc": "colspan out of 12 for mobile-sized screens",
- "memberOf": ""
- },
- {
- "name": "sm",
- "type": "Number",
- "desc": "colspan out of 12 for tablet-sized screens",
- "memberOf": ""
- },
- {
- "name": "md",
- "type": "Number",
- "desc": "colspan out of 12 for computer-sized screens",
- "memberOf": ""
- },
- {
- "name": "lg",
- "type": "Number",
- "desc": "colspan out of 12 for large computer-sized screens",
- "memberOf": ""
- },
- {
- "name": "value",
- "type": "string",
- "desc": "default value of the input",
- "memberOf": ""
- },
- {
- "name": "labelWidth",
- "type": "Number",
- "desc": "set the width of label (0-12)",
- "memberOf": ""
- },
- {
- "name": "labelAlign",
- "type": "String",
- "desc": "",
- "memberOf": "",
- "optvals": [
- "top",
- "left"
- ]
- },
- {
- "name": "readOnly",
- "type": "Boolean",
- "desc": "Specifies that the field should be read-only",
- "memberOf": ""
- },
- {
- "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": ""
- },
- {
- "name": "align",
- "type": "String",
- "desc": "Default left",
- "memberOf": "",
- "optvals": [
- "left",
- "center",
- "right"
- ]
- },
- {
- "name": "forceFeedback",
- "type": "Boolean",
- "desc": "Default false",
- "memberOf": "",
- "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": ""
- },
- {
- "name": "validateOnBlur",
- "type": "Boolean",
- "desc": "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf": ""
- },
- {
- "name": "validationDelay",
- "type": "Number",
- "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf": ""
- },
- {
- "name": "focusClass",
- "type": "String",
- "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf": ""
- },
- {
- "name": "invalidClass",
- "type": "String",
- "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf": ""
- },
- {
- "name": "validClass",
- "type": "String",
- "desc": "The CSS class to use when marking a field valid (defaults to \"x-form-invalid\")",
- "memberOf": ""
- },
- {
- "name": "hasFeedback",
- "type": "Boolean",
- "desc": "default true",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
- },
- {
- "name": "invalidFeedbackIcon",
- "type": "String",
- "desc": "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf": ""
- },
- {
- "name": "validFeedbackIcon",
- "type": "String",
- "desc": "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf": ""
- },
- {
- "name": "selectOnFocus",
- "type": "Boolean",
- "desc": "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "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": ""
- },
- {
- "name": "vtype",
- "type": "String",
- "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf": ""
- },
- {
- "name": "disableKeyFilter",
- "type": "Boolean",
- "desc": "True to disable input keystroke filtering (defaults to false)",
- "memberOf": ""
- },
- {
- "name": "allowBlank",
- "type": "Boolean",
- "desc": "False to validate that the value length > 0 (defaults to true)",
- "memberOf": ""
- },
- {
- "name": "blankText",
- "type": "String",
- "desc": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf": ""
- },
- {
- "name": "minLength",
- "type": "Number",
- "desc": "Minimum input field length required (defaults to 0)",
- "memberOf": ""
- },
- {
- "name": "maxLength",
- "type": "Number",
- "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf": ""
- },
- {
- "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": ""
- },
- {
- "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": ""
- },
- {
- "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": ""
- },
- {
- "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": ""
- },
- {
- "name": "regexText",
- "type": "String",
- "desc": "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf": ""
+ "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": "cutomer id",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "name",
+ "type": "string",
+ "desc": "Specifies name attribute",
+ "memberOf": "Roo.bootstrap.Component"
+ },
{
"name": "tooltip",
"type": "string",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
"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}",
+ "name": "beforetoggle",
+ "sig": "function (e)\n{\n\n}",
"type": "function",
- "desc": "Fires just before the field blurs if the field value has changed."
+ "desc": "Fire before toggle the menu"
},
{
"name": "childrenrendered",
"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": "()",
"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",
+ "name": "getVisibilityEl",
"sig": "()",
"type": "function",
- "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
+ "desc": "Get the element that will be used to show or hide"
},
{
"name": "hasListener",
"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.LayoutMasonry": {
+ "Roo.bootstrap.NumberField": {
"props": [
{
- "name": "isFitWidth",
+ "name": "allowDecimals",
"type": "Boolean",
- "desc": "- resize the width..",
+ "desc": "False to disallow decimal values (defaults to true)",
"memberOf": ""
},
{
- "name": "isOriginLeft",
- "type": "Boolean",
- "desc": "= left align?",
+ "name": "decimalSeparator",
+ "type": "String",
+ "desc": "Character(s) to allow as the decimal separator (defaults to '.')",
"memberOf": ""
},
{
- "name": "isOriginTop",
- "type": "Boolean",
- "desc": "= top align?",
+ "name": "decimalPrecision",
+ "type": "Number",
+ "desc": "The maximum precision to display after the decimal separator (defaults to 2)",
"memberOf": ""
},
{
- "name": "isLayoutInstant",
+ "name": "allowNegative",
"type": "Boolean",
- "desc": "= no animation?",
+ "desc": "False to prevent entering a negative sign (defaults to true)",
"memberOf": ""
},
{
- "name": "isResizingContainer",
+ "name": "allowZero",
"type": "Boolean",
- "desc": "= not sure if this is used..",
+ "desc": "False to blank out if the user enters '0' (defaults to true)",
"memberOf": ""
},
{
- "name": "columnWidth",
+ "name": "minValue",
"type": "Number",
- "desc": "width of the columns",
+ "desc": "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
"memberOf": ""
},
{
- "name": "padHeight",
+ "name": "maxValue",
"type": "Number",
- "desc": "padding below box..",
+ "desc": "The maximum allowed value (defaults to Number.MAX_VALUE)",
"memberOf": ""
},
{
- "name": "isAutoInitial",
+ "name": "minText",
+ "type": "String",
+ "desc": "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")",
+ "memberOf": ""
+ },
+ {
+ "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": "defalut true",
+ "desc": "cast int if true (defalut true)",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "thousandsDelimiter",
+ "type": "String",
+ "desc": "Symbol of thousandsDelimiter",
+ "memberOf": ""
+ },
+ {
+ "name": "valueAlign",
+ "type": "String",
+ "desc": "alignment of value",
"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"
+ },
+ {
+ "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",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labellg",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelmd",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelsm",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelxs",
+ "type": "Number",
+ "desc": "set the width of label (1-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": "-- Depricated - use Invalid Text",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf": "Roo.bootstrap.Input"
+ },
{
"name": "cls",
"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": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"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}",
"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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"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)"
- }
- ]
- },
- "Roo.bootstrap.Link": {
- "props": [
- {
- "name": "alt",
- "type": "String",
- "desc": "image alternative text",
- "memberOf": ""
},
{
- "name": "href",
- "type": "String",
- "desc": "a tag href",
- "memberOf": ""
- },
- {
- "name": "target",
- "type": "String",
- "desc": "target for a href.",
- "memberOf": "",
- "optvals": [
- "_self",
- "_blank",
- "_parent",
- "_top"
- ]
+ "name": "validate",
+ "sig": "()",
+ "type": "function",
+ "desc": "Validates the field value"
},
{
- "name": "html",
- "type": "String",
- "desc": "the content of the link.",
- "memberOf": ""
- },
+ "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.Pagination": {
+ "props": [
{
- "name": "anchor",
+ "name": "size",
"type": "String",
- "desc": "name for the anchor link",
+ "desc": "xs | sm | md | lg",
"memberOf": ""
},
{
- "name": "preventDefault",
+ "name": "inverse",
"type": "Boolean",
- "desc": "default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "desc": "false | true",
+ "memberOf": ""
},
{
"name": "cls",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
"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": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
}
]
},
- "Roo.bootstrap.LocationPicker": {
+ "Roo.bootstrap.PaginationItem": {
"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": "html",
"type": "String",
- "desc": "default google.maps.MapTypeId.ROADMAP",
- "memberOf": ""
- },
- {
- "name": "mapTypeControl",
- "type": "Boolean",
- "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",
+ "desc": "text",
"memberOf": ""
},
{
- "name": "locationName",
+ "name": "href",
"type": "String",
- "desc": "",
+ "desc": "the link",
"memberOf": ""
},
{
- "name": "draggable",
+ "name": "preventDefault",
"type": "Boolean",
"desc": "default true",
- "memberOf": ""
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
- "name": "enableAutocomplete",
+ "name": "active",
"type": "Boolean",
"desc": "default false",
- "memberOf": ""
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
- "name": "enableReverseGeocode",
+ "name": "disabled",
"type": "Boolean",
- "desc": "default true",
- "memberOf": ""
- },
- {
- "name": "markerTitle",
- "type": "String",
- "desc": "",
+ "desc": "default false",
"memberOf": ""
},
{
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
}
],
"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 raw click event for the entire grid."
+ },
{
"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": "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": [
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
}
]
},
- "Roo.bootstrap.Menu": {
+ "Roo.bootstrap.PagingToolbar": {
"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",
+ "memberOf": ""
+ },
+ {
+ "name": "displayInfo",
+ "type": "Boolean",
+ "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": "type of menu",
- "memberOf": "",
+ "desc": "",
+ "memberOf": "Roo.bootstrap.NavSimplebar",
"optvals": [
- "dropdown",
- "treeview",
- "submenu"
+ "nav",
+ "pills",
+ "tabs"
]
},
{
- "name": "registerMenu",
+ "name": "arrangement",
"type": "Boolean",
- "desc": "True (default) - means that clicking on screen etc. hides it.",
- "memberOf": ""
+ "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",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"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",
- "sig": "function (_self)\n{\n\n}",
+ "name": "beforetoggle",
+ "sig": "function (e)\n{\n\n}",
"type": "function",
- "desc": "Fires when the children have been rendered.."
+ "desc": "Fire before toggle the menu"
},
{
- "name": "click",
- "sig": "function (_self, menuItem, e)\n{\n\n}",
+ "name": "childrenrendered",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when this menu is clicked (or when the enter key is pressed while it is active)"
+ "desc": "Fires when the children have been rendered.."
},
{
"name": "destroy",
"name": "hide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "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"
+ "desc": "Fires after the component is hidden."
},
{
"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": [
"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)",
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
},
{
"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",
"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.MenuItem": {
+ "Roo.bootstrap.PhoneInput": {
"props": [
{
- "name": "html",
+ "name": "defaultDialCode",
"type": "String",
- "desc": "the menu label",
+ "desc": "default '+852'",
"memberOf": ""
},
{
- "name": "href",
- "type": "String",
- "desc": "the link",
+ "name": "preferedCountries",
+ "type": "Array",
+ "desc": "default []",
"memberOf": ""
},
{
- "name": "preventDefault",
- "type": "Boolean",
- "desc": "default true",
- "memberOf": "",
+ "name": "triggerClass",
+ "type": "String",
+ "desc": "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
+ "memberOf": "Roo.bootstrap.TriggerField"
+ },
+ {
+ "name": "caret",
+ "type": "String",
+ "desc": "a fontawesome for the trigger icon see http://fortawesome.github.io/Font-Awesome/icons/",
+ "memberOf": "Roo.bootstrap.TriggerField",
"optvals": [
- "true",
- "false"
+ "search",
+ "calendar"
]
},
{
- "name": "isContainer",
+ "name": "hideTrigger",
"type": "Boolean",
- "desc": "default false",
- "memberOf": "",
+ "desc": "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf": "Roo.bootstrap.TriggerField"
+ },
+ {
+ "name": "removable",
+ "type": "Boolean",
+ "desc": "special filter default false",
+ "memberOf": "Roo.bootstrap.TriggerField",
"optvals": [
"true",
"false"
]
},
{
- "name": "cls",
- "type": "String",
- "desc": "css class",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "is it disabled",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "style",
+ "name": "inputType",
"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"
+ "desc": "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "can_build_overlaid",
- "type": "Boolean",
- "desc": "True if element can be rebuild from a HTML page",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "name",
+ "type": "String",
+ "desc": "name of the input",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "dataId",
+ "name": "fieldLabel",
"type": "string",
- "desc": "cutomer id",
- "memberOf": "Roo.bootstrap.Component"
+ "desc": "- the label associated",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "name",
+ "name": "placeholder",
"type": "string",
- "desc": "Specifies name attribute",
- "memberOf": "Roo.bootstrap.Component"
+ "desc": "- placeholder to put in text.",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "tooltip",
+ "name": "before",
"type": "string",
- "desc": "Text for the tooltip",
- "memberOf": "Roo.bootstrap.Component"
+ "desc": "- input group add on before",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "container_method",
+ "name": "after",
"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"
- ]
+ "desc": "- input group add on after",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "actionMode",
- "type": "String",
- "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
- "memberOf": "Roo.Component"
+ "name": "size",
+ "type": "string",
+ "desc": "- (lg|sm) or leave empty..",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "listeners",
- "type": "Object",
- "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf": "Roo.util.Observable"
- }
- ],
- "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": "xs",
+ "type": "Number",
+ "desc": "colspan out of 12 for mobile-sized screens",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "beforehide",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires before the component is hidden. Return false to stop the hide."
+ "name": "sm",
+ "type": "Number",
+ "desc": "colspan out of 12 for tablet-sized screens",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "beforerender",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires before the component is rendered. Return false to stop the render."
+ "name": "md",
+ "type": "Number",
+ "desc": "colspan out of 12 for computer-sized screens",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "beforeshow",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires before the component is shown. Return false to stop the show."
+ "name": "lg",
+ "type": "Number",
+ "desc": "colspan out of 12 for large computer-sized screens",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "childrenrendered",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the children have been rendered.."
+ "name": "value",
+ "type": "string",
+ "desc": "default value of the input",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "click",
- "sig": "function (_self, e)\n{\n\n}",
- "type": "function",
- "desc": "The raw click event for the entire grid."
+ "name": "labelWidth",
+ "type": "Number",
+ "desc": "set the width of label",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "destroy",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is destroyed."
+ "name": "labellg",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "disable",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is disabled."
+ "name": "labelmd",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "enable",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is enabled."
+ "name": "labelsm",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "hide",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is hidden."
+ "name": "labelxs",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "render",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is rendered."
+ "name": "labelAlign",
+ "type": "String",
+ "desc": "",
+ "memberOf": "Roo.bootstrap.Input",
+ "optvals": [
+ "top",
+ "left"
+ ]
},
{
- "name": "show",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is shown."
- }
- ],
- "methods": [
+ "name": "readOnly",
+ "type": "Boolean",
+ "desc": "Specifies that the field should be read-only",
+ "memberOf": "Roo.bootstrap.Input"
+ },
{
- "name": "addEvents",
- "sig": "(Object object)",
- "type": "function",
- "desc": "Used to define events on this Observable"
+ "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": "addListener",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
- "type": "function",
- "desc": "Appends an event handler to this component"
+ "name": "indicatorpos",
+ "type": "String",
+ "desc": "default left",
+ "memberOf": "Roo.bootstrap.Input",
+ "optvals": [
+ "left",
+ "right"
+ ]
},
{
- "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": "align",
+ "type": "String",
+ "desc": "Default left",
+ "memberOf": "Roo.bootstrap.Input",
+ "optvals": [
+ "left",
+ "center",
+ "right"
+ ]
},
{
- "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": "forceFeedback",
+ "type": "Boolean",
+ "desc": "Default false",
+ "memberOf": "Roo.bootstrap.Input",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
- "name": "disable",
- "sig": "()",
- "type": "function",
- "desc": "Disable this component."
+ "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": "enable",
- "sig": "()",
- "type": "function",
- "desc": "Enable this component."
+ "name": "validateOnBlur",
+ "type": "Boolean",
+ "desc": "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "fireEvent",
- "sig": "(String eventName, Object... args)",
- "type": "function",
- "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ "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": "focus",
- "sig": "(Boolean selectText)",
- "type": "function",
- "desc": "Try to focus this component."
+ "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": "getChildContainer",
- "sig": "()",
- "type": "function",
- "desc": "Fetch the element to add children to"
+ "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": "getEl",
- "sig": "()",
- "type": "function",
- "desc": "Returns the underlying {@link Roo.Element}."
+ "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": "getId",
- "sig": "()",
- "type": "function",
- "desc": "Returns the id of this component."
+ "name": "hasFeedback",
+ "type": "Boolean",
+ "desc": "default true",
+ "memberOf": "Roo.bootstrap.Input",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
- "name": "hasListener",
- "sig": "(String eventName)",
- "type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
+ "name": "invalidFeedbackIcon",
+ "type": "String",
+ "desc": "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "hide",
- "sig": "()",
- "type": "function",
- "desc": "Hide a component - adds 'hidden' class"
+ "name": "validFeedbackIcon",
+ "type": "String",
+ "desc": "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "initEvents",
- "sig": "()",
- "type": "function",
- "desc": "Initialize Events for the element"
+ "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": "isVisible",
- "sig": "()",
- "type": "function",
- "desc": "Returns true if this component is visible."
+ "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": "on",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
- "type": "function",
- "desc": "Appends an event handler to this element (shorthand for addListener)"
+ "name": "vtype",
+ "type": "String",
+ "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "purgeListeners",
- "sig": "()",
- "type": "function",
- "desc": "Removes all listeners for this object"
+ "name": "disableKeyFilter",
+ "type": "Boolean",
+ "desc": "True to disable input keystroke filtering (defaults to false)",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "releaseCapture",
- "sig": "(Observable o)",
- "type": "function",
- "desc": "Removes <b>all</b> added captures from the Observable."
+ "name": "allowBlank",
+ "type": "Boolean",
+ "desc": "False to validate that the value length > 0 (defaults to true)",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "removeListener",
- "sig": "(String eventName, Function handler, Object scope)",
- "type": "function",
- "desc": "Removes a listener"
+ "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": "render",
- "sig": "(String/HTMLElement/Element container)",
- "type": "function",
- "desc": "If this is a lazy rendering component, render it to its container element."
+ "name": "minLength",
+ "type": "Number",
+ "desc": "Minimum input field length required (defaults to 0)",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "setDisabled",
- "sig": "(Boolean disabled)",
- "type": "function",
- "desc": "Convenience function for setting disabled/enabled by boolean."
+ "name": "maxLength",
+ "type": "Number",
+ "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "setVisible",
- "sig": "(Boolean visible)",
- "type": "function",
- "desc": "Convenience function to hide or show this component by boolean."
+ "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": "show",
- "sig": "()",
- "type": "function",
- "desc": "Show a component - removes 'hidden' class"
+ "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": "tooltipEl",
- "sig": "()",
- "type": "function",
- "desc": "Fetch the element to display the tooltip on."
+ "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": "un",
- "sig": "(String eventName, Function handler, Object scope)",
- "type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
- }
- ]
- },
- "Roo.bootstrap.MenuMgr": {
- "props": [],
- "events": [],
- "methods": [
+ "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": "get",
- "sig": "(String/Object menu)",
- "type": "function",
- "desc": "Returns a {@link Roo.menu.Menu} object"
+ "name": "regexText",
+ "type": "String",
+ "desc": "-- Depricated - use Invalid Text",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "hideAll",
- "sig": "()",
- "type": "function",
- "desc": "Hides all menus that are currently visible"
- }
- ]
- },
- "Roo.bootstrap.MenuSeparator": {
- "props": [
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf": "Roo.bootstrap.Input"
+ },
{
"name": "cls",
"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": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"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}",
"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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"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.MessageBar": {
+ "Roo.bootstrap.Popover": {
"props": [
{
"name": "html",
"type": "String",
- "desc": "contents of the MessageBar",
+ "desc": "contents of the popover (or false to use children..)",
"memberOf": ""
},
{
- "name": "weight",
+ "name": "title",
"type": "String",
- "desc": "default info",
- "memberOf": "",
- "optvals": [
- "info",
- "success",
- "warning",
- "danger"
- ]
+ "desc": "of popover (or false to hide)",
+ "memberOf": ""
},
{
- "name": "beforeClass",
+ "name": "placement",
"type": "String",
- "desc": "insert the bar before the given class",
+ "desc": "how it is placed",
"memberOf": ""
},
{
- "name": "closable",
- "type": "Boolean",
- "desc": "default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "name": "trigger",
+ "type": "String",
+ "desc": "click || hover (or false to trigger manually)",
+ "memberOf": ""
},
{
- "name": "fixed",
- "type": "Boolean",
- "desc": "default false, fix the bar at the top",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "name": "over",
+ "type": "String",
+ "desc": "what (parent or false to trigger manually.)",
+ "memberOf": ""
+ },
+ {
+ "name": "delay",
+ "type": "Number",
+ "desc": "- delay before showing",
+ "memberOf": ""
},
{
"name": "cls",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
"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": [
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
}
]
},
- "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": {
+ "Roo.bootstrap.Progress": {
"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",
+ "name": "striped",
"type": "Boolean",
- "desc": "default true",
+ "desc": "striped of the progress bar",
"memberOf": ""
},
{
- "name": "allow_close",
+ "name": "active",
"type": "Boolean",
- "desc": "default true",
+ "desc": "animated of the progress bar",
"memberOf": ""
},
{
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
"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": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"type": "function",
"desc": "If this is a lazy rendering component, render it to its container element."
},
- {
- "name": "setBody",
- "sig": "(String str)",
- "type": "function",
- "desc": "Set the body of the Dialog"
- },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
"type": "function",
"desc": "Convenience function for setting disabled/enabled by boolean."
},
- {
- "name": "setTitle",
- "sig": "(String str)",
- "type": "function",
- "desc": "Set the title of the Dialog"
- },
{
"name": "setVisible",
"sig": "(Boolean visible)",
}
]
},
- "Roo.bootstrap.MonthField": {
+ "Roo.bootstrap.ProgressBar": {
"props": [
{
- "name": "language",
- "type": "String",
- "desc": "default en",
- "memberOf": ""
- },
- {
- "name": "disabled",
- "type": "Boolean",
- "desc": "is it disabled",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "fieldLabel",
- "type": "String",
- "desc": "- the label associated",
- "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": "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",
+ "name": "aria_valuenow",
"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"
+ "desc": "aria-value now",
+ "memberOf": ""
},
{
- "name": "labelWidth",
+ "name": "aria_valuemin",
"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"
+ "desc": "aria-value min",
+ "memberOf": ""
},
{
- "name": "validationDelay",
+ "name": "aria_valuemax",
"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"
+ "desc": "aria-value max",
+ "memberOf": ""
},
{
- "name": "invalidClass",
+ "name": "label",
"type": "String",
- "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "label for the progress bar",
+ "memberOf": ""
},
{
- "name": "validClass",
+ "name": "panel",
"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",
+ "desc": "",
+ "memberOf": "",
"optvals": [
- "true",
- "false"
+ "success",
+ "info",
+ "warning",
+ "danger"
]
},
{
- "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",
+ "name": "role",
"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": "role of the progress bar",
+ "memberOf": ""
},
{
- "name": "regexText",
+ "name": "sr_only",
"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": "text",
+ "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",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"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}",
"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}",
"type": "function",
"desc": "Fires after the component is rendered."
},
- {
- "name": "select",
- "sig": "function (_self, oldvalue, newvalue)\n{\n\n}",
- "type": "function",
- "desc": "Fires when select a date."
- },
{
"name": "show",
- "sig": "function (_self, date)\n{\n\n}",
- "type": "function",
- "desc": "Fires when this field show."
- },
- {
- "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."
+ "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": "()",
"name": "getId",
"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}."
+ "desc": "Returns the id of this component."
},
{
- "name": "getValue",
+ "name": "getVisibilityEl",
"sig": "()",
"type": "function",
- "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
+ "desc": "Get the element that will be used to show or hide"
},
{
"name": "hasListener",
"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.NavGroup": {
+ "Roo.bootstrap.Radio": {
"props": [
{
- "name": "align",
+ "name": "boxLabel",
"type": "String",
- "desc": "",
- "memberOf": "",
- "optvals": [
- "left",
- "right"
- ]
- },
- {
- "name": "inverse",
- "type": "Boolean",
- "desc": "",
+ "desc": "- the label associated",
"memberOf": ""
},
{
- "name": "type",
- "type": "String",
- "desc": "default nav",
- "memberOf": "",
- "optvals": [
- "nav",
- "pills",
- "tab"
- ]
- },
- {
- "name": "navId",
+ "name": "value",
"type": "String",
- "desc": "- reference Id for navbar.",
+ "desc": "- the value of radio",
"memberOf": ""
},
{
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
"type": "function",
"desc": "Fires before the component is shown. Return false to stop the show."
},
- {
- "name": "changed",
- "sig": "function (_self, selected, prev)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the active item changes"
- },
{
"name": "childrenrendered",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Used to define events on this Observable"
},
- {
- "name": "addItem",
- "sig": "(Roo.bootstrap.NavItem the)",
- "type": "function",
- "desc": "adds a Navigation item"
- },
{
"name": "addListener",
"sig": "(String eventName, Function handler, Object scope, Object options)",
"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": "clearAll",
- "sig": "()",
- "type": "function",
- "desc": "clear all the Navigation item"
- },
{
"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"
- },
- {
- "name": "getActive",
- "sig": "()",
- "type": "function",
- "desc": "gets the active Navigation item"
- },
{
"name": "getChildContainer",
"sig": "()",
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"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": "If this is a lazy rendering component, render it to its container element."
},
- {
- "name": "setActiveItem",
- "sig": "(Roo.bootstrap.NavItem the)",
- "type": "function",
- "desc": "sets the active Navigation item"
- },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
}
]
},
- "Roo.bootstrap.NavHeaderbar": {
+ "Roo.bootstrap.RadioSet": {
"props": [
{
- "name": "brand",
+ "name": "indicatorpos",
"type": "String",
- "desc": "what is brand",
- "memberOf": ""
+ "desc": "default left",
+ "memberOf": "",
+ "optvals": [
+ "left",
+ "right"
+ ]
},
{
- "name": "position",
- "type": "String",
- "desc": "position",
+ "name": "inline",
+ "type": "Boolean",
+ "desc": "inline the element (default true)",
"memberOf": "",
"optvals": [
- "fixed-top",
- "fixed-bottom",
- "static-top"
+ "true",
+ "false"
]
},
{
- "name": "brand_href",
+ "name": "weight",
"type": "String",
- "desc": "href of the brand",
- "memberOf": ""
+ "desc": "The text that appears beside the radio",
+ "memberOf": "",
+ "optvals": [
+ "primary",
+ "warning",
+ "info",
+ "danger",
+ "success"
+ ]
},
{
- "name": "srButton",
+ "name": "disabled",
"type": "Boolean",
- "desc": "generate the (screen reader / mobile) sr-only button default true",
- "memberOf": ""
+ "desc": "is it disabled",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "autohide",
- "type": "Boolean",
- "desc": "a top nav bar header that hides on scroll.",
- "memberOf": ""
+ "name": "inputType",
+ "type": "String",
+ "desc": "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "desktopCenter",
- "type": "Boolean",
- "desc": "should the header be centered on desktop using a container class",
- "memberOf": ""
+ "name": "name",
+ "type": "String",
+ "desc": "name of the input",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "mobilerow",
- "type": "Roo.bootstrap.Row",
- "desc": "- a row to display on mobile only..",
- "memberOf": ""
+ "name": "fieldLabel",
+ "type": "string",
+ "desc": "- the label associated",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "inverse",
- "type": "Boolean",
- "desc": "is inverted color",
- "memberOf": "Roo.bootstrap.NavSimplebar"
+ "name": "placeholder",
+ "type": "string",
+ "desc": "- placeholder to put in text.",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "type",
+ "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",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labellg",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelmd",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelsm",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelxs",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelAlign",
"type": "String",
"desc": "",
- "memberOf": "Roo.bootstrap.NavSimplebar",
+ "memberOf": "Roo.bootstrap.Input",
"optvals": [
- "nav",
- "pills",
- "tabs"
+ "top",
+ "left"
]
},
{
- "name": "arrangement",
+ "name": "readOnly",
"type": "Boolean",
- "desc": "stacked | justified",
- "memberOf": "Roo.bootstrap.NavSimplebar"
+ "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": "alignment",
- "memberOf": "Roo.bootstrap.NavSimplebar",
+ "desc": "Default left",
+ "memberOf": "Roo.bootstrap.Input",
"optvals": [
"left",
+ "center",
"right"
]
},
{
- "name": "main",
+ "name": "forceFeedback",
"type": "Boolean",
- "desc": "main nav bar? default false",
- "memberOf": "Roo.bootstrap.NavSimplebar",
+ "desc": "Default false",
+ "memberOf": "Roo.bootstrap.Input",
"optvals": [
"true",
"false"
]
},
{
- "name": "loadMask",
+ "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": "loadMask on the bar",
- "memberOf": "Roo.bootstrap.NavSimplebar",
+ "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": "tag",
+ "name": "invalidFeedbackIcon",
"type": "String",
- "desc": "default is nav",
- "memberOf": "Roo.bootstrap.NavSimplebar",
- "optvals": [
- "header",
- "footer",
- "nav",
- "div"
- ]
+ "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": "-- Depricated - use Invalid Text",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to display if {@link #validator} 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": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"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, item)\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 when the children have been rendered.."
},
+ {
+ "name": "click",
+ "sig": "function (_self, item, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the element is click."
+ },
{
"name": "destroy",
"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": "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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"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)"
- }
- ]
- },
- "Roo.bootstrap.NavItem": {
- "props": [
- {
- "name": "href",
- "type": "String",
- "desc": "link to",
- "memberOf": ""
- },
- {
- "name": "html",
- "type": "String",
- "desc": "content of button",
- "memberOf": ""
- },
- {
- "name": "badge",
- "type": "String",
- "desc": "text inside badge",
- "memberOf": ""
- },
- {
- "name": "badgecls",
- "type": "String",
- "desc": "the extra classes for the badge",
- "memberOf": "",
- "optvals": [
- "bg-green",
- "bg-red",
- "bg-yellow"
- ]
- },
- {
- "name": "glyphicon",
- "type": "String",
- "desc": "name of glyphicon",
- "memberOf": ""
- },
- {
- "name": "icon",
- "type": "String",
- "desc": "name of font awesome icon",
- "memberOf": ""
- },
- {
- "name": "active",
- "type": "Boolean",
- "desc": "Is item active",
- "memberOf": ""
- },
- {
- "name": "disabled",
- "type": "Boolean",
- "desc": "Is item disabled",
- "memberOf": ""
- },
- {
- "name": "preventDefault",
- "type": "Boolean",
- "desc": "default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
- },
- {
- "name": "tabId",
- "type": "String",
- "desc": "the tab that this item activates.",
- "memberOf": ""
},
{
- "name": "tagtype",
- "type": "String",
- "desc": "render as a href or span?",
- "memberOf": "",
- "optvals": [
- "a",
- "span"
- ]
+ "name": "validate",
+ "sig": "()",
+ "type": "function",
+ "desc": "Validates the field value"
},
{
- "name": "animateRef",
- "type": "Boolean",
- "desc": "link to element default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
- },
+ "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": {
+ "props": [
{
"name": "cls",
"type": "String",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
"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 item active state changes"
- },
{
"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 rendered."
},
- {
- "name": "scrollto",
- "sig": "function (_self, options, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires when scroll to element"
- },
{
"name": "show",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
}
]
},
- "Roo.bootstrap.NavProgressBar": {
+ "Roo.bootstrap.SecurePass": {
"props": [
+ {
+ "name": "errors",
+ "type": "String/Object",
+ "desc": "A Error spec, or true for a default spec (defaults to\n{\n PwdEmpty: \"Please type a password, and then retype it to confirm.\",\n PwdShort: \"Your password must be at least 6 characters long. Please type a different password.\",\n PwdLong: \"Your password can't contain more than 16 characters. Please type a different password.\",\n PwdBadChar: \"The password contains characters that aren't allowed. Please type a different password.\",\n IDInPwd: \"Your password can't include the part of your ID. Please type a different password.\",\n FNInPwd: \"Your password can't contain your first name. Please type a different password.\",\n LNInPwd: \"Your password can't contain your last name. Please type a different password.\"\n})",
+ "memberOf": ""
+ },
+ {
+ "name": "Label",
+ "type": "String/Object",
+ "desc": "for the strength meter (defaults to\n'Password strength:')",
+ "memberOf": ""
+ },
+ {
+ "name": "pwdStrengths",
+ "type": "String/Object",
+ "desc": "A pwdStrengths spec, or true for a default spec (defaults to\n['Weak', 'Medium', 'Strong'])",
+ "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"
+ },
+ {
+ "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",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labellg",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelmd",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelsm",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelxs",
+ "type": "Number",
+ "desc": "set the width of label (1-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": "-- Depricated - use Invalid Text",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf": "Roo.bootstrap.Input"
+ },
{
"name": "cls",
"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": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
"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 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": "changed",
- "sig": "function (_self, selected, prev)\n{\n\n}",
+ "name": "change",
+ "sig": "function (_self, newValue, oldValue)\n{\n\n}",
"type": "function",
- "desc": "Fires when the active item changes"
+ "desc": "Fires just before the field blurs if the field value has changed."
},
{
"name": "childrenrendered",
"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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"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)"
- }
- ]
- },
- "Roo.bootstrap.NavProgressItem": {
- "props": [
- {
- "name": "rid",
- "type": "String",
- "desc": "the reference id",
- "memberOf": ""
- },
- {
- "name": "active",
- "type": "Boolean",
- "desc": "Is item active default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
- },
- {
- "name": "disabled",
- "type": "Boolean",
- "desc": "Is item active default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
- },
- {
- "name": "html",
- "type": "String",
- "desc": "",
- "memberOf": ""
- },
- {
- "name": "position",
- "type": "String",
- "desc": "text position default bottom",
- "memberOf": "",
- "optvals": [
- "top",
- "bottom"
- ]
},
{
- "name": "icon",
- "type": "String",
- "desc": "show icon instead of number",
- "memberOf": ""
+ "name": "validate",
+ "sig": "()",
+ "type": "function",
+ "desc": "Validates the field value"
},
{
- "name": "forceIcon",
- "type": "Boolean",
- "desc": "true to force show icon..if set to false, Roo.isTouch showing icon, otherwish number",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
- },
+ "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.Slider": {
+ "props": [
{
"name": "cls",
"type": "String",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
"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}",
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
}
]
},
- "Roo.bootstrap.NavSidebar": {
+ "Roo.bootstrap.SplitBar": {
+ "props": [
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "beforeresize",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the splitter is dragged"
+ },
+ {
+ "name": "moved",
+ "sig": "function (_self, newSize)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the splitter is moved"
+ },
+ {
+ "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": "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": "(Boolean removeEl)",
+ "type": "function",
+ "desc": "Destroy this splitbar."
+ },
+ {
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ },
+ {
+ "name": "getAdapter",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the adapter this SplitBar uses"
+ },
+ {
+ "name": "getMaximumSize",
+ "sig": "()",
+ "type": "function",
+ "desc": "Gets the maximum size for the resizing element"
+ },
+ {
+ "name": "getMinimumSize",
+ "sig": "()",
+ "type": "function",
+ "desc": "Gets the minimum size for the resizing element"
+ },
+ {
+ "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": "setAdapter",
+ "sig": "(Object adapter)",
+ "type": "function",
+ "desc": "Set the adapter this SplitBar uses"
+ },
+ {
+ "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": "carousel",
+ "type": "Boolean",
+ "desc": "true to make the group behave like a carousel",
+ "memberOf": ""
+ },
+ {
+ "name": "bullets",
+ "type": "Boolean",
+ "desc": "show bullets for the panels",
+ "memberOf": ""
+ },
+ {
+ "name": "autoslide",
+ "type": "Boolean",
+ "desc": "auto slide .. default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "timer",
+ "type": "Number",
+ "desc": "auto slide timer .. default 0 millisecond",
+ "memberOf": ""
+ },
+ {
+ "name": "showarrow",
+ "type": "Boolean",
+ "desc": "show arrow default true",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "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": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
"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": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"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.NavSidebarItem": {
+ "Roo.bootstrap.TabPanel": {
"props": [
- {
- "name": "href",
- "type": "String",
- "desc": "link to",
- "memberOf": "Roo.bootstrap.NavItem"
- },
- {
- "name": "html",
- "type": "String",
- "desc": "content of button",
- "memberOf": "Roo.bootstrap.NavItem"
- },
- {
- "name": "badge",
- "type": "String",
- "desc": "text inside badge",
- "memberOf": "Roo.bootstrap.NavItem"
- },
- {
- "name": "badgecls",
- "type": "String",
- "desc": "the extra classes for the badge",
- "memberOf": "Roo.bootstrap.NavItem",
- "optvals": [
- "bg-green",
- "bg-red",
- "bg-yellow"
- ]
- },
- {
- "name": "glyphicon",
- "type": "String",
- "desc": "name of glyphicon",
- "memberOf": "Roo.bootstrap.NavItem"
- },
- {
- "name": "icon",
- "type": "String",
- "desc": "name of font awesome icon",
- "memberOf": "Roo.bootstrap.NavItem"
- },
{
"name": "active",
"type": "Boolean",
- "desc": "Is item active",
- "memberOf": "Roo.bootstrap.NavItem"
- },
- {
- "name": "disabled",
- "type": "Boolean",
- "desc": "Is item disabled",
- "memberOf": "Roo.bootstrap.NavItem"
+ "desc": "panel active",
+ "memberOf": ""
},
{
- "name": "preventDefault",
- "type": "Boolean",
- "desc": "default false",
- "memberOf": "Roo.bootstrap.NavItem",
- "optvals": [
- "true",
- "false"
- ]
+ "name": "html",
+ "type": "String",
+ "desc": "panel content",
+ "memberOf": ""
},
{
"name": "tabId",
"type": "String",
- "desc": "the tab that this item activates.",
- "memberOf": "Roo.bootstrap.NavItem"
+ "desc": "unique tab ID (will be autogenerated if not set. - used to match TabItem to Panel)",
+ "memberOf": ""
},
{
- "name": "tagtype",
+ "name": "navId",
"type": "String",
- "desc": "render as a href or span?",
- "memberOf": "Roo.bootstrap.NavItem",
- "optvals": [
- "a",
- "span"
- ]
+ "desc": "The Roo.bootstrap.NavGroup which triggers show hide ()",
+ "memberOf": ""
},
{
- "name": "animateRef",
- "type": "Boolean",
- "desc": "link to element default false",
- "memberOf": "Roo.bootstrap.NavItem",
- "optvals": [
- "true",
- "false"
- ]
+ "name": "href",
+ "type": "String",
+ "desc": "click to link..",
+ "memberOf": ""
},
{
"name": "cls",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"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}",
"name": "changed",
"sig": "function (_self, state)\n{\n\n}",
"type": "function",
- "desc": "Fires when the active item active state changes"
+ "desc": "Fires when the active status changes"
},
{
"name": "childrenrendered",
"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 rendered."
},
- {
- "name": "scrollto",
- "sig": "function (_self, options, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires when scroll to element"
- },
{
"name": "show",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
}
]
},
- "Roo.bootstrap.NavSimplebar": {
+ "Roo.bootstrap.Table": {
"props": [
{
- "name": "inverse",
- "type": "Boolean",
- "desc": "is inverted color",
+ "name": "cls",
+ "type": "String",
+ "desc": "table class",
"memberOf": ""
},
{
- "name": "type",
+ "name": "align",
"type": "String",
- "desc": "",
+ "desc": "Specifies the alignment of a table according to surrounding text",
"memberOf": "",
"optvals": [
- "nav",
- "pills",
- "tabs"
+ "left",
+ "center",
+ "right"
]
},
{
- "name": "arrangement",
- "type": "Boolean",
- "desc": "stacked | justified",
+ "name": "bgcolor",
+ "type": "String",
+ "desc": "Specifies the background color for a table",
"memberOf": ""
},
{
- "name": "align",
+ "name": "border",
+ "type": "Number",
+ "desc": "Specifies whether the table cells should have borders or not",
+ "memberOf": ""
+ },
+ {
+ "name": "cellpadding",
+ "type": "Number",
+ "desc": "Specifies the space between the cell wall and the cell content",
+ "memberOf": ""
+ },
+ {
+ "name": "cellspacing",
+ "type": "Number",
+ "desc": "Specifies the space between cells",
+ "memberOf": ""
+ },
+ {
+ "name": "frame",
"type": "String",
- "desc": "alignment",
+ "desc": "Specifies which parts of the outside borders that should be visible",
+ "memberOf": ""
+ },
+ {
+ "name": "rules",
+ "type": "String",
+ "desc": "Specifies which parts of the inside borders that should be visible",
+ "memberOf": ""
+ },
+ {
+ "name": "sortable",
+ "type": "String",
+ "desc": "Specifies that the table should be sortable",
+ "memberOf": ""
+ },
+ {
+ "name": "summary",
+ "type": "String",
+ "desc": "Specifies a summary of the content of a table",
+ "memberOf": ""
+ },
+ {
+ "name": "width",
+ "type": "Number",
+ "desc": "Specifies the width of a table",
+ "memberOf": ""
+ },
+ {
+ "name": "layout",
+ "type": "String",
+ "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": [
- "left",
- "right"
+ "true",
+ "false"
]
},
{
- "name": "main",
+ "name": "footerShow",
"type": "Boolean",
- "desc": "main nav bar? default false",
+ "desc": "generate tfoot, default true",
"memberOf": "",
"optvals": [
"true",
]
},
{
- "name": "loadMask",
+ "name": "headerShow",
"type": "Boolean",
- "desc": "loadMask on the bar",
+ "desc": "generate thead, default true",
"memberOf": "",
"optvals": [
"true",
]
},
{
- "name": "tag",
- "type": "String",
- "desc": "default is nav",
+ "name": "rowSelection",
+ "type": "Boolean",
+ "desc": "default false",
"memberOf": "",
"optvals": [
- "header",
- "footer",
- "nav",
- "div"
+ "true",
+ "false"
]
},
{
- "name": "cls",
- "type": "String",
- "desc": "css class",
- "memberOf": "Roo.bootstrap.Component"
+ "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": ""
+ },
+ {
+ "name": "lazyLoad",
+ "type": "Boolean",
+ "desc": "auto load data while scrolling to the end (default false)",
+ "memberOf": ""
},
{
"name": "style",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
"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": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"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.Navbar": {
+ "Roo.bootstrap.Table.AbstractSelectionModel": {
"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",
+ "name": "listeners",
"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"
- },
+ "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": "name",
- "type": "string",
- "desc": "Specifies name attribute",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "addEvents",
+ "sig": "(Object object)",
+ "type": "function",
+ "desc": "Used to define events on this Observable"
},
{
- "name": "tooltip",
- "type": "string",
- "desc": "Text for the tooltip",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this component"
},
{
- "name": "container_method",
- "type": "string",
- "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf": "Roo.bootstrap.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": "disableClass",
- "type": "String",
- "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf": "Roo.Component"
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "allowDomMove",
- "type": "Boolean",
- "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf": "Roo.Component"
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "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": "isLocked",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if the selections are locked."
},
{
- "name": "actionMode",
- "type": "String",
- "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
- "memberOf": "Roo.Component"
+ "name": "lock",
+ "sig": "()",
+ "type": "function",
+ "desc": "Locks the selections."
},
{
- "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}",
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
},
{
- "name": "beforehide",
- "sig": "function (_self)\n{\n\n}",
+ "name": "purgeListeners",
+ "sig": "()",
"type": "function",
- "desc": "Fires before the component is hidden. Return false to stop the hide."
+ "desc": "Removes all listeners for this object"
},
{
- "name": "beforerender",
- "sig": "function (_self)\n{\n\n}",
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
"type": "function",
- "desc": "Fires before the component is rendered. Return false to stop the render."
+ "desc": "Removes <b>all</b> added captures from the Observable."
},
{
- "name": "beforeshow",
- "sig": "function (_self)\n{\n\n}",
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
"type": "function",
- "desc": "Fires before the component is shown. Return false to stop the show."
+ "desc": "Removes a listener"
},
{
- "name": "childrenrendered",
- "sig": "function (_self)\n{\n\n}",
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
"type": "function",
- "desc": "Fires when the children have been rendered.."
+ "desc": "Removes a listener (shorthand for removeListener)"
},
{
- "name": "destroy",
- "sig": "function (_self)\n{\n\n}",
+ "name": "unlock",
+ "sig": "()",
"type": "function",
- "desc": "Fires after the component is destroyed."
+ "desc": "Unlocks the selections."
+ }
+ ]
+ },
+ "Roo.bootstrap.Table.RowSelectionModel": {
+ "props": [
+ {
+ "name": "singleSelect",
+ "type": "Boolean",
+ "desc": "True to allow selection of only one row at a time (defaults to false)",
+ "memberOf": ""
},
{
- "name": "disable",
+ "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": "afterselectionchange",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is disabled."
+ "desc": "Fires after the selection changes (eg. by key press or clicking)"
},
{
- "name": "enable",
- "sig": "function (_self)\n{\n\n}",
+ "name": "beforerowselect",
+ "sig": "function (_self, rowIndex, keepExisting)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is enabled."
+ "desc": "Fires when a row is selected being selected, return false to cancel."
},
{
- "name": "hide",
- "sig": "function (_self)\n{\n\n}",
+ "name": "rowdeselect",
+ "sig": "function (_self, rowIndex)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is hidden."
+ "desc": "Fires when a row is deselected."
},
{
- "name": "render",
- "sig": "function (_self)\n{\n\n}",
+ "name": "rowselect",
+ "sig": "function (_self, rowIndex, r)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is rendered."
+ "desc": "Fires when a row is selected."
},
{
- "name": "show",
+ "name": "selectionchange",
"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.Pagination": {
+ "Roo.bootstrap.TableBody": {
"props": [
{
- "name": "size",
+ "name": "cls",
"type": "String",
- "desc": "xs | sm | md | lg",
+ "desc": "element class",
"memberOf": ""
},
{
- "name": "inverse",
- "type": "Boolean",
- "desc": "false | true",
+ "name": "tag",
+ "type": "String",
+ "desc": "element tag (thead|tbody|tfoot) default tbody",
"memberOf": ""
},
{
- "name": "cls",
+ "name": "align",
"type": "String",
- "desc": "css class",
- "memberOf": "Roo.bootstrap.Component"
+ "desc": "Aligns the content inside the element",
+ "memberOf": ""
+ },
+ {
+ "name": "charoff",
+ "type": "Number",
+ "desc": "Sets the number of characters the content inside the element will be aligned from the character specified by the char attribute",
+ "memberOf": ""
+ },
+ {
+ "name": "valign",
+ "type": "String",
+ "desc": "Vertical aligns the content inside the <tbody> element",
+ "memberOf": ""
},
{
"name": "style",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"desc": "Convenience function to hide or show this component by boolean."
},
{
- "name": "show",
- "sig": "()",
- "type": "function",
- "desc": "Show a component - removes 'hidden' class"
+ "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.TableCell": {
+ "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": "tooltipEl",
- "sig": "()",
- "type": "function",
- "desc": "Fetch the element to display the tooltip on."
+ "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": "un",
- "sig": "(String eventName, Function handler, Object scope)",
- "type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
- }
- ]
- },
- "Roo.bootstrap.PaginationItem": {
- "props": [
+ "name": "colspan",
+ "type": "Number",
+ "desc": "Specifies the number of columns a cell should span",
+ "memberOf": ""
+ },
{
- "name": "html",
+ "name": "headers",
"type": "String",
- "desc": "text",
+ "desc": "Specifies one or more header cells a cell is related to",
"memberOf": ""
},
{
- "name": "href",
- "type": "String",
- "desc": "the link",
+ "name": "height",
+ "type": "Number",
+ "desc": "Sets the height of a cell",
"memberOf": ""
},
{
- "name": "preventDefault",
- "type": "Boolean",
- "desc": "default true",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "name": "nowrap",
+ "type": "String",
+ "desc": "Specifies that the content inside a cell should not wrap",
+ "memberOf": ""
},
{
- "name": "active",
- "type": "Boolean",
- "desc": "default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "name": "rowspan",
+ "type": "Number",
+ "desc": "Sets the number of rows a cell should span",
+ "memberOf": ""
},
{
- "name": "disabled",
- "type": "Boolean",
- "desc": "default false",
+ "name": "scope",
+ "type": "String",
+ "desc": "Defines a way to associate header cells and data cells in a table",
"memberOf": ""
},
{
- "name": "cls",
+ "name": "valign",
"type": "String",
- "desc": "css class",
- "memberOf": "Roo.bootstrap.Component"
+ "desc": "Vertical aligns the content in a cell",
+ "memberOf": ""
+ },
+ {
+ "name": "width",
+ "type": "Number",
+ "desc": "Specifies the width of a cell",
+ "memberOf": ""
},
{
"name": "style",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
"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": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
}
]
},
- "Roo.bootstrap.PagingToolbar": {
+ "Roo.bootstrap.TableRow": {
"props": [
{
- "name": "dataSource",
- "type": "Roo.data.Store",
- "desc": "The underlying data store providing the paged data",
+ "name": "cls",
+ "type": "String",
+ "desc": "row class",
"memberOf": ""
},
{
- "name": "container",
- "type": "String/HTMLElement/Element",
- "desc": "container The id or element that will contain the toolbar",
+ "name": "align",
+ "type": "String",
+ "desc": "Aligns the content in a table row",
"memberOf": ""
},
{
- "name": "displayInfo",
- "type": "Boolean",
- "desc": "True to display the displayMsg (defaults to false)",
+ "name": "bgcolor",
+ "type": "String",
+ "desc": "Specifies a background color for a table row",
"memberOf": ""
},
{
- "name": "pageSize",
+ "name": "charoff",
"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}\")",
+ "desc": "Sets the number of characters the content will be aligned from the character specified by the char attribute",
"memberOf": ""
},
{
- "name": "emptyMsg",
+ "name": "valign",
"type": "String",
- "desc": "The message to display when no records are found (defaults to \"No data to display\")",
+ "desc": "Vertical aligns the content in a table row",
"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",
- "desc": "css class",
- "memberOf": "Roo.bootstrap.Component"
- },
{
"name": "style",
"type": "String",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
"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)",
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"desc": "Convenience function to hide or show this component by boolean."
},
{
- "name": "show",
- "sig": "()",
- "type": "function",
- "desc": "Show a component - removes 'hidden' class"
+ "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.TextArea": {
+ "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"
+ },
+ {
+ "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",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labellg",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelmd",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelsm",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelxs",
+ "type": "Number",
+ "desc": "set the width of label (1-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": "tooltipEl",
- "sig": "()",
- "type": "function",
- "desc": "Fetch the element to display the tooltip on."
+ "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": "un",
- "sig": "(String eventName, Function handler, Object scope)",
- "type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
+ "name": "minLength",
+ "type": "Number",
+ "desc": "Minimum input field length required (defaults to 0)",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "unbind",
- "sig": "(Roo.data.Store store)",
- "type": "function",
- "desc": "Unbinds the paging toolbar from the specified {@link Roo.data.Store}"
- }
- ]
- },
- "Roo.bootstrap.Popover": {
- "props": [
+ "name": "maxLength",
+ "type": "Number",
+ "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
{
- "name": "html",
+ "name": "minLengthText",
"type": "String",
- "desc": "contents of the popover (or false to use children..)",
- "memberOf": ""
+ "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": "title",
+ "name": "maxLengthText",
"type": "String",
- "desc": "of popover (or false to hide)",
- "memberOf": ""
+ "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": "placement",
- "type": "String",
- "desc": "how it is placed",
- "memberOf": ""
+ "name": "validator",
+ "type": "Function",
+ "desc": "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "trigger",
- "type": "String",
- "desc": "click || hover (or false to trigger manually)",
- "memberOf": ""
+ "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": "over",
+ "name": "regexText",
"type": "String",
- "desc": "what (parent or false to trigger manually.)",
- "memberOf": ""
+ "desc": "-- Depricated - use Invalid Text",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "delay",
- "type": "Number",
- "desc": "- delay before showing",
- "memberOf": ""
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to display if {@link #validator} 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": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"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}",
"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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"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.Progress": {
+ "Roo.bootstrap.TimeField": {
"props": [
{
- "name": "striped",
- "type": "Boolean",
- "desc": "striped of the progress bar",
+ "name": "format",
+ "type": "String",
+ "desc": "The default time format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'H:i').",
"memberOf": ""
},
{
- "name": "active",
+ "name": "disabled",
"type": "Boolean",
- "desc": "animated of the progress bar",
- "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",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labellg",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelmd",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelsm",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelxs",
+ "type": "Number",
+ "desc": "set the width of label (1-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": "-- Depricated - use Invalid Text",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf": "Roo.bootstrap.Input"
},
{
"name": "cls",
"memberOf": "Roo.bootstrap.Component"
},
{
- "name": "dataId",
- "type": "string",
- "desc": "cutomer id",
- "memberOf": "Roo.bootstrap.Component"
- },
- {
- "name": "name",
+ "name": "dataId",
"type": "string",
- "desc": "Specifies name attribute",
+ "desc": "cutomer id",
"memberOf": "Roo.bootstrap.Component"
},
{
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"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}",
"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}",
"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}",
+ "type": "function",
+ "desc": "Fires when this field show."
+ },
+ {
+ "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 component is shown."
+ "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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"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.ProgressBar": {
+ "Roo.bootstrap.Tooltip": {
+ "props": [],
+ "events": [],
+ "methods": [
+ {
+ "name": "currentEl",
+ "sig": "()",
+ "type": "function",
+ "desc": ""
+ }
+ ]
+ },
+ "Roo.bootstrap.TriggerField": {
"props": [
{
- "name": "aria_valuenow",
- "type": "Number",
- "desc": "aria-value now",
+ "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": "aria_valuemin",
- "type": "Number",
- "desc": "aria-value min",
- "memberOf": ""
+ "name": "caret",
+ "type": "String",
+ "desc": "a fontawesome for the trigger icon see http://fortawesome.github.io/Font-Awesome/icons/",
+ "memberOf": "",
+ "optvals": [
+ "search",
+ "calendar"
+ ]
},
{
- "name": "aria_valuemax",
- "type": "Number",
- "desc": "aria-value max",
+ "name": "hideTrigger",
+ "type": "Boolean",
+ "desc": "True to hide the trigger element and display only the base text field (defaults to false)",
"memberOf": ""
},
{
- "name": "label",
+ "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": "label for the progress bar",
- "memberOf": ""
+ "desc": "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
+ "memberOf": "Roo.bootstrap.Input"
},
{
- "name": "panel",
+ "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",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labellg",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelmd",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelsm",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelxs",
+ "type": "Number",
+ "desc": "set the width of label (1-12)",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "labelAlign",
"type": "String",
"desc": "",
- "memberOf": "",
+ "memberOf": "Roo.bootstrap.Input",
"optvals": [
- "success",
- "info",
- "warning",
- "danger"
+ "top",
+ "left"
]
},
{
- "name": "role",
+ "name": "readOnly",
+ "type": "Boolean",
+ "desc": "Specifies that the field should be read-only",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "autocomplete",
"type": "String",
- "desc": "role of the progress bar",
- "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": "sr_only",
+ "name": "indicatorpos",
"type": "String",
- "desc": "text",
- "memberOf": ""
+ "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": "-- Depricated - use Invalid Text",
+ "memberOf": "Roo.bootstrap.Input"
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to display if {@link #validator} 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": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"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}",
"name": "enable",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is enabled."
+ "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": "hide",
- "sig": "function (_self)\n{\n\n}",
+ "name": "keyup",
+ "sig": "function (_self, e)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is hidden."
+ "desc": "Fires after the key up"
},
{
"name": "render",
"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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"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)"
- }
- ]
- },
- "Roo.bootstrap.Radio": {
- "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": "validate",
+ "sig": "()",
+ "type": "function",
+ "desc": "Validates the field value"
},
{
- "name": "fieldLabel",
- "type": "String",
- "desc": "- the label associated",
- "memberOf": "Roo.bootstrap.Input"
- },
+ "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.UploadCropbox": {
+ "props": [
{
- "name": "inputType",
+ "name": "emptyText",
"type": "String",
- "desc": "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "show when image has been loaded",
+ "memberOf": ""
},
{
- "name": "name",
+ "name": "rotateNotify",
"type": "String",
- "desc": "name of the input",
- "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"
+ "desc": "show when image too small to rotate",
+ "memberOf": ""
},
{
- "name": "md",
+ "name": "errorTimeout",
"type": "Number",
- "desc": "colspan out of 12 for computer-sized screens",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "default 3000",
+ "memberOf": ""
},
{
- "name": "lg",
+ "name": "minWidth",
"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"
+ "desc": "default 300",
+ "memberOf": ""
},
{
- "name": "labelWidth",
+ "name": "minHeight",
"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"
+ "desc": "default 300",
+ "memberOf": ""
},
{
- "name": "align",
- "type": "String",
- "desc": "Default left",
- "memberOf": "Roo.bootstrap.Input",
- "optvals": [
- "left",
- "center",
- "right"
- ]
+ "name": "buttons",
+ "type": "Array",
+ "desc": "default ['rotateLeft', 'pictureBtn', 'rotateRight']",
+ "memberOf": ""
},
{
- "name": "forceFeedback",
+ "name": "isDocument",
"type": "Boolean",
- "desc": "Default false",
- "memberOf": "Roo.bootstrap.Input",
+ "desc": "default false",
+ "memberOf": "",
"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",
+ "name": "url",
"type": "String",
- "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "action url",
+ "memberOf": ""
},
{
- "name": "invalidClass",
+ "name": "paramName",
"type": "String",
- "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "default 'imageUpload'",
+ "memberOf": ""
},
{
- "name": "validClass",
+ "name": "method",
"type": "String",
- "desc": "The CSS class to use when marking a field valid (defaults to \"x-form-invalid\")",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "default POST",
+ "memberOf": ""
},
{
- "name": "hasFeedback",
+ "name": "loadMask",
"type": "Boolean",
"desc": "default true",
- "memberOf": "Roo.bootstrap.Input",
+ "memberOf": "",
"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",
+ "name": "loadingText",
"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": "default 'Loading...'",
+ "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",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"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}",
"desc": "Fires before the component is hidden. Return false to stop the hide."
},
{
- "name": "beforerender",
- "sig": "function (_self)\n{\n\n}",
+ "name": "beforeloadcanvas",
+ "sig": "function (_self, src)\n{\n\n}",
"type": "function",
- "desc": "Fires before the component is rendered. Return false to stop the render."
+ "desc": "Fire before load the canvas"
},
{
- "name": "beforeshow",
+ "name": "beforerender",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires before the component is shown. Return false to stop the show."
+ "desc": "Fires before the component is rendered. Return false to stop the render."
},
{
- "name": "blur",
+ "name": "beforeselectfile",
"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."
+ "desc": "Fire before select file"
},
{
- "name": "check",
- "sig": "function (_self, checked)\n{\n\n}",
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the element is checked or unchecked."
+ "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": "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 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": "focus",
- "sig": "function (_self)\n{\n\n}",
+ "name": "exception",
+ "sig": "function (_self, xhr)\n{\n\n}",
"type": "function",
- "desc": "Fires when this field receives input focus."
+ "desc": "Fire when get exception"
+ },
+ {
+ "name": "footerbuttonclick",
+ "sig": "function (_self, type)\n{\n\n}",
+ "type": "function",
+ "desc": "Fire when footerbuttonclick"
},
{
"name": "hide",
"desc": "Fires after the component is hidden."
},
{
- "name": "invalid",
- "sig": "function (_self, msg)\n{\n\n}",
+ "name": "initial",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the field has been marked as invalid."
+ "desc": "Fire after initEvent"
},
{
- "name": "keyup",
- "sig": "function (_self, e)\n{\n\n}",
+ "name": "inspect",
+ "sig": "function (_self, file)\n{\n\n}",
"type": "function",
- "desc": "Fires after the key up"
+ "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",
"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": "specialkey",
- "sig": "function (_self, e)\n{\n\n}",
+ "name": "trash",
+ "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": "Fire when trash image"
},
{
- "name": "valid",
- "sig": "function (_self)\n{\n\n}",
+ "name": "upload",
+ "sig": "function (_self, data)\n{\n\n}",
"type": "function",
- "desc": "Fires after the field has been validated with no errors."
+ "desc": "Fire when xhr upload the file"
}
],
"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": "()",
"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",
+ "name": "getVisibilityEl",
"sig": "()",
"type": "function",
- "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
+ "desc": "Get the element that will be used to show or hide"
},
{
"name": "hasListener",
"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.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": ""
+ },
{
"name": "cls",
"type": "String",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
}
]
},
- "Roo.bootstrap.Slider": {
+ "Roo.bootstrap.dash.TabBox": {
"props": [
+ {
+ "name": "title",
+ "type": "String",
+ "desc": "Title of the TabBox",
+ "memberOf": ""
+ },
+ {
+ "name": "icon",
+ "type": "String",
+ "desc": "Icon of the TabBox",
+ "memberOf": ""
+ },
+ {
+ "name": "showtabs",
+ "type": "Boolean",
+ "desc": "show the tabs default true",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "tabScrollable",
+ "type": "Boolean",
+ "desc": "tab scrollable when mobile view default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
{
"name": "cls",
"type": "String",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
}
],
"events": [
+ {
+ "name": "activatepane",
+ "sig": "function (pane)\n{\n\n}",
+ "type": "function",
+ "desc": "When a pane is activated"
+ },
+ {
+ "name": "addpane",
+ "sig": "function (pane)\n{\n\n}",
+ "type": "function",
+ "desc": "When a pane is added"
+ },
{
"name": "beforedestroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"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.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": "carousel",
- "type": "Boolean",
- "desc": "true to make the group behave like a carousel",
- "memberOf": ""
- },
- {
- "name": "bullets",
- "type": "Number",
- "desc": "show the panel pointer.. default 0",
- "memberOf": ""
- },
- {
- "name": "autoslide",
- "type": "Boolean",
- "desc": "auto slide .. default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
- },
- {
- "name": "slideOnTouch",
- "type": "Boolean",
- "desc": "slide on touch .. default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
- },
- {
- "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": "setTitle",
+ "sig": "(String html)",
+ "type": "function",
+ "desc": "Updates the box title"
},
{
- "name": "alert",
- "type": "String",
- "desc": "type alert (changes background / border...)",
- "memberOf": "Roo.bootstrap.Column",
- "optvals": [
- "success",
- "info",
- "warning",
- "danger"
- ]
+ "name": "setVisible",
+ "sig": "(Boolean visible)",
+ "type": "function",
+ "desc": "Convenience function to hide or show this component by boolean."
},
{
- "name": "fa",
- "type": "String",
- "desc": "font awesome icon",
- "memberOf": "Roo.bootstrap.Column",
- "optvals": [
- "ban",
- "check",
- "..."
- ]
+ "name": "show",
+ "sig": "()",
+ "type": "function",
+ "desc": "Show a component - removes 'hidden' class"
},
{
- "name": "fasize",
- "type": "Number",
- "desc": "font awsome size",
- "memberOf": "Roo.bootstrap.Column",
- "optvals": [
- "1",
- "2",
- "...."
- ]
+ "name": "tooltipEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Fetch the element to display the tooltip on."
},
{
- "name": "icon",
- "type": "String",
- "desc": "glyphicon name",
- "memberOf": "Roo.bootstrap.Column",
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.bootstrap.dash.TabPane": {
+ "props": [
+ {
+ "name": "active",
+ "type": "Boolean",
+ "desc": "Default false",
+ "memberOf": "",
"optvals": [
- "info-sign",
- "check",
- "..."
+ "false",
+ "true"
]
},
{
- "name": "html",
+ "name": "title",
"type": "String",
- "desc": "content of column.",
- "memberOf": "Roo.bootstrap.Column"
+ "desc": "title of panel",
+ "memberOf": ""
},
{
"name": "cls",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
}
],
"events": [
+ {
+ "name": "activate",
+ "sig": "function (pane)\n{\n\n}",
+ "type": "function",
+ "desc": "When a pane is activated"
+ },
{
"name": "beforedestroy",
"sig": "function (_self)\n{\n\n}",
"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": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"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": "setTitle",
+ "sig": "(String html)",
+ "type": "function",
+ "desc": "Updates the tab title"
+ },
{
"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.TabPanel": {
+ "Roo.bootstrap.htmleditor": {
+ "props": [],
+ "events": [],
+ "methods": []
+ },
+ "Roo.bootstrap.htmleditor.ToolbarStandard": {
"props": [
{
- "name": "active",
- "type": "Boolean",
- "desc": "panel active",
+ "name": "disable",
+ "type": "Object",
+ "desc": "List of elements to disable..",
"memberOf": ""
},
{
- "name": "html",
- "type": "String",
- "desc": "panel content",
+ "name": "btns",
+ "type": "Array",
+ "desc": "List of additional buttons.\n\n\nNEEDS Extra CSS? \n.x-html-editor-tb .x-edit-none .x-btn-text { background: none; }",
+ "memberOf": ""
+ }
+ ],
+ "events": [],
+ "methods": [
+ {
+ "name": "updateToolbar",
+ "sig": "()",
+ "type": "function",
+ "desc": "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor."
+ }
+ ]
+ },
+ "Roo.bootstrap.layout": {
+ "props": [],
+ "events": [],
+ "methods": []
+ },
+ "Roo.bootstrap.layout.Basic": {
+ "props": [
+ {
+ "name": "mgr",
+ "type": "Roo.bootstrap.layout.Manager",
+ "desc": "The manager",
"memberOf": ""
},
{
- "name": "tabId",
- "type": "String",
- "desc": "unique tab ID (will be autogenerated if not set. - used to match TabItem to Panel)",
+ "name": "region",
+ "type": "string",
+ "desc": "the region that it inhabits..",
"memberOf": ""
},
{
- "name": "navId",
- "type": "String",
- "desc": "The Roo.bootstrap.NavGroup which triggers show hide ()",
+ "name": "skipConfig",
+ "type": "bool",
+ "desc": "skip config?",
"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": "add",
+ "sig": "(ContentPanel... panel)",
+ "type": "function",
+ "desc": "Add the passed ContentPanel(s)"
+ },
+ {
+ "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": "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": "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": "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": "showPanel",
+ "sig": "(Number/String/ContentPanel panelId)",
+ "type": "function",
+ "desc": "Show the specified panel."
+ },
+ {
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.bootstrap.layout.Border": {
+ "props": [
{
"name": "cls",
"type": "String",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"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}",
"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}",
}
],
"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",
"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": "()",
+ "name": "getRegion",
+ "sig": "(String target)",
"type": "function",
- "desc": "Hide a component - adds 'hidden' class"
+ "desc": "Returns the specified region."
},
{
- "name": "initEvents",
+ "name": "getViewSize",
"sig": "()",
"type": "function",
- "desc": "Initialize Events for the element"
+ "desc": "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments."
},
{
- "name": "isVisible",
+ "name": "getVisibilityEl",
"sig": "()",
"type": "function",
- "desc": "Returns true if this component is visible."
+ "desc": "Get the element that will be used to show or hide"
},
{
- "name": "on",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "name": "hasListener",
+ "sig": "(String eventName)",
"type": "function",
- "desc": "Appends an event handler to this element (shorthand for addListener)"
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "purgeListeners",
+ "name": "hide",
"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."
+ "desc": "Hide a component - adds 'hidden' class"
},
{
- "name": "show",
+ "name": "initEvents",
"sig": "()",
"type": "function",
- "desc": "Show a component - removes 'hidden' class"
+ "desc": "Initialize Events for the element"
},
{
- "name": "tooltipEl",
+ "name": "isUpdating",
"sig": "()",
"type": "function",
- "desc": "Fetch the element to display the tooltip on."
+ "desc": "Returns true if this layout is currently being updated"
},
{
- "name": "un",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "isVisible",
+ "sig": "()",
"type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
- }
- ]
- },
- "Roo.bootstrap.Table": {
- "props": [
- {
- "name": "cls",
- "type": "String",
- "desc": "table class",
- "memberOf": ""
- },
- {
- "name": "align",
- "type": "String",
- "desc": "Specifies the alignment of a table according to surrounding text",
- "memberOf": "",
- "optvals": [
- "left",
- "center",
- "right"
- ]
- },
- {
- "name": "bgcolor",
- "type": "String",
- "desc": "Specifies the background color for a table",
- "memberOf": ""
- },
- {
- "name": "border",
- "type": "Number",
- "desc": "Specifies whether the table cells should have borders or not",
- "memberOf": ""
- },
- {
- "name": "cellpadding",
- "type": "Number",
- "desc": "Specifies the space between the cell wall and the cell content",
- "memberOf": ""
- },
- {
- "name": "cellspacing",
- "type": "Number",
- "desc": "Specifies the space between cells",
- "memberOf": ""
- },
- {
- "name": "frame",
- "type": "String",
- "desc": "Specifies which parts of the outside borders that should be visible",
- "memberOf": ""
- },
- {
- "name": "rules",
- "type": "String",
- "desc": "Specifies which parts of the inside borders that should be visible",
- "memberOf": ""
- },
- {
- "name": "sortable",
- "type": "String",
- "desc": "Specifies that the table should be sortable",
- "memberOf": ""
- },
- {
- "name": "summary",
- "type": "String",
- "desc": "Specifies a summary of the content of a table",
- "memberOf": ""
+ "desc": "Returns true if this component is visible."
},
{
- "name": "width",
- "type": "Number",
- "desc": "Specifies the width of a table",
- "memberOf": ""
+ "name": "layout",
+ "sig": "()",
+ "type": "function",
+ "desc": "Performs a layout update."
},
{
- "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": "remove",
+ "sig": "(String target, Number/String/Roo.ContentPanel panel)",
+ "type": "function",
+ "desc": "Remove a ContentPanel (or subclass) to this layout."
},
{
- "name": "condensed",
- "type": "boolean",
- "desc": "Format condensed",
- "memberOf": ""
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
},
{
- "name": "responsive",
- "type": "boolean",
- "desc": "Format condensed",
- "memberOf": ""
+ "name": "render",
+ "sig": "(String/HTMLElement/Element container)",
+ "type": "function",
+ "desc": "If this is a lazy rendering component, render it to its container element."
},
{
- "name": "loadMask",
- "type": "Boolean",
- "desc": "default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
+ "type": "function",
+ "desc": "Convenience function for setting disabled/enabled by boolean."
},
{
- "name": "footerShow",
- "type": "Boolean",
- "desc": "generate tfoot, default true",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "name": "setVisible",
+ "sig": "(Boolean visible)",
+ "type": "function",
+ "desc": "Convenience function to hide or show this component by boolean."
},
{
- "name": "headerShow",
- "type": "Boolean",
- "desc": "generate thead, default true",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "name": "show",
+ "sig": "()",
+ "type": "function",
+ "desc": "Show a component - removes 'hidden' class"
},
{
- "name": "rowSelection",
- "type": "Boolean",
- "desc": "default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "name": "showPanel",
+ "sig": "(String/ContentPanel panelId)",
+ "type": "function",
+ "desc": "Searches all regions for a panel with the specified id and activates (shows) it."
},
{
- "name": "cellSelection",
- "type": "Boolean",
- "desc": "default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "name": "tooltipEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Fetch the element to display the tooltip on."
},
{
- "name": "footer",
- "type": "Roo.bootstrap.PagingToolbar",
- "desc": "a paging toolbar",
- "memberOf": ""
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.bootstrap.layout.Manager": {
+ "props": [
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
},
{
"name": "style",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
"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}",
"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",
+ "name": "layout",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is rendered."
+ "desc": "Fires when a layout is performed."
},
{
- "name": "rowclass",
- "sig": "function (_self, rowcfg)\n{\n\n}",
+ "name": "regioncollapsed",
+ "sig": "function (region)\n{\n\n}",
"type": "function",
- "desc": "Fires when a row is rendered, so you can change add a style to it."
+ "desc": "Fires when a region is collapsed."
},
{
- "name": "rowclick",
- "sig": "function (_self, el, rowIndex, e)\n{\n\n}",
+ "name": "regionexpanded",
+ "sig": "function (region)\n{\n\n}",
"type": "function",
- "desc": "Fires when a row is clicked"
+ "desc": "Fires when a region is expanded."
},
{
- "name": "rowdblclick",
- "sig": "function (_self, el, rowIndex, e)\n{\n\n}",
+ "name": "regionresized",
+ "sig": "function (region, newSize)\n{\n\n}",
"type": "function",
- "desc": "Fires when a row is double clicked"
+ "desc": "Fires when the user resizes a region."
},
{
- "name": "rowsrendered",
+ "name": "render",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when all the rows have been rendered"
+ "desc": "Fires after the component is rendered."
},
{
"name": "show",
"desc": "Appends an event handler to this component"
},
{
- "name": "capture",
- "sig": "(Observable o, Function fn, Object scope)",
+ "name": "beginUpdate",
+ "sig": "()",
"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."
+ "desc": "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls"
},
{
- "name": "clear",
- "sig": "()",
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
"type": "function",
- "desc": "Remove all rows"
+ "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",
"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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"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": "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.Table.AbstractSelectionModel": {
+ "Roo.bootstrap.layout.Region": {
"props": [
{
- "name": "listeners",
+ "name": "margins",
"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": [
+ "desc": "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
+ "memberOf": ""
+ },
{
- "name": "addEvents",
- "sig": "(Object object)",
- "type": "function",
- "desc": "Used to define events on this Observable"
+ "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": "addListener",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
- "type": "function",
- "desc": "Appends an event handler to this component"
+ "name": "tabPosition",
+ "type": "String",
+ "desc": "\"top\" or \"bottom\" (defaults to \"bottom\")",
+ "memberOf": "",
+ "optvals": [
+ "top",
+ "bottom"
+ ]
},
{
- "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": "alwaysShowTabs",
+ "type": "Boolean",
+ "desc": "True to always display tabs even when there is only 1 panel (defaults to false)",
+ "memberOf": ""
},
{
- "name": "fireEvent",
- "sig": "(String eventName, Object... args)",
- "type": "function",
- "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ "name": "autoScroll",
+ "type": "Boolean",
+ "desc": "True to enable overflow scrolling (defaults to false)",
+ "memberOf": ""
},
{
- "name": "hasListener",
- "sig": "(String eventName)",
- "type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
+ "name": "titlebar",
+ "type": "Boolean",
+ "desc": "True to display a title bar (defaults to true)",
+ "memberOf": ""
},
{
- "name": "isLocked",
- "sig": "()",
- "type": "function",
- "desc": "Returns true if the selections are locked."
+ "name": "title",
+ "type": "String",
+ "desc": "The title for the region (overrides panel titles)",
+ "memberOf": ""
},
{
- "name": "lock",
- "sig": "()",
- "type": "function",
- "desc": "Locks the selections."
+ "name": "animate",
+ "type": "Boolean",
+ "desc": "True to animate expand/collapse (defaults to false)",
+ "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": "autoHide",
+ "type": "Boolean",
+ "desc": "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
+ "memberOf": ""
},
{
- "name": "purgeListeners",
- "sig": "()",
- "type": "function",
- "desc": "Removes all listeners for this object"
+ "name": "preservePanels",
+ "type": "Boolean",
+ "desc": "True to preserve removed panels so they can be readded later (defaults to false)",
+ "memberOf": ""
},
{
- "name": "releaseCapture",
- "sig": "(Observable o)",
- "type": "function",
- "desc": "Removes <b>all</b> added captures from the Observable."
+ "name": "closeOnTab",
+ "type": "Boolean",
+ "desc": "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
+ "memberOf": ""
},
{
- "name": "removeListener",
- "sig": "(String eventName, Function handler, Object scope)",
- "type": "function",
- "desc": "Removes a listener"
+ "name": "hideTabs",
+ "type": "Boolean",
+ "desc": "True to hide the tab strip (defaults to false)",
+ "memberOf": ""
},
{
- "name": "un",
- "sig": "(String eventName, Function handler, Object scope)",
- "type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
+ "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": "unlock",
- "sig": "()",
- "type": "function",
- "desc": "Unlocks the selections."
- }
- ]
- },
- "Roo.bootstrap.Table.RowSelectionModel": {
- "props": [
+ "name": "minTabWidth",
+ "type": "Number",
+ "desc": "The minimum tab width (defaults to 40)",
+ "memberOf": ""
+ },
{
- "name": "singleSelect",
+ "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 allow selection of only one row at a time (defaults to false)",
+ "desc": "True to start the region hidden (defaults to false)",
"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": "hideWhenEmpty",
+ "type": "Boolean",
+ "desc": "True to hide the region when it has no panels",
+ "memberOf": ""
+ },
{
- "name": "afterselectionchange",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the selection changes (eg. by key press or clicking)"
+ "name": "disableTabTips",
+ "type": "Boolean",
+ "desc": "True to disable tab tooltips",
+ "memberOf": ""
},
{
- "name": "beforerowselect",
- "sig": "function (_self, rowIndex, keepExisting)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a row is selected being selected, return false to cancel."
+ "name": "width",
+ "type": "Number",
+ "desc": "For East/West panels",
+ "memberOf": ""
},
{
- "name": "rowdeselect",
- "sig": "function (_self, rowIndex)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a row is deselected."
+ "name": "height",
+ "type": "Number",
+ "desc": "For North/South panels",
+ "memberOf": ""
},
{
- "name": "rowselect",
- "sig": "function (_self, rowIndex, r)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a row is selected."
+ "name": "split",
+ "type": "Boolean",
+ "desc": "To show the splitter",
+ "memberOf": ""
},
{
- "name": "selectionchange",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the selection changes"
+ "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)",
"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": "clearSelections",
- "sig": "()",
+ "name": "animateCollapse",
+ "sig": "(Boolean skipAnim)",
"type": "function",
- "desc": "Clears all selections."
+ "desc": "Collapses this region."
},
{
- "name": "deselectRange",
- "sig": "(Number startRow, Number endRow)",
+ "name": "animateExpand",
+ "sig": "(Roo.EventObject e, Boolean skipAnim)",
"type": "function",
- "desc": "Deselects a range of rows. All rows in between startRow and endRow are also deselected."
+ "desc": "Expands this region if it was previously collapsed."
},
{
- "name": "deselectRow",
- "sig": "(Number row)",
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
"type": "function",
- "desc": "Deselects a row."
+ "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",
"desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "getCount",
+ "name": "getActivePanel",
"sig": "()",
"type": "function",
- "desc": "Gets the number of selected rows."
+ "desc": "Get the active panel for this region."
},
{
- "name": "getSelected",
- "sig": "()",
+ "name": "getBox",
+ "sig": "(String title)",
"type": "function",
- "desc": "Returns the first selected record."
+ "desc": "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)"
},
{
- "name": "getSelections",
+ "name": "getEl",
"sig": "()",
"type": "function",
- "desc": "Returns the selected records"
+ "desc": "Returns the container element for this region."
},
{
- "name": "hasListener",
- "sig": "(String eventName)",
+ "name": "getPanel",
+ "sig": "(Number/String/ContentPanel panel)",
"type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
+ "desc": "Returns the panel specified or null if it's not in this region."
},
{
- "name": "hasSelection",
+ "name": "getPosition",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns this regions position (north/south/east/west/center)."
+ },
+ {
+ "name": "getTabs",
"sig": "()",
"type": "function",
- "desc": "Returns True if there is a selection."
+ "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": "isIdSelected",
- "sig": "(String id)",
+ "name": "hasPanel",
+ "sig": "(Number/String/ContentPanel panel)",
"type": "function",
- "desc": "Returns True if the specified record id is selected."
+ "desc": "Returns true if the panel is in this region."
},
{
- "name": "isLocked",
+ "name": "hide",
"sig": "()",
"type": "function",
- "desc": "Returns true if the selections are locked."
+ "desc": "Hides this region."
},
{
- "name": "isSelected",
- "sig": "(Number/Record record)",
+ "name": "hidePanel",
+ "sig": "(Number/String/ContentPanel panel)",
"type": "function",
- "desc": "Returns True if the specified row is selected."
+ "desc": "Hides the tab for the specified panel."
},
{
- "name": "lock",
+ "name": "isVisible",
"sig": "()",
"type": "function",
- "desc": "Locks the selections."
+ "desc": "Returns true if this region is currently visible."
},
{
"name": "on",
"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)",
"desc": "Removes a listener"
},
{
- "name": "selectAll",
- "sig": "()",
+ "name": "resizeTo",
+ "sig": "(Number newSize)",
"type": "function",
- "desc": "Selects all rows."
+ "desc": "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height."
},
{
- "name": "selectFirstRow",
+ "name": "show",
"sig": "()",
"type": "function",
- "desc": "Selects the first row in the grid."
+ "desc": "Shows this region if it was previously hidden."
},
{
- "name": "selectLastRow",
- "sig": "(Boolean keepExisting)",
+ "name": "showPanel",
+ "sig": "(Number/String/ContentPanel panelId)",
"type": "function",
- "desc": "Select the last row."
+ "desc": "Shows the specified panel."
},
{
- "name": "selectNext",
- "sig": "(Boolean keepExisting)",
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
"type": "function",
- "desc": "Selects the row immediately following the last selected row."
+ "desc": "Removes a listener (shorthand for removeListener)"
},
{
- "name": "selectPrevious",
- "sig": "(Boolean keepExisting)",
+ "name": "unhidePanel",
+ "sig": "(Number/String/ContentPanel panel)",
"type": "function",
- "desc": "Selects the row that precedes the last selected row."
- },
+ "desc": "Unhides the tab for a previously hidden panel."
+ }
+ ]
+ },
+ "Roo.bootstrap.layout.Split": {
+ "props": [
{
- "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": "collapsible",
+ "type": "Boolean",
+ "desc": "False to disable collapsing (defaults to true)",
+ "memberOf": "Roo.LayoutRegion"
},
{
- "name": "selectRecords",
- "sig": "(Array records, Boolean keepExisting)",
- "type": "function",
- "desc": "Select records."
+ "name": "collapsed",
+ "type": "Boolean",
+ "desc": "True to set the initial display to collapsed (defaults to false)",
+ "memberOf": "Roo.LayoutRegion"
},
{
- "name": "selectRow",
- "sig": "(Number row, Boolean keepExisting)",
- "type": "function",
- "desc": "Selects a row."
+ "name": "floatable",
+ "type": "Boolean",
+ "desc": "False to disable floating (defaults to true)",
+ "memberOf": "Roo.LayoutRegion"
},
{
- "name": "selectRows",
- "sig": "(Array rows, Boolean keepExisting)",
- "type": "function",
- "desc": "Selects multiple rows."
+ "name": "margins",
+ "type": "Object",
+ "desc": "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
+ "memberOf": "Roo.LayoutRegion"
},
{
- "name": "un",
- "sig": "(String eventName, Function handler, Object scope)",
- "type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
+ "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": "unlock",
- "sig": "()",
- "type": "function",
- "desc": "Unlocks the selections."
- }
- ]
- },
- "Roo.bootstrap.TableBody": {
- "props": [
- {
- "name": "cls",
+ "name": "tabPosition",
"type": "String",
- "desc": "element class",
- "memberOf": ""
+ "desc": "\"top\" or \"bottom\" (defaults to \"bottom\")",
+ "memberOf": "Roo.LayoutRegion",
+ "optvals": [
+ "top",
+ "bottom"
+ ]
},
{
- "name": "tag",
+ "name": "collapsedTitle",
"type": "String",
- "desc": "element tag (thead|tbody|tfoot) default tbody",
- "memberOf": ""
+ "desc": "Optional string message to display in the collapsed block of a north or south region",
+ "memberOf": "Roo.LayoutRegion"
},
{
- "name": "align",
- "type": "String",
- "desc": "Aligns the content inside the element",
- "memberOf": ""
+ "name": "alwaysShowTabs",
+ "type": "Boolean",
+ "desc": "True to always display tabs even when there is only 1 panel (defaults to false)",
+ "memberOf": "Roo.LayoutRegion"
},
{
- "name": "charoff",
- "type": "Number",
- "desc": "Sets the number of characters the content inside the element will be aligned from the character specified by the char attribute",
- "memberOf": ""
+ "name": "autoScroll",
+ "type": "Boolean",
+ "desc": "True to enable overflow scrolling (defaults to false)",
+ "memberOf": "Roo.LayoutRegion"
},
{
- "name": "valign",
- "type": "String",
- "desc": "Vertical aligns the content inside the <tbody> element",
- "memberOf": ""
+ "name": "titlebar",
+ "type": "Boolean",
+ "desc": "True to display a title bar (defaults to true)",
+ "memberOf": "Roo.LayoutRegion"
},
{
- "name": "style",
+ "name": "title",
"type": "String",
- "desc": "any extra css",
- "memberOf": "Roo.bootstrap.Component"
+ "desc": "The title for the region (overrides panel titles)",
+ "memberOf": "Roo.LayoutRegion"
},
{
- "name": "xattr",
- "type": "Object",
- "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "animate",
+ "type": "Boolean",
+ "desc": "True to animate expand/collapse (defaults to false)",
+ "memberOf": "Roo.LayoutRegion"
},
{
- "name": "can_build_overlaid",
+ "name": "autoHide",
"type": "Boolean",
- "desc": "True if element can be rebuild from a HTML page",
- "memberOf": "Roo.bootstrap.Component"
+ "desc": "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
+ "memberOf": "Roo.LayoutRegion"
},
{
- "name": "dataId",
- "type": "string",
- "desc": "cutomer id",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "preservePanels",
+ "type": "Boolean",
+ "desc": "True to preserve removed panels so they can be readded later (defaults to false)",
+ "memberOf": "Roo.LayoutRegion"
},
{
- "name": "name",
- "type": "string",
- "desc": "Specifies name attribute",
- "memberOf": "Roo.bootstrap.Component"
+ "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": "tooltip",
- "type": "string",
- "desc": "Text for the tooltip",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "hideTabs",
+ "type": "Boolean",
+ "desc": "True to hide the tab strip (defaults to false)",
+ "memberOf": "Roo.LayoutRegion"
},
{
- "name": "container_method",
- "type": "string",
- "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf": "Roo.bootstrap.Component"
+ "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": "disableClass",
- "type": "String",
- "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf": "Roo.Component"
+ "name": "minTabWidth",
+ "type": "Number",
+ "desc": "The minimum tab width (defaults to 40)",
+ "memberOf": "Roo.LayoutRegion"
},
{
- "name": "allowDomMove",
+ "name": "preferredTabWidth",
+ "type": "Number",
+ "desc": "The preferred tab width (defaults to 150)",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "showPin",
"type": "Boolean",
- "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf": "Roo.Component"
+ "desc": "True to show a pin button",
+ "memberOf": "Roo.LayoutRegion"
},
{
- "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": "hidden",
+ "type": "Boolean",
+ "desc": "True to start the region hidden (defaults to false)",
+ "memberOf": "Roo.LayoutRegion"
},
{
- "name": "actionMode",
- "type": "String",
- "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
- "memberOf": "Roo.Component"
+ "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",
],
"events": [
{
- "name": "beforedestroy",
+ "name": "beforecollapse",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ "desc": "Fires when this region before collapse."
},
{
- "name": "beforehide",
- "sig": "function (_self)\n{\n\n}",
+ "name": "beforeremove",
+ "sig": "function (_self, panel, e)\n{\n\n}",
"type": "function",
- "desc": "Fires before the component is hidden. Return false to stop the hide."
+ "desc": "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument."
},
{
- "name": "beforerender",
+ "name": "collapsed",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires before the component is rendered. Return false to stop the render."
+ "desc": "Fires when this region is collapsed."
},
{
- "name": "beforeshow",
+ "name": "expanded",
"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 region is expanded."
},
{
- "name": "childrenrendered",
+ "name": "invalidated",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the children have been rendered.."
+ "desc": "Fires when the layout for this region is changed."
},
{
- "name": "destroy",
- "sig": "function (_self)\n{\n\n}",
+ "name": "panelactivated",
+ "sig": "function (_self, panel)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is destroyed."
+ "desc": "Fires when a panel is activated."
},
{
- "name": "disable",
- "sig": "function (_self)\n{\n\n}",
+ "name": "paneladded",
+ "sig": "function (_self, panel)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is disabled."
+ "desc": "Fires when a panel is added."
},
{
- "name": "enable",
- "sig": "function (_self)\n{\n\n}",
+ "name": "panelremoved",
+ "sig": "function (_self, panel)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is enabled."
+ "desc": "Fires when a panel is removed."
},
{
- "name": "hide",
- "sig": "function (_self)\n{\n\n}",
+ "name": "resized",
+ "sig": "function (_self, newSize)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is hidden."
+ "desc": "Fires when the user resizes this region."
},
{
- "name": "render",
+ "name": "slidehide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is rendered."
+ "desc": "Fires when this region slides out of view."
},
{
- "name": "show",
+ "name": "slideshow",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is shown."
+ "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)",
"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": "()",
+ "name": "collapse",
+ "sig": "(Boolean skipAnim)",
"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": "Collapses this region."
},
{
- "name": "disable",
- "sig": "()",
+ "name": "expand",
+ "sig": "(Roo.EventObject e, Boolean skipAnim)",
"type": "function",
- "desc": "Disable this component."
+ "desc": "Expands this region if it was previously collapsed."
},
{
- "name": "enable",
+ "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": "Enable this component."
+ "desc": "Get the active panel for this region."
},
{
- "name": "fireEvent",
- "sig": "(String eventName, Object... args)",
+ "name": "getEl",
+ "sig": "()",
"type": "function",
- "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ "desc": "Returns the container element for this region."
},
{
- "name": "focus",
- "sig": "(Boolean selectText)",
+ "name": "getPanel",
+ "sig": "(Number/String/ContentPanel panel)",
"type": "function",
- "desc": "Try to focus this component."
+ "desc": "Returns the panel specified or null if it's not in this region."
},
{
- "name": "getChildContainer",
+ "name": "getPosition",
"sig": "()",
"type": "function",
- "desc": "Fetch the element to add children to"
+ "desc": "Returns this regions position (north/south/east/west/center)."
},
{
- "name": "getEl",
+ "name": "getSplitBar",
"sig": "()",
"type": "function",
- "desc": "Returns the underlying {@link Roo.Element}."
+ "desc": "Returns the {@link Roo.SplitBar} for this region."
},
{
- "name": "getId",
+ "name": "getTabs",
"sig": "()",
"type": "function",
- "desc": "Returns the id of this component."
+ "desc": "Returns the TabPanel component used by this region"
},
{
"name": "hasListener",
"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": "Hide a component - adds 'hidden' class"
+ "desc": "Hides this region."
},
{
- "name": "initEvents",
- "sig": "()",
+ "name": "hidePanel",
+ "sig": "(Number/String/ContentPanel panel)",
"type": "function",
- "desc": "Initialize Events for the element"
+ "desc": "Hides the tab for the specified panel."
},
{
"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)",
+ "name": "remove",
+ "sig": "(Number/String/ContentPanel panel, Boolean preservePanel)",
"type": "function",
- "desc": "Removes a listener"
+ "desc": "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed."
},
{
- "name": "render",
- "sig": "(String/HTMLElement/Element container)",
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
"type": "function",
- "desc": "If this is a lazy rendering component, render it to its container element."
+ "desc": "Removes a listener"
},
{
- "name": "setDisabled",
- "sig": "(Boolean disabled)",
+ "name": "resizeTo",
+ "sig": "(Number newSize)",
"type": "function",
- "desc": "Convenience function for setting disabled/enabled by boolean."
+ "desc": "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height."
},
{
- "name": "setVisible",
- "sig": "(Boolean visible)",
+ "name": "setCollapsedTitle",
+ "sig": "(String title)",
"type": "function",
- "desc": "Convenience function to hide or show this component by boolean."
+ "desc": "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)"
},
{
"name": "show",
"sig": "()",
"type": "function",
- "desc": "Show a component - removes 'hidden' class"
+ "desc": "Shows this region if it was previously hidden."
},
{
- "name": "tooltipEl",
- "sig": "()",
+ "name": "showPanel",
+ "sig": "(Number/String/ContentPanel panelId)",
"type": "function",
- "desc": "Fetch the element to display the tooltip on."
+ "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.TableCell": {
+ "Roo.bootstrap.menu": {
+ "props": [],
+ "events": [],
+ "methods": []
+ },
+ "Roo.bootstrap.menu.Item": {
"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": "submenu",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
- "name": "height",
- "type": "Number",
- "desc": "Sets the height of a cell",
+ "name": "html",
+ "type": "String",
+ "desc": "text of the item",
"memberOf": ""
},
{
- "name": "nowrap",
+ "name": "href",
"type": "String",
- "desc": "Specifies that the content inside a cell should not wrap",
+ "desc": "the link",
"memberOf": ""
},
{
- "name": "rowspan",
- "type": "Number",
- "desc": "Sets the number of rows a cell should span",
- "memberOf": ""
+ "name": "disable",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
},
{
- "name": "scope",
+ "name": "preventDefault",
+ "type": "Boolean",
+ "desc": "default true",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "icon",
"type": "String",
- "desc": "Defines a way to associate header cells and data cells in a table",
+ "desc": "Font awesome icon",
"memberOf": ""
},
{
- "name": "valign",
+ "name": "pos",
"type": "String",
- "desc": "Vertical aligns the content in a cell",
+ "desc": "Submenu align to (left | right) default right",
"memberOf": ""
},
{
- "name": "width",
- "type": "Number",
- "desc": "Specifies the width of a cell",
- "memberOf": ""
+ "name": "cls",
+ "type": "String",
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
},
{
"name": "style",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
"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 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": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
}
]
},
- "Roo.bootstrap.TableRow": {
+ "Roo.bootstrap.menu.Menu": {
"props": [
{
- "name": "cls",
+ "name": "html",
"type": "String",
- "desc": "row class",
+ "desc": "Text of the menu",
"memberOf": ""
},
{
- "name": "align",
+ "name": "weight",
"type": "String",
- "desc": "Aligns the content in a table row",
- "memberOf": ""
+ "desc": "",
+ "memberOf": "",
+ "optvals": [
+ "default",
+ "primary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "inverse"
+ ]
},
{
- "name": "bgcolor",
+ "name": "icon",
"type": "String",
- "desc": "Specifies a background color for a table row",
+ "desc": "Font awesome icon",
"memberOf": ""
},
{
- "name": "charoff",
- "type": "Number",
- "desc": "Sets the number of characters the content will be aligned from the character specified by the char attribute",
+ "name": "pos",
+ "type": "String",
+ "desc": "Menu align to (top | bottom) default bottom",
"memberOf": ""
},
{
- "name": "valign",
+ "name": "cls",
"type": "String",
- "desc": "Vertical aligns the content in a table row",
- "memberOf": ""
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
},
{
"name": "style",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"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, 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": "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": [
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
}
]
},
- "Roo.bootstrap.TextArea": {
+ "Roo.bootstrap.menu.Separator": {
"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": "fieldLabel",
- "type": "String",
- "desc": "- the label associated",
- "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": "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",
- "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": "cutomer id",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "name",
+ "type": "string",
+ "desc": "Specifies name attribute",
+ "memberOf": "Roo.bootstrap.Component"
+ },
{
"name": "tooltip",
"type": "string",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"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}",
"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": "()",
"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."
+ "desc": "Fetch the element to add children to"
},
{
- "name": "getName",
+ "name": "getEl",
"sig": "()",
"type": "function",
- "desc": "Returns the name of the field"
+ "desc": "Returns the underlying {@link Roo.Element}."
},
{
- "name": "getRawValue",
+ "name": "getId",
"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}."
+ "desc": "Returns the id of this component."
},
{
- "name": "getValue",
+ "name": "getVisibilityEl",
"sig": "()",
"type": "function",
- "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
+ "desc": "Get the element that will be used to show or hide"
},
{
"name": "hasListener",
"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.panel": {
+ "props": [],
+ "events": [],
+ "methods": []
+ },
+ "Roo.bootstrap.panel.Content": {
"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": "fitToFrame",
+ "type": "Boolean",
+ "desc": "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
"memberOf": ""
},
{
- "name": "disabled",
+ "name": "fitContainer",
"type": "Boolean",
- "desc": "is it disabled",
- "memberOf": "Roo.bootstrap.Input"
- },
- {
- "name": "fieldLabel",
- "type": "String",
- "desc": "- the label associated",
- "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": "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"
+ "desc": "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
+ "memberOf": ""
},
{
- "name": "xs",
- "type": "Number",
- "desc": "colspan out of 12 for mobile-sized screens",
- "memberOf": "Roo.bootstrap.Input"
+ "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": "sm",
- "type": "Number",
- "desc": "colspan out of 12 for tablet-sized screens",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "closable",
+ "type": "Boolean",
+ "desc": "True if the panel can be closed/removed",
+ "memberOf": ""
},
{
- "name": "md",
- "type": "Number",
- "desc": "colspan out of 12 for computer-sized screens",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "background",
+ "type": "Boolean",
+ "desc": "True if the panel should not be activated when it is added (defaults to false)",
+ "memberOf": ""
},
{
- "name": "lg",
- "type": "Number",
- "desc": "colspan out of 12 for large computer-sized screens",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "resizeEl",
+ "type": "String/HTMLElement/Element",
+ "desc": "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
+ "memberOf": ""
},
{
- "name": "value",
- "type": "string",
- "desc": "default value of the input",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "toolbar",
+ "type": "Toolbar",
+ "desc": "A toolbar for this panel",
+ "memberOf": ""
},
{
- "name": "labelWidth",
- "type": "Number",
- "desc": "set the width of label (0-12)",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "autoScroll",
+ "type": "Boolean",
+ "desc": "True to scroll overflow in this panel (use with {@link #fitToFrame})",
+ "memberOf": ""
},
{
- "name": "labelAlign",
+ "name": "title",
"type": "String",
- "desc": "",
- "memberOf": "Roo.bootstrap.Input",
- "optvals": [
- "top",
- "left"
- ]
+ "desc": "The title for this panel",
+ "memberOf": ""
},
{
- "name": "readOnly",
- "type": "Boolean",
- "desc": "Specifies that the field should be read-only",
- "memberOf": "Roo.bootstrap.Input"
+ "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": "autocomplete",
+ "name": "url",
"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": "Calls {@link #setUrl} with this value",
+ "memberOf": ""
},
{
- "name": "align",
+ "name": "region",
"type": "String",
- "desc": "Default left",
- "memberOf": "Roo.bootstrap.Input",
+ "desc": "which region to put this panel on (when used with xtype constructors)",
+ "memberOf": "",
"optvals": [
- "left",
"center",
- "right"
- ]
- },
- {
- "name": "forceFeedback",
- "type": "Boolean",
- "desc": "Default false",
- "memberOf": "Roo.bootstrap.Input",
- "optvals": [
- "true",
- "false"
+ "north",
+ "south",
+ "east",
+ "west"
]
},
{
- "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": "params",
+ "type": "String/Object",
+ "desc": "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf": ""
},
{
- "name": "validateOnBlur",
+ "name": "loadOnce",
"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"
+ "desc": "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf": ""
},
{
- "name": "focusClass",
+ "name": "content",
"type": "String",
- "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "Raw content to fill content panel with (uses setContent on construction.)",
+ "memberOf": ""
},
{
- "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": "badges",
+ "type": "Boolean",
+ "desc": "render the badges",
+ "memberOf": ""
},
{
- "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": "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": "hasFeedback",
- "type": "Boolean",
- "desc": "default true",
- "memberOf": "Roo.bootstrap.Input",
- "optvals": [
- "true",
- "false"
- ]
+ "name": "activate",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this panel is activated."
},
{
- "name": "invalidFeedbackIcon",
- "type": "String",
- "desc": "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "deactivate",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this panel is activated."
},
{
- "name": "validFeedbackIcon",
- "type": "String",
- "desc": "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this tab is created"
},
{
- "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": "resize",
+ "sig": "function (_self, width, height)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this panel is resized if fitToFrame is true."
+ }
+ ],
+ "methods": [
{
- "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": "addEvents",
+ "sig": "(Object object)",
+ "type": "function",
+ "desc": "Used to define events on this Observable"
},
{
- "name": "vtype",
- "type": "String",
- "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this component"
},
{
- "name": "disableKeyFilter",
- "type": "Boolean",
- "desc": "True to disable input keystroke filtering (defaults to false)",
- "memberOf": "Roo.bootstrap.Input"
+ "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": "allowBlank",
- "type": "Boolean",
- "desc": "False to validate that the value length > 0 (defaults to true)",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "destroy",
+ "sig": "()",
+ "type": "function",
+ "desc": "Destroys this panel"
},
{
- "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": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "minLength",
- "type": "Number",
- "desc": "Minimum input field length required (defaults to 0)",
- "memberOf": "Roo.bootstrap.Input"
+ "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": "maxLength",
- "type": "Number",
- "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "getEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns this panel's element - used by regiosn to add."
},
{
- "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": "getId",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns this panel's id"
},
{
- "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": "getTitle",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns this panel's title"
},
{
- "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": "getToolbar",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the toolbar for this Panel if one was configured."
},
{
- "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": "getUpdateManager",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates."
},
{
- "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": "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": "isClosable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true is this panel was configured to be closable"
},
{
- "name": "style",
- "type": "String",
- "desc": "any extra css",
- "memberOf": "Roo.bootstrap.Component"
+ "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": "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": "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": "tooltip",
- "type": "string",
- "desc": "Text for the tooltip",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
},
{
- "name": "container_method",
- "type": "string",
- "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
},
{
- "name": "disableClass",
- "type": "String",
- "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf": "Roo.Component"
+ "name": "setContent",
+ "sig": "(String content, Boolean loadScripts)",
+ "type": "function",
+ "desc": "Updates this panel's element"
},
{
- "name": "allowDomMove",
- "type": "Boolean",
- "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf": "Roo.Component"
+ "name": "setTitle",
+ "sig": "(String title)",
+ "type": "function",
+ "desc": "Set this panel's title"
},
{
- "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": "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": "actionMode",
- "type": "String",
- "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
- "memberOf": "Roo.Component"
+ "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": "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": "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": "beforedestroy",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ "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": "beforehide",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires before the component is hidden. Return false to stop the hide."
+ "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": "beforerender",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires before the component is rendered. Return false to stop the render."
+ "name": "closable",
+ "type": "Boolean",
+ "desc": "True if the panel can be closed/removed",
+ "memberOf": "Roo.bootstrap.panel.Content"
},
{
- "name": "beforeshow",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires before the component is shown. Return false to stop the show."
+ "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": "blur",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when this field loses input focus."
+ "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": "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": "toolbar",
+ "type": "Toolbar",
+ "desc": "A toolbar for this panel",
+ "memberOf": "Roo.bootstrap.panel.Content"
},
{
- "name": "childrenrendered",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the children have been rendered.."
+ "name": "autoScroll",
+ "type": "Boolean",
+ "desc": "True to scroll overflow in this panel (use with {@link #fitToFrame})",
+ "memberOf": "Roo.bootstrap.panel.Content"
},
{
- "name": "destroy",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is destroyed."
+ "name": "title",
+ "type": "String",
+ "desc": "The title for this panel",
+ "memberOf": "Roo.bootstrap.panel.Content"
},
{
- "name": "disable",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is disabled."
+ "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": "enable",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is enabled."
+ "name": "url",
+ "type": "String",
+ "desc": "Calls {@link #setUrl} with this value",
+ "memberOf": "Roo.bootstrap.panel.Content"
},
{
- "name": "focus",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when this field receives input focus."
+ "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": "hide",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is hidden."
+ "name": "params",
+ "type": "String/Object",
+ "desc": "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf": "Roo.bootstrap.panel.Content"
},
{
- "name": "invalid",
- "sig": "function (_self, msg)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the field has been marked as invalid."
+ "name": "loadOnce",
+ "type": "Boolean",
+ "desc": "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf": "Roo.bootstrap.panel.Content"
},
{
- "name": "keyup",
- "sig": "function (_self, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the key up"
+ "name": "content",
+ "type": "String",
+ "desc": "Raw content to fill content panel with (uses setContent on construction.)",
+ "memberOf": "Roo.bootstrap.panel.Content"
},
{
- "name": "render",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is rendered."
+ "name": "badges",
+ "type": "Boolean",
+ "desc": "render the badges",
+ "memberOf": "Roo.bootstrap.panel.Content"
},
{
- "name": "select",
- "sig": "function (_self, date)\n{\n\n}",
+ "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 select a date."
+ "desc": "Fires when this panel is activated."
},
{
- "name": "show",
- "sig": "function (thisthis, date)\n{\n\n}",
+ "name": "deactivate",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when this field show."
+ "desc": "Fires when this panel is activated."
},
{
- "name": "specialkey",
- "sig": "function (_self, e)\n{\n\n}",
+ "name": "render",
+ "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 when this tab is created"
},
{
- "name": "valid",
- "sig": "function (_self)\n{\n\n}",
+ "name": "resize",
+ "sig": "function (_self, width, height)\n{\n\n}",
"type": "function",
- "desc": "Fires after the field has been validated with no errors."
+ "desc": "Fires when this panel is resized if fitToFrame is true."
}
],
"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": "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."
+ "desc": "Destroys this panel"
},
{
"name": "fireEvent",
"desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "focus",
- "sig": "(Boolean selectText)",
+ "name": "getChildContainer",
+ "sig": "(Object cfg)",
"type": "function",
- "desc": "Try to focus this component."
+ "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": "getChildContainer",
+ "name": "getEl",
"sig": "()",
"type": "function",
- "desc": "Fetch the element to add children to"
+ "desc": "Returns this panel's element - used by regiosn to add."
},
{
- "name": "getEl",
+ "name": "getGrid",
"sig": "()",
"type": "function",
- "desc": "Returns the underlying {@link Roo.Element}."
+ "desc": "Returns the grid for this panel"
},
{
"name": "getId",
"sig": "()",
"type": "function",
- "desc": "Returns the id of this component."
+ "desc": "Returns this panel's id"
},
{
- "name": "getName",
+ "name": "getTitle",
"sig": "()",
"type": "function",
- "desc": "Returns the name of the field"
+ "desc": "Returns this panel's title"
},
{
- "name": "getRawValue",
+ "name": "getToolbar",
"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}."
+ "desc": "Returns the toolbar for this Panel if one was configured."
},
{
- "name": "getValue",
+ "name": "getUpdateManager",
"sig": "()",
"type": "function",
- "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
+ "desc": "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates."
},
{
"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": "()",
- "type": "function",
- "desc": "Initialize Events for the element"
- },
- {
- "name": "inputEl",
- "sig": "()",
- "type": "function",
- "desc": "return the real input element."
- },
- {
- "name": "isVisible",
+ "name": "isClosable",
"sig": "()",
"type": "function",
- "desc": "Returns true if this component is visible."
- },
- {
- "name": "markInvalid",
- "sig": "(String msg)",
- "type": "function",
- "desc": "Mark this field as invalid"
+ "desc": "Returns true is this panel was configured to be closable"
},
{
- "name": "markValid",
- "sig": "()",
+ "name": "load",
+ "sig": "(Object/String/Function url, String/Object params, Function callback, Boolean discardUrl)",
"type": "function",
- "desc": "Mark this field as valid"
+ "desc": "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}."
},
{
"name": "on",
"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)",
"desc": "Removes a listener"
},
{
- "name": "render",
- "sig": "(String/HTMLElement/Element container)",
+ "name": "setContent",
+ "sig": "(String content, Boolean loadScripts)",
"type": "function",
- "desc": "If this is a lazy rendering component, render it to its container element."
+ "desc": "Updates this panel's element"
},
{
- "name": "reset",
- "sig": "()",
+ "name": "setTitle",
+ "sig": "(String title)",
"type": "function",
- "desc": "Resets the current field value to the originally loaded value and clears any validation messages"
+ "desc": "Set this panel's title"
},
{
- "name": "setDisabled",
- "sig": "(Boolean disabled)",
+ "name": "setUrl",
+ "sig": "(String/Function url, String/Object params, Boolean loadOnce)",
"type": "function",
- "desc": "Convenience function for setting disabled/enabled by boolean."
+ "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": "setRawValue",
- "sig": "(Mixed value)",
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
"type": "function",
- "desc": "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}."
+ "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": "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": "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": "setVisible",
- "sig": "(Boolean visible)",
- "type": "function",
- "desc": "Convenience function to hide or show this component by boolean."
+ "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": "show",
- "sig": "()",
- "type": "function",
- "desc": "Show a component - removes 'hidden' class"
+ "name": "closable",
+ "type": "Boolean",
+ "desc": "True if the panel can be closed/removed",
+ "memberOf": "Roo.bootstrap.panel.Content"
},
{
- "name": "tooltipEl",
- "sig": "()",
- "type": "function",
- "desc": "Fetch the element to display the tooltip on."
+ "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": "un",
- "sig": "(String eventName, Function handler, Object scope)",
- "type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
+ "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": "validate",
- "sig": "()",
- "type": "function",
- "desc": "Validates the field value"
+ "name": "toolbar",
+ "type": "Toolbar",
+ "desc": "A toolbar for this panel",
+ "memberOf": "Roo.bootstrap.panel.Content"
},
{
- "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.Tooltip": {
- "props": [],
- "events": [],
- "methods": [
+ "name": "autoScroll",
+ "type": "Boolean",
+ "desc": "True to scroll overflow in this panel (use with {@link #fitToFrame})",
+ "memberOf": "Roo.bootstrap.panel.Content"
+ },
{
- "name": "currentEl",
- "sig": "()",
- "type": "function",
- "desc": ""
- }
- ]
- },
- "Roo.bootstrap.TriggerField": {
- "props": [
+ "name": "title",
+ "type": "String",
+ "desc": "The title for this panel",
+ "memberOf": "Roo.bootstrap.panel.Content"
+ },
{
- "name": "triggerClass",
+ "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": "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": ""
+ "desc": "Calls {@link #setUrl} with this value",
+ "memberOf": "Roo.bootstrap.panel.Content"
},
{
- "name": "caret",
+ "name": "region",
"type": "String",
- "desc": "a fontawesome for the trigger icon see http://fortawesome.github.io/Font-Awesome/icons/",
- "memberOf": "",
+ "desc": "which region to put this panel on (when used with xtype constructors)",
+ "memberOf": "Roo.bootstrap.panel.Content",
"optvals": [
- "search",
- "calendar"
+ "center",
+ "north",
+ "south",
+ "east",
+ "west"
]
},
{
- "name": "hideTrigger",
- "type": "Boolean",
- "desc": "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf": ""
+ "name": "params",
+ "type": "String/Object",
+ "desc": "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf": "Roo.bootstrap.panel.Content"
},
{
- "name": "removable",
+ "name": "loadOnce",
"type": "Boolean",
- "desc": "special filter default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "desc": "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf": "Roo.bootstrap.panel.Content"
},
{
- "name": "disabled",
+ "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": "is it disabled",
- "memberOf": "Roo.bootstrap.Input"
+ "desc": "render the badges",
+ "memberOf": "Roo.bootstrap.panel.Content"
},
{
- "name": "fieldLabel",
- "type": "String",
- "desc": "- the label associated",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "activate",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this panel is activated."
},
{
- "name": "inputType",
- "type": "String",
- "desc": "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "deactivate",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this panel is activated."
},
{
- "name": "name",
- "type": "String",
- "desc": "name of the input",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this tab is created"
},
{
- "name": "placeholder",
- "type": "string",
- "desc": "- placeholder to put in text.",
- "memberOf": "Roo.bootstrap.Input"
+ "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": "before",
- "type": "string",
- "desc": "- input group add on before",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this component"
},
{
- "name": "after",
- "type": "string",
- "desc": "- input group add on after",
- "memberOf": "Roo.bootstrap.Input"
+ "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": "size",
- "type": "string",
- "desc": "- (lg|sm) or leave empty..",
- "memberOf": "Roo.bootstrap.Input"
+ "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": "xs",
- "type": "Number",
- "desc": "colspan out of 12 for mobile-sized screens",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "destroy",
+ "sig": "()",
+ "type": "function",
+ "desc": "Destroys this panel"
},
{
- "name": "sm",
- "type": "Number",
- "desc": "colspan out of 12 for tablet-sized screens",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "md",
- "type": "Number",
- "desc": "colspan out of 12 for computer-sized screens",
- "memberOf": "Roo.bootstrap.Input"
+ "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": "lg",
- "type": "Number",
- "desc": "colspan out of 12 for large computer-sized screens",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "getEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns this panel's element - used by regiosn to add."
},
{
- "name": "value",
- "type": "string",
- "desc": "default value of the input",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "getId",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns this panel's id"
},
{
- "name": "labelWidth",
- "type": "Number",
- "desc": "set the width of label (0-12)",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "getLayout",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the nested BorderLayout for this panel"
},
{
- "name": "labelAlign",
- "type": "String",
- "desc": "",
- "memberOf": "Roo.bootstrap.Input",
- "optvals": [
- "top",
- "left"
- ]
+ "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": "readOnly",
- "type": "Boolean",
- "desc": "Specifies that the field should be read-only",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "isClosable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true is this panel was configured to be closable"
},
{
- "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": "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": "align",
- "type": "String",
- "desc": "Default left",
- "memberOf": "Roo.bootstrap.Input",
- "optvals": [
- "left",
- "center",
- "right"
- ]
+ "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": "forceFeedback",
- "type": "Boolean",
- "desc": "Default false",
- "memberOf": "Roo.bootstrap.Input",
- "optvals": [
- "true",
- "false"
- ]
+ "name": "purgeListeners",
+ "sig": "()",
+ "type": "function",
+ "desc": "Removes all listeners for this object"
},
{
- "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": "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": "validateOnBlur",
- "type": "Boolean",
- "desc": "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
},
{
- "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": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
},
{
- "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": "setContent",
+ "sig": "(String content, Boolean loadScripts)",
+ "type": "function",
+ "desc": "Updates this panel's element"
},
{
- "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": "setTitle",
+ "sig": "(String title)",
+ "type": "function",
+ "desc": "Set this panel's title"
},
{
- "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": "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": "hasFeedback",
- "type": "Boolean",
- "desc": "default true",
- "memberOf": "Roo.bootstrap.Input",
- "optvals": [
- "true",
- "false"
- ]
+ "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": "invalidFeedbackIcon",
- "type": "String",
- "desc": "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf": "Roo.bootstrap.Input"
+ "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": "validFeedbackIcon",
- "type": "String",
- "desc": "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "close",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this tab is closed."
},
{
- "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": "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": "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": "addEvents",
+ "sig": "(Object object)",
+ "type": "function",
+ "desc": "Used to define events on this Observable"
},
{
- "name": "vtype",
- "type": "String",
- "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this component"
},
{
- "name": "disableKeyFilter",
- "type": "Boolean",
- "desc": "True to disable input keystroke filtering (defaults to false)",
- "memberOf": "Roo.bootstrap.Input"
+ "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": "allowBlank",
- "type": "Boolean",
- "desc": "False to validate that the value length > 0 (defaults to true)",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "disable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Disables this TabPanelItem -- this does nothing if this is the active TabPanelItem."
},
{
- "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": "enable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Enables this TabPanelItem if it was previously disabled."
},
{
- "name": "minLength",
- "type": "Number",
- "desc": "Minimum input field length required (defaults to 0)",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "maxLength",
- "type": "Number",
- "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf": "Roo.bootstrap.Input"
+ "name": "getText",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the text for this tab"
},
{
- "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": "getUpdateManager",
+ "sig": "()",
+ "type": "function",
+ "desc": "Gets the {@link Roo.UpdateManager} for the body of this TabPanelItem. Enables you to perform Ajax updates."
},
{
- "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": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "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": "hide",
+ "sig": "()",
+ "type": "function",
+ "desc": "Hides this TabPanelItem -- if you don't activate another TabPanelItem this could look odd."
},
{
- "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": "isActive",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if this tab is the active tab."
},
{
- "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": "isHidden",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if this tab is \"hidden\""
},
{
- "name": "cls",
- "type": "String",
- "desc": "css class",
- "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": "style",
- "type": "String",
- "desc": "any extra css",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "purgeListeners",
+ "sig": "()",
+ "type": "function",
+ "desc": "Removes all listeners for this object"
},
{
- "name": "xattr",
- "type": "Object",
- "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf": "Roo.bootstrap.Component"
+ "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": "can_build_overlaid",
- "type": "Boolean",
- "desc": "True if element can be rebuild from a HTML page",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
},
{
- "name": "dataId",
- "type": "string",
- "desc": "cutomer id",
- "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": "setContent",
+ "sig": "(String content, Boolean loadScripts)",
+ "type": "function",
+ "desc": "Sets the content for this TabPanelItem."
},
{
- "name": "container_method",
- "type": "string",
- "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "setHidden",
+ "sig": "(Boolean hidden)",
+ "type": "function",
+ "desc": "Show or hide the tab"
},
{
- "name": "disableClass",
- "type": "String",
- "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf": "Roo.Component"
+ "name": "setText",
+ "sig": "(String text)",
+ "type": "function",
+ "desc": "Sets the text for the tab (Note: this also sets the tooltip text)"
},
{
- "name": "allowDomMove",
- "type": "Boolean",
- "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf": "Roo.Component"
+ "name": "setTooltip",
+ "sig": "(String tooltip)",
+ "type": "function",
+ "desc": "Set the tooltip for the tab."
},
{
- "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": "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": "actionMode",
- "type": "String",
- "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
- "memberOf": "Roo.Component"
+ "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",
],
"events": [
{
- "name": "beforedestroy",
- "sig": "function (_self)\n{\n\n}",
+ "name": "beforetabchange",
+ "sig": "function (_self, e, tab)\n{\n\n}",
"type": "function",
- "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ "desc": "Fires before the active tab changes, set cancel to true on the \"e\" parameter to cancel the change"
},
{
- "name": "beforehide",
- "sig": "function (_self)\n{\n\n}",
+ "name": "tabchange",
+ "sig": "function (_self, activePanel)\n{\n\n}",
"type": "function",
- "desc": "Fires before the component is hidden. Return false to stop the hide."
+ "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": "beforerender",
- "sig": "function (_self)\n{\n\n}",
+ "name": "addEvents",
+ "sig": "(Object object)",
"type": "function",
- "desc": "Fires before the component is rendered. Return false to stop the render."
+ "desc": "Used to define events on this Observable"
},
{
- "name": "beforeshow",
- "sig": "function (_self)\n{\n\n}",
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "Fires before the component is shown. Return false to stop the show."
+ "desc": "Appends an event handler to this component"
},
{
- "name": "blur",
- "sig": "function (_self)\n{\n\n}",
+ "name": "addTab",
+ "sig": "(String id, String text, String content, Boolean closable)",
"type": "function",
- "desc": "Fires when this field loses input focus."
+ "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": "change",
- "sig": "function (_self, newValue, oldValue)\n{\n\n}",
+ "name": "addTabItem",
+ "sig": "(Roo.TabPanelItem item)",
"type": "function",
- "desc": "Fires just before the field blurs if the field value has changed."
+ "desc": "Adds an existing {@link Roo.TabPanelItem}."
},
{
- "name": "childrenrendered",
- "sig": "function (_self)\n{\n\n}",
+ "name": "autoSizeTabs",
+ "sig": "()",
"type": "function",
- "desc": "Fires when the children have been rendered.."
+ "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": "function (_self)\n{\n\n}",
+ "sig": "(Boolean removeEl)",
"type": "function",
- "desc": "Fires after the component is destroyed."
+ "desc": "Destroys this TabPanel"
},
{
- "name": "disable",
- "sig": "function (_self)\n{\n\n}",
+ "name": "disableTab",
+ "sig": "(String/Number id)",
"type": "function",
- "desc": "Fires after the component is disabled."
+ "desc": "Disables a {@link Roo.TabPanelItem}. It cannot be the active tab, if it is this call is ignored."
},
{
- "name": "enable",
- "sig": "function (_self)\n{\n\n}",
+ "name": "enableTab",
+ "sig": "(String/Number id)",
"type": "function",
- "desc": "Fires after the component is enabled."
+ "desc": "Enables a {@link Roo.TabPanelItem} that is disabled."
},
{
- "name": "focus",
- "sig": "function (_self)\n{\n\n}",
+ "name": "endUpdate",
+ "sig": "()",
"type": "function",
- "desc": "Fires when this field receives input focus."
+ "desc": "Stops an update and resizes the tabs (if {@link #resizeTabs} is false this does nothing)"
},
{
- "name": "hide",
- "sig": "function (_self)\n{\n\n}",
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
"type": "function",
- "desc": "Fires after the component is hidden."
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "invalid",
- "sig": "function (_self, msg)\n{\n\n}",
+ "name": "getActiveTab",
+ "sig": "()",
"type": "function",
- "desc": "Fires after the field has been marked as invalid."
+ "desc": "Gets the active {@link Roo.TabPanelItem}."
},
{
- "name": "keyup",
- "sig": "function (_self, e)\n{\n\n}",
+ "name": "getCount",
+ "sig": "()",
"type": "function",
- "desc": "Fires after the key up"
+ "desc": "Returns the number of tabs in this TabPanel."
},
{
- "name": "render",
- "sig": "function (_self)\n{\n\n}",
+ "name": "getTab",
+ "sig": "(String/Number id)",
"type": "function",
- "desc": "Fires after the component is rendered."
+ "desc": "Returns the {@link Roo.TabPanelItem} with the specified id/index"
},
{
- "name": "show",
- "sig": "function (_self)\n{\n\n}",
+ "name": "hasListener",
+ "sig": "(String eventName)",
"type": "function",
- "desc": "Fires after the component is shown."
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "specialkey",
- "sig": "function (_self, e)\n{\n\n}",
+ "name": "hideTab",
+ "sig": "(String/Number id)",
"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": "Hides the {@link Roo.TabPanelItem} with the specified id/index"
},
{
- "name": "valid",
- "sig": "function (_self)\n{\n\n}",
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "Fires after the field has been validated with no errors."
- }
- ],
- "methods": [
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
+ },
{
- "name": "addEvents",
- "sig": "(Object object)",
+ "name": "purgeListeners",
+ "sig": "()",
"type": "function",
- "desc": "Used to define events on this Observable"
+ "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": "addListener",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "name": "syncHeight",
+ "sig": "(Number targetHeight)",
"type": "function",
- "desc": "Appends an event handler to this component"
+ "desc": "Updates the tab body element to fit the height of the container element\nfor overflow scrolling"
},
{
- "name": "capture",
- "sig": "(Observable o, Function fn, Object scope)",
+ "name": "un",
+ "sig": "(String eventName, Function handler, 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."
+ "desc": "Removes a listener (shorthand for removeListener)"
},
{
- "name": "clearInvalid",
- "sig": "()",
+ "name": "unhideTab",
+ "sig": "(String/Number id)",
"type": "function",
- "desc": "Clear any invalid styles/messages for this field"
- },
+ "desc": "\"Unhides\" the {@link Roo.TabPanelItem} with the specified id/index."
+ }
+ ]
+ },
+ "Roo.data": {
+ "props": [],
+ "events": [],
+ "methods": []
+ },
+ "Roo.data.ArrayReader": {
+ "props": [
{
- "name": "destroy",
- "sig": "()",
+ "name": "id",
+ "type": "String",
+ "desc": "(optional) The subscript within row Array that provides an ID for the Record",
+ "memberOf": ""
+ }
+ ],
+ "events": [],
+ "methods": [
+ {
+ "name": "newRow",
+ "sig": "(Object data)",
"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": "Create an empty record"
},
{
- "name": "disable",
- "sig": "()",
+ "name": "readRecords",
+ "sig": "(Object o)",
"type": "function",
- "desc": "Disable this component."
+ "desc": "Create a data block containing Roo.data.Records from an XML document."
+ }
+ ]
+ },
+ "Roo.data.Connection": {
+ "props": [
+ {
+ "name": "url",
+ "type": "String",
+ "desc": "(Optional) The default URL to be used for requests to the server. (defaults to undefined)",
+ "memberOf": ""
},
{
- "name": "enable",
- "sig": "()",
- "type": "function",
- "desc": "Enable this component."
+ "name": "extraParams",
+ "type": "Object",
+ "desc": "(Optional) An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)",
+ "memberOf": ""
},
{
- "name": "fireEvent",
- "sig": "(String eventName, Object... args)",
- "type": "function",
- "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ "name": "defaultHeaders",
+ "type": "Object",
+ "desc": "(Optional) An object containing request headers which are added\n to each request made by this object. (defaults to undefined)",
+ "memberOf": ""
},
{
- "name": "focus",
- "sig": "(Boolean selectText)",
- "type": "function",
- "desc": "Try to focus this component."
+ "name": "method",
+ "type": "String",
+ "desc": "(Optional) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)",
+ "memberOf": ""
},
{
- "name": "getChildContainer",
- "sig": "()",
- "type": "function",
- "desc": "Fetch the element to add children to"
+ "name": "timeout",
+ "type": "Number",
+ "desc": "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)",
+ "memberOf": ""
},
{
- "name": "getEl",
- "sig": "()",
- "type": "function",
- "desc": "Returns the underlying {@link Roo.Element}."
+ "name": "autoAbort",
+ "type": "Boolean",
+ "desc": "(Optional) Whether this request should abort any pending requests. (defaults to false)",
+ "memberOf": ""
},
{
- "name": "getId",
- "sig": "()",
- "type": "function",
- "desc": "Returns the id of this component."
+ "name": "disableCaching",
+ "type": "Boolean",
+ "desc": "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)",
+ "memberOf": ""
},
{
- "name": "getName",
- "sig": "()",
+ "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": "beforerequest",
+ "sig": "function (conn, options)\n{\n\n}",
"type": "function",
- "desc": "Returns the name of the field"
+ "desc": "Fires before a network request is made to retrieve a data object."
},
{
- "name": "getRawValue",
- "sig": "()",
+ "name": "requestcomplete",
+ "sig": "function (conn, response, options)\n{\n\n}",
"type": "function",
- "desc": "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}."
+ "desc": "Fires if the request was successfully completed."
},
{
- "name": "getValue",
- "sig": "()",
+ "name": "requestexception",
+ "sig": "function (conn, response, options)\n{\n\n}",
"type": "function",
- "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
- },
+ "desc": "Fires if an error HTTP status was returned from the server.\nSee {@link http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html} for details of HTTP status codes."
+ }
+ ],
+ "methods": [
{
- "name": "hasListener",
- "sig": "(String eventName)",
+ "name": "abort",
+ "sig": "(Number transactionId)",
"type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
+ "desc": "Aborts any outstanding request."
},
{
- "name": "hide",
- "sig": "()",
+ "name": "addEvents",
+ "sig": "(Object object)",
"type": "function",
- "desc": "Hide a component - adds 'hidden' class"
+ "desc": "Used to define events on this Observable"
},
{
- "name": "initEvents",
- "sig": "()",
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "Initialize Events for the element"
+ "desc": "Appends an event handler to this component"
},
{
- "name": "inputEl",
- "sig": "()",
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
"type": "function",
- "desc": "return the real input element."
+ "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": "isVisible",
- "sig": "()",
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
"type": "function",
- "desc": "Returns true if this component is visible."
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "markInvalid",
- "sig": "(String msg)",
+ "name": "hasListener",
+ "sig": "(String eventName)",
"type": "function",
- "desc": "Mark this field as invalid"
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "markValid",
- "sig": "()",
+ "name": "isLoading",
+ "sig": "(Number transactionId)",
"type": "function",
- "desc": "Mark this field as valid"
+ "desc": "Determine whether this object has a request outstanding."
},
{
"name": "on",
"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": "()",
"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": "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)",
+ "name": "request",
+ "sig": "(Object options)",
"type": "function",
- "desc": "Convenience function to hide or show this component by boolean."
+ "desc": "Sends an HTTP request to a remote server."
},
{
- "name": "show",
- "sig": "()",
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
"type": "function",
- "desc": "Show a component - removes 'hidden' class"
- },
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.data.DataProxy": {
+ "props": [],
+ "events": [
{
- "name": "tooltipEl",
- "sig": "()",
+ "name": "beforeload",
+ "sig": "function (This, params)\n{\n\n}",
"type": "function",
- "desc": "Fetch the element to display the tooltip on."
+ "desc": "Fires before a network request is made to retrieve a data object."
},
{
- "name": "un",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "load",
+ "sig": "function (This, o, arg)\n{\n\n}",
"type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
+ "desc": "Fires before the load method's callback is called."
},
{
- "name": "validate",
- "sig": "()",
+ "name": "loadexception",
+ "sig": "function (This, o, arg, e)\n{\n\n}",
"type": "function",
- "desc": "Validates the field value"
- },
+ "desc": "Fires if an Exception occurs during data retrieval."
+ }
+ ],
+ "methods": []
+ },
+ "Roo.data.DataReader": {
+ "props": [],
+ "events": [],
+ "methods": [
{
- "name": "validateValue",
- "sig": "(Mixed value)",
+ "name": "newRow",
+ "sig": "(Object data)",
"type": "function",
- "desc": "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails"
+ "desc": "Create an empty record"
}
]
},
- "Roo.bootstrap.UploadCropbox": {
+ "Roo.data.HttpProxy": {
"props": [
{
- "name": "emptyText",
+ "name": "url",
"type": "String",
- "desc": "show when image has been loaded",
+ "desc": "(Optional) The default URL to be used for requests to the server. (defaults to undefined)",
"memberOf": ""
},
{
- "name": "rotateNotify",
- "type": "String",
- "desc": "show when image too small to rotate",
+ "name": "extraParams",
+ "type": "Object",
+ "desc": "(Optional) An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)",
"memberOf": ""
},
{
- "name": "errorTimeout",
- "type": "Number",
- "desc": "default 3000",
+ "name": "defaultHeaders",
+ "type": "Object",
+ "desc": "(Optional) An object containing request headers which are added\n to each request made by this object. (defaults to undefined)",
"memberOf": ""
},
{
- "name": "minWidth",
- "type": "Number",
- "desc": "default 300",
+ "name": "method",
+ "type": "String",
+ "desc": "(Optional) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)",
"memberOf": ""
},
{
- "name": "minHeight",
+ "name": "timeout",
"type": "Number",
- "desc": "default 300",
+ "desc": "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)",
"memberOf": ""
},
{
- "name": "buttons",
- "type": "Array",
- "desc": "default ['rotateLeft', 'pictureBtn', 'rotateRight']",
+ "name": "autoAbort",
+ "type": "Boolean",
+ "desc": "(Optional) Whether this request should abort any pending requests. (defaults to false)",
"memberOf": ""
},
{
- "name": "isDocument",
+ "name": "disableCaching",
"type": "Boolean",
- "desc": "default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
- },
- {
- "name": "url",
- "type": "String",
- "desc": "action url",
+ "desc": "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)",
"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"
- },
+ }
+ ],
+ "events": [
{
- "name": "can_build_overlaid",
- "type": "Boolean",
- "desc": "True if element can be rebuild from a HTML page",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "beforeload",
+ "sig": "function (This, params)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a network request is made to retrieve a data object."
},
{
- "name": "dataId",
- "type": "string",
- "desc": "cutomer id",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "load",
+ "sig": "function (This, o, arg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the load method's callback is called."
},
{
- "name": "name",
- "type": "string",
- "desc": "Specifies name attribute",
- "memberOf": "Roo.bootstrap.Component"
- },
+ "name": "loadexception",
+ "sig": "function (This, o, arg, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires if an Exception occurs during data retrieval."
+ }
+ ],
+ "methods": [
{
- "name": "tooltip",
- "type": "string",
- "desc": "Text for the tooltip",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "getConnection",
+ "sig": "()",
+ "type": "function",
+ "desc": "Return the {@link Roo.data.Connection} object being used by this Proxy."
},
{
- "name": "container_method",
- "type": "string",
- "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf": "Roo.bootstrap.Component"
- },
+ "name": "load",
+ "sig": "(Object params, Roo.data.DataReader reader, Function callback, Object scope, Object arg)",
+ "type": "function",
+ "desc": "Load data from the configured {@link Roo.data.Connection}, read the data object into\na block of Roo.data.Records using the passed {@link Roo.data.DataReader} implementation, and\nprocess that block using the passed callback."
+ }
+ ]
+ },
+ "Roo.data.JsonReader": {
+ "props": [
{
- "name": "disableClass",
+ "name": "totalProperty",
"type": "String",
- "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf": "Roo.Component"
+ "desc": "Name of the property from which to retrieve the total number of records\nin the dataset. This is only needed if the whole dataset is not passed in one go, but is being\npaged from the remote server.",
+ "memberOf": ""
},
{
- "name": "allowDomMove",
- "type": "Boolean",
- "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf": "Roo.Component"
+ "name": "successProperty",
+ "type": "String",
+ "desc": "Name of the property from which to retrieve the success attribute used by forms.",
+ "memberOf": ""
},
{
- "name": "hideMode",
+ "name": "root",
"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"
- ]
+ "desc": "name of the property which contains the Array of row objects.",
+ "memberOf": ""
},
{
- "name": "actionMode",
+ "name": "id",
"type": "String",
- "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
- "memberOf": "Roo.Component"
+ "desc": "Name of the property within a row object that contains a record identifier value.",
+ "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"
+ "name": "fields",
+ "type": "Array",
+ "desc": "Array of field definition objects",
+ "memberOf": ""
}
],
- "events": [
- {
- "name": "beforedestroy",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires before the component is destroyed. Return false to stop the destroy."
- },
+ "events": [],
+ "methods": [
{
- "name": "beforehide",
- "sig": "function (_self)\n{\n\n}",
+ "name": "newRow",
+ "sig": "(Object data)",
"type": "function",
- "desc": "Fires before the component is hidden. Return false to stop the hide."
+ "desc": "Create an empty record"
},
{
- "name": "beforeloadcanvas",
- "sig": "function (_self, src)\n{\n\n}",
+ "name": "read",
+ "sig": "(Object response)",
"type": "function",
- "desc": "Fire before load the canvas"
+ "desc": "This method is only used by a DataProxy which has retrieved data from a remote server."
},
{
- "name": "beforerender",
- "sig": "function (_self)\n{\n\n}",
+ "name": "readRecords",
+ "sig": "(Object o)",
"type": "function",
- "desc": "Fires before the component is rendered. Return false to stop the render."
- },
+ "desc": "Create a data block containing Roo.data.Records from an XML document."
+ }
+ ]
+ },
+ "Roo.data.JsonStore": {
+ "props": [
{
- "name": "beforeselectfile",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fire before select file"
+ "name": "fields",
+ "type": "Array",
+ "desc": "An array of field definition objects, or field name strings.",
+ "memberOf": ""
},
{
- "name": "beforeshow",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires before the component is shown. Return false to stop the show."
+ "name": "isLocal",
+ "type": "boolean",
+ "desc": "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
+ "memberOf": "Roo.data.Store"
},
{
- "name": "childrenrendered",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the children have been rendered.."
+ "name": "proxy",
+ "type": "Roo.data.DataProxy",
+ "desc": "The Proxy object which provides access to a data object.",
+ "memberOf": "Roo.data.Store"
},
{
- "name": "crop",
- "sig": "function (_self, data)\n{\n\n}",
- "type": "function",
- "desc": "Fire after initEvent"
+ "name": "data",
+ "type": "Array",
+ "desc": "Inline data to be loaded when the store is initialized.",
+ "memberOf": "Roo.data.Store"
},
{
- "name": "destroy",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is destroyed."
+ "name": "reader",
+ "type": "Roo.data.Reader",
+ "desc": "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.",
+ "memberOf": "Roo.data.Store"
},
{
- "name": "disable",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is disabled."
+ "name": "baseParams",
+ "type": "Object",
+ "desc": "An object containing properties which are to be sent as parameters\non any HTTP request",
+ "memberOf": "Roo.data.Store"
},
{
- "name": "download",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fire when download the image"
+ "name": "sortInfo",
+ "type": "Object",
+ "desc": "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
+ "memberOf": "Roo.data.Store"
},
{
- "name": "enable",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is enabled."
+ "name": "multiSort",
+ "type": "Boolean",
+ "desc": "enable multi column sorting (sort is based on the order of columns, remote only at present)",
+ "memberOf": "Roo.data.Store"
},
{
- "name": "exception",
- "sig": "function (_self, xhr)\n{\n\n}",
- "type": "function",
- "desc": "Fire when get exception"
+ "name": "remoteSort",
+ "type": "boolean",
+ "desc": "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
+ "memberOf": "Roo.data.Store"
},
{
- "name": "footerbuttonclick",
- "sig": "function (_self, type)\n{\n\n}",
- "type": "function",
- "desc": "Fire when footerbuttonclick"
+ "name": "pruneModifiedRecords",
+ "type": "boolean",
+ "desc": "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
+ "memberOf": "Roo.data.Store"
},
{
- "name": "hide",
- "sig": "function (_self)\n{\n\n}",
+ "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": "add",
+ "sig": "function (_self, records, index)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is hidden."
+ "desc": "Fires when Records have been added to the Store"
},
{
- "name": "initial",
- "sig": "function (_self)\n{\n\n}",
+ "name": "beforeload",
+ "sig": "function (_self, options)\n{\n\n}",
"type": "function",
- "desc": "Fire after initEvent"
+ "desc": "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled."
},
{
- "name": "inspect",
- "sig": "function (_self, file)\n{\n\n}",
+ "name": "beforeloadadd",
+ "sig": "function (_self, records, options)\n{\n\n}",
"type": "function",
- "desc": "Fire when inspect the file"
+ "desc": "Fires after a new set of Records has been loaded."
},
{
- "name": "prepare",
- "sig": "function (_self, file)\n{\n\n}",
+ "name": "clear",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fire when preparing the file data"
+ "desc": "Fires when the data cache has been cleared."
},
{
- "name": "render",
+ "name": "datachanged",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is rendered."
+ "desc": "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view."
},
{
- "name": "resize",
- "sig": "function (_self)\n{\n\n}",
+ "name": "load",
+ "sig": "function (_self, records, options)\n{\n\n}",
"type": "function",
- "desc": "Fire when resize"
+ "desc": "Fires after a new set of Records has been loaded, before they are added to the store."
},
{
- "name": "rotate",
- "sig": "function (_self, pos)\n{\n\n}",
+ "name": "loadexception",
+ "sig": "function (, return, load, jsonData)\n{\n\n}",
"type": "function",
- "desc": "Fire when rotate the image"
+ "desc": "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args"
},
{
- "name": "show",
- "sig": "function (_self)\n{\n\n}",
+ "name": "metachange",
+ "sig": "function (_self, meta)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is shown."
+ "desc": "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders."
},
{
- "name": "trash",
- "sig": "function (_self)\n{\n\n}",
+ "name": "remove",
+ "sig": "function (_self, record, index)\n{\n\n}",
"type": "function",
- "desc": "Fire when trash image"
+ "desc": "Fires when a Record has been removed from the Store"
},
{
- "name": "upload",
- "sig": "function (_self, data)\n{\n\n}",
+ "name": "update",
+ "sig": "function (_self, record, operation)\n{\n\n}",
"type": "function",
- "desc": "Fire when xhr upload the file"
+ "desc": "Fires when a Record has been updated"
}
],
"methods": [
+ {
+ "name": "add",
+ "sig": "(Roo.data.Record[] records)",
+ "type": "function",
+ "desc": "Add Records to the Store and fires the add event."
+ },
{
"name": "addEvents",
"sig": "(Object object)",
"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": "()",
+ "name": "clearFilter",
+ "sig": "(Boolean suppressEvent)",
"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": "Revert to a view of the Record cache with no filtering applied."
},
{
- "name": "disable",
- "sig": "()",
+ "name": "collect",
+ "sig": "(String dataIndex, Boolean allowNull, Boolean bypassFilter)",
"type": "function",
- "desc": "Disable this component."
+ "desc": "Collects unique values for a particular dataIndex from this store."
},
{
- "name": "enable",
+ "name": "commitChanges",
"sig": "()",
"type": "function",
- "desc": "Enable this component."
+ "desc": "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT."
+ },
+ {
+ "name": "each",
+ "sig": "(Function fn, Object scope)",
+ "type": "function",
+ "desc": "Calls the specified function for each of the Records in the cache."
+ },
+ {
+ "name": "filter",
+ "sig": "(String field, String/RegExp value, Boolean anyMatch)",
+ "type": "function",
+ "desc": "Filter the records by a specified property."
+ },
+ {
+ "name": "filterBy",
+ "sig": "(Function fn, Object scope)",
+ "type": "function",
+ "desc": "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered."
},
{
"name": "fireEvent",
"desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "focus",
- "sig": "(Boolean selectText)",
+ "name": "getAt",
+ "sig": "(Number index)",
"type": "function",
- "desc": "Try to focus this component."
+ "desc": "Get the Record at the specified index."
},
{
- "name": "getChildContainer",
+ "name": "getById",
+ "sig": "(String id)",
+ "type": "function",
+ "desc": "Get the Record with the specified id."
+ },
+ {
+ "name": "getCount",
"sig": "()",
"type": "function",
- "desc": "Fetch the element to add children to"
+ "desc": "Gets the number of cached records.\n<p>\n<em>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size</em>"
},
{
- "name": "getEl",
+ "name": "getModifiedRecords",
"sig": "()",
"type": "function",
- "desc": "Returns the underlying {@link Roo.Element}."
+ "desc": "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging)."
},
{
- "name": "getId",
+ "name": "getRange",
+ "sig": "(Number startIndex, Number endIndex)",
+ "type": "function",
+ "desc": "Returns a range of Records between specified indices."
+ },
+ {
+ "name": "getSortState",
"sig": "()",
"type": "function",
- "desc": "Returns the id of this component."
+ "desc": "Returns the sort state of the Store as an object with two properties:\n<pre><code>\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n</code></pre>"
+ },
+ {
+ "name": "getTotalCount",
+ "sig": "()",
+ "type": "function",
+ "desc": "Gets the total number of records in the dataset as returned by the server.\n<p>\n<em>If using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size</em>"
},
{
"name": "hasListener",
"desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "hide",
- "sig": "()",
+ "name": "indexOf",
+ "sig": "(Roo.data.Record record)",
"type": "function",
- "desc": "Hide a component - adds 'hidden' class"
+ "desc": "Get the index within the cache of the passed Record."
},
{
- "name": "initEvents",
- "sig": "()",
+ "name": "indexOfId",
+ "sig": "(String id)",
"type": "function",
- "desc": "Initialize Events for the element"
+ "desc": "Get the index within the cache of the Record with the passed id."
},
{
- "name": "isVisible",
- "sig": "()",
+ "name": "insert",
+ "sig": "(Number index, Roo.data.Record[] records)",
"type": "function",
- "desc": "Returns true if this component is visible."
+ "desc": "Inserts Records to the Store at the given index and fires the add event."
+ },
+ {
+ "name": "load",
+ "sig": "(Object options)",
+ "type": "function",
+ "desc": "Loads the Record cache from the configured Proxy using the configured Reader.\n<p>\nIf using remote paging, then the first load call must specify the <em>start</em>\nand <em>limit</em> properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n<p>\n<strong>It is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.</strong>\n<p>"
+ },
+ {
+ "name": "loadData",
+ "sig": "(Object data, Boolean append)",
+ "type": "function",
+ "desc": "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor."
},
{
"name": "on",
"type": "function",
"desc": "Removes all listeners for this object"
},
+ {
+ "name": "query",
+ "sig": "(String field, String/RegExp value, Boolean anyMatch)",
+ "type": "function",
+ "desc": "Query the records by a specified property."
+ },
+ {
+ "name": "queryBy",
+ "sig": "(Function fn, Object scope)",
+ "type": "function",
+ "desc": "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results."
+ },
+ {
+ "name": "rejectChanges",
+ "sig": "()",
+ "type": "function",
+ "desc": "Cancel outstanding changes on all changed records."
+ },
{
"name": "releaseCapture",
"sig": "(Observable o)",
"desc": "Removes <b>all</b> added captures from the Observable."
},
{
- "name": "removeListener",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "reload",
+ "sig": "(Object options)",
"type": "function",
- "desc": "Removes a listener"
+ "desc": "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed."
},
{
- "name": "render",
- "sig": "(String/HTMLElement/Element container)",
+ "name": "remove",
+ "sig": "(Ext.data.Record record)",
"type": "function",
- "desc": "If this is a lazy rendering component, render it to its container element."
+ "desc": "Remove a Record from the Store and fires the remove event."
},
{
- "name": "setDisabled",
- "sig": "(Boolean disabled)",
+ "name": "removeAll",
+ "sig": "()",
"type": "function",
- "desc": "Convenience function for setting disabled/enabled by boolean."
+ "desc": "Remove all Records from the Store and fires the clear event."
},
{
- "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": "setDefaultSort",
+ "sig": "(String fieldName, String dir)",
"type": "function",
- "desc": "Show a component - removes 'hidden' class"
+ "desc": "Sets the default sort column and order to be used by the next load operation."
},
{
- "name": "tooltipEl",
- "sig": "()",
+ "name": "sort",
+ "sig": "(String fieldName, String dir)",
"type": "function",
- "desc": "Fetch the element to display the tooltip on."
+ "desc": "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally."
+ },
+ {
+ "name": "sum",
+ "sig": "(String property, Number start, Number end)",
+ "type": "function",
+ "desc": "Sums the value of <i>property</i> for each record between start and end and returns the result."
},
{
"name": "un",
}
]
},
- "Roo.bootstrap.dash": {
+ "Roo.data.MemoryProxy": {
"props": [],
"events": [],
- "methods": []
+ "methods": [
+ {
+ "name": "load",
+ "sig": "(Object params, Roo.data.DataReader reader, Function callback, Object scope, Object arg)",
+ "type": "function",
+ "desc": "Load data from the requested source (in this case an in-memory\ndata object passed to the constructor), read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback."
+ }
+ ]
},
- "Roo.bootstrap.dash.NumberBox": {
+ "Roo.data.Node": {
"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",
+ "name": "leaf",
+ "type": "Boolean",
+ "desc": "true if this node is a leaf and does not have children",
"memberOf": ""
},
{
- "name": "fhref",
+ "name": "id",
"type": "String",
- "desc": "Footer href",
+ "desc": "The id for this node. If one is not specified, one is generated.",
"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",
],
"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": "append",
+ "sig": "function (tree, _self, node, index)\n{\n\n}",
"type": "function",
- "desc": "Fires before the component is shown. Return false to stop the show."
+ "desc": "Fires when a new child node is appended"
},
{
- "name": "childrenrendered",
- "sig": "function (_self)\n{\n\n}",
+ "name": "beforeappend",
+ "sig": "function (tree, _self, node)\n{\n\n}",
"type": "function",
- "desc": "Fires when the children have been rendered.."
+ "desc": "Fires before a new child is appended, return false to cancel the append."
},
{
- "name": "destroy",
- "sig": "function (_self)\n{\n\n}",
+ "name": "beforeinsert",
+ "sig": "function (tree, _self, node, refNode)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is destroyed."
+ "desc": "Fires before a new child is inserted, return false to cancel the insert."
},
{
- "name": "disable",
- "sig": "function (_self)\n{\n\n}",
+ "name": "beforemove",
+ "sig": "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is disabled."
+ "desc": "Fires before this node is moved to a new location in the tree. Return false to cancel the move."
},
{
- "name": "enable",
- "sig": "function (_self)\n{\n\n}",
+ "name": "beforeremove",
+ "sig": "function (tree, _self, node)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is enabled."
+ "desc": "Fires before a child is removed, return false to cancel the remove."
},
{
- "name": "hide",
- "sig": "function (_self)\n{\n\n}",
+ "name": "insert",
+ "sig": "function (tree, _self, node, refNode)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is hidden."
+ "desc": "Fires when a new child node is inserted."
},
{
- "name": "render",
- "sig": "function (_self)\n{\n\n}",
+ "name": "move",
+ "sig": "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is rendered."
+ "desc": "Fires when this node is moved to a new location in the tree"
},
{
- "name": "show",
- "sig": "function (_self)\n{\n\n}",
+ "name": "remove",
+ "sig": "function (tree, _self, node)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is shown."
+ "desc": "Fires when a child node is removed"
}
],
"methods": [
"type": "function",
"desc": "Appends an event handler to this component"
},
+ {
+ "name": "appendChild",
+ "sig": "(Node/Array node)",
+ "type": "function",
+ "desc": "Insert node(s) as the last child node of this node."
+ },
+ {
+ "name": "bubble",
+ "sig": "(Function fn, Object scope, Array args)",
+ "type": "function",
+ "desc": "Bubbles up the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe bubble is stopped."
+ },
{
"name": "capture",
"sig": "(Observable o, Function fn, Object scope)",
"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": "()",
+ "name": "cascade",
+ "sig": "(Function fn, Object scope, Array args)",
"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": "Cascades down the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe cascade is stopped on that branch."
},
{
- "name": "disable",
- "sig": "()",
+ "name": "contains",
+ "sig": "(Node node)",
"type": "function",
- "desc": "Disable this component."
+ "desc": "Returns true if this node is an ancestor (at any point) of the passed node."
},
{
- "name": "enable",
- "sig": "()",
+ "name": "eachChild",
+ "sig": "(Function fn, Object scope, Array args)",
"type": "function",
- "desc": "Enable this component."
+ "desc": "Interates the child nodes of this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe iteration stops."
+ },
+ {
+ "name": "findChild",
+ "sig": "(String attribute, Mixed value)",
+ "type": "function",
+ "desc": "Finds the first child that has the attribute with the specified value."
+ },
+ {
+ "name": "findChildBy",
+ "sig": "(Function fn, Object scope)",
+ "type": "function",
+ "desc": "Finds the first child by a custom function. The child matches if the function passed\nreturns true."
},
{
"name": "fireEvent",
"desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "focus",
- "sig": "(Boolean selectText)",
+ "name": "getDepth",
+ "sig": "()",
"type": "function",
- "desc": "Try to focus this component."
+ "desc": "Returns depth of this node (the root node has a depth of 0)"
},
{
- "name": "getChildContainer",
+ "name": "getOwnerTree",
"sig": "()",
"type": "function",
- "desc": "Fetch the element to add children to"
+ "desc": "Returns the tree this node is in."
},
{
- "name": "getEl",
- "sig": "()",
+ "name": "getPath",
+ "sig": "(String attr)",
"type": "function",
- "desc": "Returns the underlying {@link Roo.Element}."
+ "desc": "Returns the path for this node. The path can be used to expand or select this node programmatically."
+ },
+ {
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
+ },
+ {
+ "name": "indexOf",
+ "sig": "(Node node)",
+ "type": "function",
+ "desc": "Returns the index of a child node"
},
{
- "name": "getId",
- "sig": "()",
+ "name": "insertBefore",
+ "sig": "(Node node, Node refNode)",
"type": "function",
- "desc": "Returns the id of this component."
+ "desc": "Inserts the first node before the second node in this nodes childNodes collection."
},
{
- "name": "hasListener",
- "sig": "(String eventName)",
+ "name": "isAncestor",
+ "sig": "(Node node)",
"type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
+ "desc": "Returns true if the passed node is an ancestor (at any point) of this node."
},
{
- "name": "hide",
+ "name": "isFirst",
"sig": "()",
"type": "function",
- "desc": "Hide a component - adds 'hidden' class"
+ "desc": "Returns true if this node is the first child of its parent"
},
{
- "name": "initEvents",
+ "name": "isLast",
"sig": "()",
"type": "function",
- "desc": "Initialize Events for the element"
+ "desc": "Returns true if this node is the last child of its parent"
},
{
- "name": "isVisible",
+ "name": "isLeaf",
"sig": "()",
"type": "function",
- "desc": "Returns true if this component is visible."
+ "desc": "Returns true if this node is a leaf"
+ },
+ {
+ "name": "item",
+ "sig": "(Number index)",
+ "type": "function",
+ "desc": "Returns the child node at the specified index."
},
{
"name": "on",
"type": "function",
"desc": "Removes <b>all</b> added captures from the Observable."
},
+ {
+ "name": "removeChild",
+ "sig": "(Node node)",
+ "type": "function",
+ "desc": "Removes a child node from this node."
+ },
{
"name": "removeListener",
"sig": "(String eventName, Function handler, Object scope)",
"desc": "Removes a listener"
},
{
- "name": "render",
- "sig": "(String/HTMLElement/Element container)",
+ "name": "replaceChild",
+ "sig": "(Node newChild, Node oldChild)",
"type": "function",
- "desc": "If this is a lazy rendering component, render it to its container element."
+ "desc": "Replaces one child node in this node with another."
},
{
- "name": "setDisabled",
- "sig": "(Boolean disabled)",
+ "name": "sort",
+ "sig": "(Function fn, Object scope)",
"type": "function",
- "desc": "Convenience function for setting disabled/enabled by boolean."
+ "desc": "Sorts this nodes children using the supplied sort function"
},
{
- "name": "setVisible",
- "sig": "(Boolean visible)",
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
"type": "function",
- "desc": "Convenience function to hide or show this component by boolean."
- },
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.data.Record": {
+ "props": [],
+ "events": [],
+ "methods": [
{
- "name": "show",
+ "name": "commit",
"sig": "()",
"type": "function",
- "desc": "Show a component - removes 'hidden' class"
+ "desc": "Usually called by the {@link Roo.data.Store} which owns the Record.\nCommits all changes made to the Record since either creation, or the last commit operation.\n<p>\nDevelopers should subscribe to the {@link Roo.data.Store#update} event to have their code notified\nof commit operations."
},
{
- "name": "tooltipEl",
+ "name": "copy",
+ "sig": "(String id)",
+ "type": "function",
+ "desc": "Creates a copy of this record."
+ },
+ {
+ "name": "create",
+ "sig": "(Array o)",
+ "type": "function",
+ "desc": "Generate a constructor for a specific record layout."
+ },
+ {
+ "name": "get",
+ "sig": "(String name)",
+ "type": "function",
+ "desc": "Get the value of the named field."
+ },
+ {
+ "name": "reject",
"sig": "()",
"type": "function",
- "desc": "Fetch the element to display the tooltip on."
+ "desc": "Usually called by the {@link Roo.data.Store} which owns the Record.\nRejects all changes made to the Record since either creation, or the last commit operation.\nModified fields are reverted to their original values.\n<p>\nDevelopers should subscribe to the {@link Roo.data.Store#update} event to have their code notified\nof reject operations."
},
{
- "name": "un",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "set",
+ "sig": "(String name, Object value)",
"type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
+ "desc": "Set the named field to the specified value."
}
]
},
- "Roo.bootstrap.dash.TabBox": {
+ "Roo.data.ScriptTagProxy": {
"props": [
{
- "name": "title",
+ "name": "url",
"type": "String",
- "desc": "Title of the TabBox",
+ "desc": "The URL from which to request the data object.",
"memberOf": ""
},
{
- "name": "icon",
- "type": "String",
- "desc": "Icon of the TabBox",
+ "name": "timeout",
+ "type": "Number",
+ "desc": "(Optional) The number of milliseconds to wait for a response. Defaults to 30 seconds.",
"memberOf": ""
},
{
- "name": "showtabs",
- "type": "Boolean",
- "desc": "show the tabs default true",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
+ "name": "callbackParam",
+ "type": "String",
+ "desc": "(Optional) The name of the parameter to pass to the server which tells\nthe server the name of the callback function set up by the load call to process the returned data object.\nDefaults to \"callback\".<p>The server-side processing must read this parameter value, and generate\njavascript output which calls this named function passing the data object as its only parameter.",
+ "memberOf": ""
},
{
- "name": "tabScrollable",
+ "name": "nocache",
"type": "Boolean",
- "desc": "tab scrollable when mobile view default false",
- "memberOf": "",
- "optvals": [
- "true",
- "false"
- ]
- },
+ "desc": "(Optional) Defaults to true. Disable cacheing by adding a unique parameter\nname to the request.",
+ "memberOf": ""
+ }
+ ],
+ "events": [],
+ "methods": [
{
- "name": "cls",
- "type": "String",
- "desc": "css class",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "abort",
+ "sig": "()",
+ "type": "function",
+ "desc": "Abort the current server request."
},
{
- "name": "style",
- "type": "String",
- "desc": "any extra css",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "load",
+ "sig": "(Object params, Roo.data.DataReader reader, Function callback, Object scope, Object arg)",
+ "type": "function",
+ "desc": "Load data from the configured URL, read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback."
+ }
+ ]
+ },
+ "Roo.data.SimpleStore": {
+ "props": [
+ {
+ "name": "id",
+ "type": "Number",
+ "desc": "The array index of the record id. Leave blank to auto generate ids.",
+ "memberOf": ""
},
{
- "name": "xattr",
- "type": "Object",
- "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "fields",
+ "type": "Array",
+ "desc": "An array of field definition objects, or field name strings.",
+ "memberOf": ""
},
{
- "name": "can_build_overlaid",
- "type": "Boolean",
- "desc": "True if element can be rebuild from a HTML page",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "data",
+ "type": "Array",
+ "desc": "The multi-dimensional array of data",
+ "memberOf": ""
},
{
- "name": "dataId",
- "type": "string",
- "desc": "cutomer id",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "isLocal",
+ "type": "boolean",
+ "desc": "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
+ "memberOf": "Roo.data.Store"
},
{
- "name": "name",
- "type": "string",
- "desc": "Specifies name attribute",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "proxy",
+ "type": "Roo.data.DataProxy",
+ "desc": "The Proxy object which provides access to a data object.",
+ "memberOf": "Roo.data.Store"
},
{
- "name": "tooltip",
- "type": "string",
- "desc": "Text for the tooltip",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "reader",
+ "type": "Roo.data.Reader",
+ "desc": "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.",
+ "memberOf": "Roo.data.Store"
},
{
- "name": "container_method",
- "type": "string",
- "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "baseParams",
+ "type": "Object",
+ "desc": "An object containing properties which are to be sent as parameters\non any HTTP request",
+ "memberOf": "Roo.data.Store"
},
{
- "name": "disableClass",
- "type": "String",
- "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf": "Roo.Component"
+ "name": "sortInfo",
+ "type": "Object",
+ "desc": "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
+ "memberOf": "Roo.data.Store"
},
{
- "name": "allowDomMove",
+ "name": "multiSort",
"type": "Boolean",
- "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf": "Roo.Component"
+ "desc": "enable multi column sorting (sort is based on the order of columns, remote only at present)",
+ "memberOf": "Roo.data.Store"
},
{
- "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": "remoteSort",
+ "type": "boolean",
+ "desc": "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
+ "memberOf": "Roo.data.Store"
},
{
- "name": "actionMode",
- "type": "String",
- "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
- "memberOf": "Roo.Component"
+ "name": "pruneModifiedRecords",
+ "type": "boolean",
+ "desc": "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
+ "memberOf": "Roo.data.Store"
},
{
"name": "listeners",
],
"events": [
{
- "name": "activatepane",
- "sig": "function (pane)\n{\n\n}",
- "type": "function",
- "desc": "When a pane is activated"
- },
- {
- "name": "addpane",
- "sig": "function (pane)\n{\n\n}",
- "type": "function",
- "desc": "When a pane is added"
- },
- {
- "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}",
+ "name": "add",
+ "sig": "function (_self, records, index)\n{\n\n}",
"type": "function",
- "desc": "Fires before the component is hidden. Return false to stop the hide."
+ "desc": "Fires when Records have been added to the Store"
},
{
- "name": "beforerender",
- "sig": "function (_self)\n{\n\n}",
+ "name": "beforeload",
+ "sig": "function (_self, options)\n{\n\n}",
"type": "function",
- "desc": "Fires before the component is rendered. Return false to stop the render."
+ "desc": "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled."
},
{
- "name": "beforeshow",
- "sig": "function (_self)\n{\n\n}",
+ "name": "beforeloadadd",
+ "sig": "function (_self, records, options)\n{\n\n}",
"type": "function",
- "desc": "Fires before the component is shown. Return false to stop the show."
+ "desc": "Fires after a new set of Records has been loaded."
},
{
- "name": "childrenrendered",
+ "name": "clear",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the children have been rendered.."
+ "desc": "Fires when the data cache has been cleared."
},
{
- "name": "destroy",
+ "name": "datachanged",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is destroyed."
+ "desc": "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view."
},
{
- "name": "disable",
- "sig": "function (_self)\n{\n\n}",
+ "name": "load",
+ "sig": "function (_self, records, options)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is disabled."
+ "desc": "Fires after a new set of Records has been loaded, before they are added to the store."
},
{
- "name": "enable",
- "sig": "function (_self)\n{\n\n}",
+ "name": "loadexception",
+ "sig": "function (, return, load, jsonData)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is enabled."
+ "desc": "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args"
},
{
- "name": "hide",
- "sig": "function (_self)\n{\n\n}",
+ "name": "metachange",
+ "sig": "function (_self, meta)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is hidden."
+ "desc": "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders."
},
{
- "name": "render",
- "sig": "function (_self)\n{\n\n}",
+ "name": "remove",
+ "sig": "function (_self, record, index)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is rendered."
+ "desc": "Fires when a Record has been removed from the Store"
},
{
- "name": "show",
- "sig": "function (_self)\n{\n\n}",
+ "name": "update",
+ "sig": "function (_self, record, operation)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is shown."
+ "desc": "Fires when a Record has been updated"
}
],
"methods": [
+ {
+ "name": "add",
+ "sig": "(Roo.data.Record[] records)",
+ "type": "function",
+ "desc": "Add Records to the Store and fires the add event."
+ },
{
"name": "addEvents",
"sig": "(Object object)",
"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": "()",
+ "name": "clearFilter",
+ "sig": "(Boolean suppressEvent)",
"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": "Revert to a view of the Record cache with no filtering applied."
},
{
- "name": "disable",
- "sig": "()",
+ "name": "collect",
+ "sig": "(String dataIndex, Boolean allowNull, Boolean bypassFilter)",
"type": "function",
- "desc": "Disable this component."
+ "desc": "Collects unique values for a particular dataIndex from this store."
},
{
- "name": "enable",
+ "name": "commitChanges",
"sig": "()",
"type": "function",
- "desc": "Enable this component."
+ "desc": "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT."
+ },
+ {
+ "name": "each",
+ "sig": "(Function fn, Object scope)",
+ "type": "function",
+ "desc": "Calls the specified function for each of the Records in the cache."
+ },
+ {
+ "name": "filter",
+ "sig": "(String field, String/RegExp value, Boolean anyMatch)",
+ "type": "function",
+ "desc": "Filter the records by a specified property."
+ },
+ {
+ "name": "filterBy",
+ "sig": "(Function fn, Object scope)",
+ "type": "function",
+ "desc": "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered."
},
{
"name": "fireEvent",
"desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "focus",
- "sig": "(Boolean selectText)",
+ "name": "getAt",
+ "sig": "(Number index)",
"type": "function",
- "desc": "Try to focus this component."
+ "desc": "Get the Record at the specified index."
},
{
- "name": "getChildContainer",
+ "name": "getById",
+ "sig": "(String id)",
+ "type": "function",
+ "desc": "Get the Record with the specified id."
+ },
+ {
+ "name": "getCount",
"sig": "()",
"type": "function",
- "desc": "Fetch the element to add children to"
+ "desc": "Gets the number of cached records.\n<p>\n<em>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size</em>"
},
{
- "name": "getEl",
+ "name": "getModifiedRecords",
"sig": "()",
"type": "function",
- "desc": "Returns the underlying {@link Roo.Element}."
+ "desc": "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging)."
},
{
- "name": "getId",
+ "name": "getRange",
+ "sig": "(Number startIndex, Number endIndex)",
+ "type": "function",
+ "desc": "Returns a range of Records between specified indices."
+ },
+ {
+ "name": "getSortState",
"sig": "()",
"type": "function",
- "desc": "Returns the id of this component."
+ "desc": "Returns the sort state of the Store as an object with two properties:\n<pre><code>\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n</code></pre>"
+ },
+ {
+ "name": "getTotalCount",
+ "sig": "()",
+ "type": "function",
+ "desc": "Gets the total number of records in the dataset as returned by the server.\n<p>\n<em>If using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size</em>"
},
{
"name": "hasListener",
"desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "hide",
- "sig": "()",
+ "name": "indexOf",
+ "sig": "(Roo.data.Record record)",
"type": "function",
- "desc": "Hide a component - adds 'hidden' class"
+ "desc": "Get the index within the cache of the passed Record."
},
{
- "name": "initEvents",
- "sig": "()",
+ "name": "indexOfId",
+ "sig": "(String id)",
"type": "function",
- "desc": "Initialize Events for the element"
+ "desc": "Get the index within the cache of the Record with the passed id."
},
{
- "name": "isVisible",
- "sig": "()",
+ "name": "insert",
+ "sig": "(Number index, Roo.data.Record[] records)",
"type": "function",
- "desc": "Returns true if this component is visible."
+ "desc": "Inserts Records to the Store at the given index and fires the add event."
+ },
+ {
+ "name": "load",
+ "sig": "(Object options)",
+ "type": "function",
+ "desc": "Loads the Record cache from the configured Proxy using the configured Reader.\n<p>\nIf using remote paging, then the first load call must specify the <em>start</em>\nand <em>limit</em> properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n<p>\n<strong>It is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.</strong>\n<p>"
+ },
+ {
+ "name": "loadData",
+ "sig": "(Object data, Boolean append)",
+ "type": "function",
+ "desc": "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor."
},
{
"name": "on",
"type": "function",
"desc": "Removes all listeners for this object"
},
+ {
+ "name": "query",
+ "sig": "(String field, String/RegExp value, Boolean anyMatch)",
+ "type": "function",
+ "desc": "Query the records by a specified property."
+ },
+ {
+ "name": "queryBy",
+ "sig": "(Function fn, Object scope)",
+ "type": "function",
+ "desc": "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results."
+ },
+ {
+ "name": "rejectChanges",
+ "sig": "()",
+ "type": "function",
+ "desc": "Cancel outstanding changes on all changed records."
+ },
{
"name": "releaseCapture",
"sig": "(Observable o)",
"desc": "Removes <b>all</b> added captures from the Observable."
},
{
- "name": "removeListener",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "reload",
+ "sig": "(Object options)",
"type": "function",
- "desc": "Removes a listener"
+ "desc": "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed."
},
{
- "name": "render",
- "sig": "(String/HTMLElement/Element container)",
+ "name": "remove",
+ "sig": "(Ext.data.Record record)",
"type": "function",
- "desc": "If this is a lazy rendering component, render it to its container element."
+ "desc": "Remove a Record from the Store and fires the remove event."
},
{
- "name": "setDisabled",
- "sig": "(Boolean disabled)",
+ "name": "removeAll",
+ "sig": "()",
"type": "function",
- "desc": "Convenience function for setting disabled/enabled by boolean."
+ "desc": "Remove all Records from the Store and fires the clear event."
},
{
- "name": "setTitle",
- "sig": "(String html)",
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
"type": "function",
- "desc": "Updates the box title"
+ "desc": "Removes a listener"
},
{
- "name": "setVisible",
- "sig": "(Boolean visible)",
+ "name": "setDefaultSort",
+ "sig": "(String fieldName, String dir)",
"type": "function",
- "desc": "Convenience function to hide or show this component by boolean."
+ "desc": "Sets the default sort column and order to be used by the next load operation."
},
{
- "name": "show",
- "sig": "()",
+ "name": "sort",
+ "sig": "(String fieldName, String dir)",
"type": "function",
- "desc": "Show a component - removes 'hidden' class"
+ "desc": "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally."
},
{
- "name": "tooltipEl",
- "sig": "()",
+ "name": "sum",
+ "sig": "(String property, Number start, Number end)",
"type": "function",
- "desc": "Fetch the element to display the tooltip on."
+ "desc": "Sums the value of <i>property</i> for each record between start and end and returns the result."
},
{
"name": "un",
}
]
},
- "Roo.bootstrap.dash.TabPane": {
- "props": [
+ "Roo.data.SortTypes": {
+ "props": [],
+ "events": [],
+ "methods": [
{
- "name": "active",
- "type": "Boolean",
- "desc": "Default false",
- "memberOf": "",
- "optvals": [
- "false",
- "true"
- ]
+ "name": "asDate",
+ "sig": "(Mixed s)",
+ "type": "function",
+ "desc": "Date sorting"
},
{
- "name": "title",
- "type": "String",
- "desc": "title of panel",
- "memberOf": ""
+ "name": "asFloat",
+ "sig": "(Mixed s)",
+ "type": "function",
+ "desc": "Float sorting"
+ },
+ {
+ "name": "asInt",
+ "sig": "(Mixed s)",
+ "type": "function",
+ "desc": "Integer sorting"
},
{
- "name": "cls",
- "type": "String",
- "desc": "css class",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "asText",
+ "sig": "(Mixed s)",
+ "type": "function",
+ "desc": "Strips all HTML tags to sort on text only"
},
{
- "name": "style",
- "type": "String",
- "desc": "any extra css",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "asUCString",
+ "sig": "(Mixed s)",
+ "type": "function",
+ "desc": "Case insensitive string"
},
{
- "name": "xattr",
- "type": "Object",
- "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "asUCText",
+ "sig": "(Mixed s)",
+ "type": "function",
+ "desc": "Strips all HTML tags to sort on text only - Case insensitive"
},
{
- "name": "can_build_overlaid",
- "type": "Boolean",
- "desc": "True if element can be rebuild from a HTML page",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "none",
+ "sig": "(Mixed s)",
+ "type": "function",
+ "desc": "Default sort that does nothing"
+ }
+ ]
+ },
+ "Roo.data.Store": {
+ "props": [
+ {
+ "name": "isLocal",
+ "type": "boolean",
+ "desc": "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
+ "memberOf": ""
},
{
- "name": "dataId",
- "type": "string",
- "desc": "cutomer id",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "proxy",
+ "type": "Roo.data.DataProxy",
+ "desc": "The Proxy object which provides access to a data object.",
+ "memberOf": ""
},
{
- "name": "name",
- "type": "string",
- "desc": "Specifies name attribute",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "data",
+ "type": "Array",
+ "desc": "Inline data to be loaded when the store is initialized.",
+ "memberOf": ""
},
{
- "name": "tooltip",
- "type": "string",
- "desc": "Text for the tooltip",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "reader",
+ "type": "Roo.data.Reader",
+ "desc": "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.",
+ "memberOf": ""
},
{
- "name": "container_method",
- "type": "string",
- "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "baseParams",
+ "type": "Object",
+ "desc": "An object containing properties which are to be sent as parameters\non any HTTP request",
+ "memberOf": ""
},
{
- "name": "disableClass",
- "type": "String",
- "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf": "Roo.Component"
+ "name": "sortInfo",
+ "type": "Object",
+ "desc": "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
+ "memberOf": ""
},
{
- "name": "allowDomMove",
+ "name": "multiSort",
"type": "Boolean",
- "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf": "Roo.Component"
+ "desc": "enable multi column sorting (sort is based on the order of columns, remote only at present)",
+ "memberOf": ""
},
{
- "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": "remoteSort",
+ "type": "boolean",
+ "desc": "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
+ "memberOf": ""
},
{
- "name": "actionMode",
- "type": "String",
- "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
- "memberOf": "Roo.Component"
+ "name": "pruneModifiedRecords",
+ "type": "boolean",
+ "desc": "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
+ "memberOf": ""
},
{
"name": "listeners",
],
"events": [
{
- "name": "activate",
- "sig": "function (pane)\n{\n\n}",
- "type": "function",
- "desc": "When a pane is activated"
- },
- {
- "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}",
+ "name": "add",
+ "sig": "function (_self, records, index)\n{\n\n}",
"type": "function",
- "desc": "Fires before the component is hidden. Return false to stop the hide."
+ "desc": "Fires when Records have been added to the Store"
},
{
- "name": "beforerender",
- "sig": "function (_self)\n{\n\n}",
+ "name": "beforeload",
+ "sig": "function (_self, options)\n{\n\n}",
"type": "function",
- "desc": "Fires before the component is rendered. Return false to stop the render."
+ "desc": "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled."
},
{
- "name": "beforeshow",
- "sig": "function (_self)\n{\n\n}",
+ "name": "beforeloadadd",
+ "sig": "function (_self, records, options)\n{\n\n}",
"type": "function",
- "desc": "Fires before the component is shown. Return false to stop the show."
+ "desc": "Fires after a new set of Records has been loaded."
},
{
- "name": "childrenrendered",
+ "name": "clear",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the children have been rendered.."
+ "desc": "Fires when the data cache has been cleared."
},
{
- "name": "destroy",
+ "name": "datachanged",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is destroyed."
+ "desc": "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view."
},
{
- "name": "disable",
- "sig": "function (_self)\n{\n\n}",
+ "name": "load",
+ "sig": "function (_self, records, options)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is disabled."
+ "desc": "Fires after a new set of Records has been loaded, before they are added to the store."
},
{
- "name": "enable",
- "sig": "function (_self)\n{\n\n}",
+ "name": "loadexception",
+ "sig": "function (, return, load, jsonData)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is enabled."
+ "desc": "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args"
},
{
- "name": "hide",
- "sig": "function (_self)\n{\n\n}",
+ "name": "metachange",
+ "sig": "function (_self, meta)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is hidden."
+ "desc": "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders."
},
{
- "name": "render",
- "sig": "function (_self)\n{\n\n}",
+ "name": "remove",
+ "sig": "function (_self, record, index)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is rendered."
+ "desc": "Fires when a Record has been removed from the Store"
},
{
- "name": "show",
- "sig": "function (_self)\n{\n\n}",
+ "name": "update",
+ "sig": "function (_self, record, operation)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is shown."
+ "desc": "Fires when a Record has been updated"
}
],
"methods": [
+ {
+ "name": "add",
+ "sig": "(Roo.data.Record[] records)",
+ "type": "function",
+ "desc": "Add Records to the Store and fires the add event."
+ },
{
"name": "addEvents",
"sig": "(Object object)",
"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": "()",
+ "name": "clearFilter",
+ "sig": "(Boolean suppressEvent)",
"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": "Revert to a view of the Record cache with no filtering applied."
},
{
- "name": "disable",
- "sig": "()",
+ "name": "collect",
+ "sig": "(String dataIndex, Boolean allowNull, Boolean bypassFilter)",
"type": "function",
- "desc": "Disable this component."
+ "desc": "Collects unique values for a particular dataIndex from this store."
},
{
- "name": "enable",
+ "name": "commitChanges",
"sig": "()",
"type": "function",
- "desc": "Enable this component."
+ "desc": "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT."
},
{
- "name": "fireEvent",
- "sig": "(String eventName, Object... args)",
+ "name": "each",
+ "sig": "(Function fn, Object scope)",
"type": "function",
- "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ "desc": "Calls the specified function for each of the Records in the cache."
},
{
- "name": "focus",
- "sig": "(Boolean selectText)",
+ "name": "filter",
+ "sig": "(String field, String/RegExp value, Boolean anyMatch)",
"type": "function",
- "desc": "Try to focus this component."
+ "desc": "Filter the records by a specified property."
},
{
- "name": "getChildContainer",
- "sig": "()",
+ "name": "filterBy",
+ "sig": "(Function fn, Object scope)",
"type": "function",
- "desc": "Fetch the element to add children to"
+ "desc": "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered."
},
{
- "name": "getEl",
- "sig": "()",
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
"type": "function",
- "desc": "Returns the underlying {@link Roo.Element}."
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "getId",
- "sig": "()",
+ "name": "getAt",
+ "sig": "(Number index)",
"type": "function",
- "desc": "Returns the id of this component."
+ "desc": "Get the Record at the specified index."
},
{
- "name": "hasListener",
- "sig": "(String eventName)",
+ "name": "getById",
+ "sig": "(String id)",
"type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
+ "desc": "Get the Record with the specified id."
},
{
- "name": "hide",
+ "name": "getCount",
"sig": "()",
"type": "function",
- "desc": "Hide a component - adds 'hidden' class"
+ "desc": "Gets the number of cached records.\n<p>\n<em>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size</em>"
},
{
- "name": "initEvents",
+ "name": "getModifiedRecords",
"sig": "()",
"type": "function",
- "desc": "Initialize Events for the element"
+ "desc": "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging)."
},
{
- "name": "isVisible",
- "sig": "()",
+ "name": "getRange",
+ "sig": "(Number startIndex, Number endIndex)",
"type": "function",
- "desc": "Returns true if this component is visible."
+ "desc": "Returns a range of Records between specified indices."
},
{
- "name": "on",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "name": "getSortState",
+ "sig": "()",
"type": "function",
- "desc": "Appends an event handler to this element (shorthand for addListener)"
+ "desc": "Returns the sort state of the Store as an object with two properties:\n<pre><code>\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n</code></pre>"
},
{
- "name": "purgeListeners",
+ "name": "getTotalCount",
"sig": "()",
"type": "function",
- "desc": "Removes all listeners for this object"
+ "desc": "Gets the total number of records in the dataset as returned by the server.\n<p>\n<em>If using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size</em>"
},
{
- "name": "releaseCapture",
- "sig": "(Observable o)",
+ "name": "hasListener",
+ "sig": "(String eventName)",
"type": "function",
- "desc": "Removes <b>all</b> added captures from the Observable."
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "removeListener",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "indexOf",
+ "sig": "(Roo.data.Record record)",
"type": "function",
- "desc": "Removes a listener"
+ "desc": "Get the index within the cache of the passed Record."
},
{
- "name": "render",
- "sig": "(String/HTMLElement/Element container)",
+ "name": "indexOfId",
+ "sig": "(String id)",
"type": "function",
- "desc": "If this is a lazy rendering component, render it to its container element."
+ "desc": "Get the index within the cache of the Record with the passed id."
},
{
- "name": "setDisabled",
- "sig": "(Boolean disabled)",
+ "name": "insert",
+ "sig": "(Number index, Roo.data.Record[] records)",
"type": "function",
- "desc": "Convenience function for setting disabled/enabled by boolean."
+ "desc": "Inserts Records to the Store at the given index and fires the add event."
},
{
- "name": "setTitle",
- "sig": "(String html)",
+ "name": "load",
+ "sig": "(Object options)",
"type": "function",
- "desc": "Updates the tab title"
+ "desc": "Loads the Record cache from the configured Proxy using the configured Reader.\n<p>\nIf using remote paging, then the first load call must specify the <em>start</em>\nand <em>limit</em> properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n<p>\n<strong>It is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.</strong>\n<p>"
},
{
- "name": "setVisible",
- "sig": "(Boolean visible)",
+ "name": "loadData",
+ "sig": "(Object data, Boolean append)",
"type": "function",
- "desc": "Convenience function to hide or show this component by boolean."
+ "desc": "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor."
},
{
- "name": "show",
- "sig": "()",
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "Show a component - removes 'hidden' class"
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
},
{
- "name": "tooltipEl",
+ "name": "purgeListeners",
"sig": "()",
"type": "function",
- "desc": "Fetch the element to display the tooltip on."
+ "desc": "Removes all listeners for this object"
},
{
- "name": "un",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "query",
+ "sig": "(String field, String/RegExp value, Boolean anyMatch)",
"type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
- }
- ]
- },
- "Roo.bootstrap.htmleditor": {
- "props": [],
- "events": [],
- "methods": []
- },
- "Roo.bootstrap.htmleditor.ToolbarStandard": {
- "props": [
- {
- "name": "disable",
- "type": "Object",
- "desc": "List of elements to disable..",
- "memberOf": ""
+ "desc": "Query the records by a specified property."
},
{
- "name": "btns",
- "type": "Array",
- "desc": "List of additional buttons.\n\n\nNEEDS Extra CSS? \n.x-html-editor-tb .x-edit-none .x-btn-text { background: none; }",
- "memberOf": ""
- }
- ],
- "events": [],
- "methods": [
- {
- "name": "updateToolbar",
- "sig": "()",
+ "name": "queryBy",
+ "sig": "(Function fn, Object scope)",
"type": "function",
- "desc": "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor."
- }
- ]
- },
- "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"
+ "desc": "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results."
},
{
- "name": "disableClass",
- "type": "String",
- "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf": "Roo.Component"
+ "name": "rejectChanges",
+ "sig": "()",
+ "type": "function",
+ "desc": "Cancel outstanding changes on all changed records."
},
{
- "name": "allowDomMove",
- "type": "Boolean",
- "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf": "Roo.Component"
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
},
{
- "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": "reload",
+ "sig": "(Object options)",
+ "type": "function",
+ "desc": "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed."
},
{
- "name": "actionMode",
- "type": "String",
- "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
- "memberOf": "Roo.Component"
+ "name": "remove",
+ "sig": "(Ext.data.Record record)",
+ "type": "function",
+ "desc": "Remove a Record from the Store and fires the remove event."
},
{
- "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}",
+ "name": "removeAll",
+ "sig": "()",
"type": "function",
- "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ "desc": "Remove all Records from the Store and fires the clear event."
},
{
- "name": "beforehide",
- "sig": "function (_self)\n{\n\n}",
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
"type": "function",
- "desc": "Fires before the component is hidden. Return false to stop the hide."
+ "desc": "Removes a listener"
},
{
- "name": "beforerender",
- "sig": "function (_self)\n{\n\n}",
+ "name": "setDefaultSort",
+ "sig": "(String fieldName, String dir)",
"type": "function",
- "desc": "Fires before the component is rendered. Return false to stop the render."
+ "desc": "Sets the default sort column and order to be used by the next load operation."
},
{
- "name": "beforeshow",
- "sig": "function (_self)\n{\n\n}",
+ "name": "sort",
+ "sig": "(String fieldName, String dir)",
"type": "function",
- "desc": "Fires before the component is shown. Return false to stop the show."
+ "desc": "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally."
},
{
- "name": "childrenrendered",
- "sig": "function (_self)\n{\n\n}",
+ "name": "sum",
+ "sig": "(String property, Number start, Number end)",
"type": "function",
- "desc": "Fires when the children have been rendered.."
+ "desc": "Sums the value of <i>property</i> for each record between start and end and returns the result."
},
{
- "name": "click",
- "sig": "function (e)\n{\n\n}",
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
"type": "function",
- "desc": "The raw click event for the entire grid."
- },
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.data.Tree": {
+ "props": [
{
- "name": "destroy",
- "sig": "function (_self)\n{\n\n}",
+ "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": "append",
+ "sig": "function (tree, parent, node, index)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is destroyed."
+ "desc": "Fires when a new child node is appended to a node in this tree."
},
{
- "name": "disable",
- "sig": "function (_self)\n{\n\n}",
+ "name": "beforeappend",
+ "sig": "function (tree, parent, node)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is disabled."
+ "desc": "Fires before a new child is appended to a node in this tree, return false to cancel the append."
},
{
- "name": "enable",
- "sig": "function (_self)\n{\n\n}",
+ "name": "beforeinsert",
+ "sig": "function (tree, parent, node, refNode)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is enabled."
+ "desc": "Fires before a new child is inserted in a node in this tree, return false to cancel the insert."
},
{
- "name": "hide",
- "sig": "function (_self)\n{\n\n}",
+ "name": "beforemove",
+ "sig": "function (tree, node, oldParent, newParent, index)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is hidden."
+ "desc": "Fires before a node is moved to a new location in the tree. Return false to cancel the move."
},
{
- "name": "mouseout",
- "sig": "function (_self, e)\n{\n\n}",
+ "name": "beforeremove",
+ "sig": "function (tree, parent, node)\n{\n\n}",
"type": "function",
- "desc": "Fires when the mouse exits this menu"
+ "desc": "Fires before a child is removed from a node in this tree, return false to cancel the remove."
},
{
- "name": "mouseover",
- "sig": "function (_self, e)\n{\n\n}",
+ "name": "insert",
+ "sig": "function (tree, parent, node, refNode)\n{\n\n}",
"type": "function",
- "desc": "Fires when the mouse is hovering over this menu"
+ "desc": "Fires when a new child node is inserted in a node in this tree."
},
{
- "name": "render",
- "sig": "function (_self)\n{\n\n}",
+ "name": "move",
+ "sig": "function (tree, node, oldParent, newParent, index)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is rendered."
+ "desc": "Fires when a node is moved to a new location in the tree"
},
{
- "name": "show",
- "sig": "function (_self)\n{\n\n}",
+ "name": "remove",
+ "sig": "function (tree, parent, node)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is shown."
+ "desc": "Fires when a child node is removed from a node in this tree."
}
],
"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": "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)",
- "type": "function",
- "desc": "Try to focus this component."
- },
- {
- "name": "getChildContainer",
- "sig": "()",
- "type": "function",
- "desc": "Fetch the element to add children to"
- },
- {
- "name": "getEl",
- "sig": "()",
+ "name": "getNodeById",
+ "sig": "(String id)",
"type": "function",
- "desc": "Returns the underlying {@link Roo.Element}."
+ "desc": "Gets a node in this tree by its id."
},
{
- "name": "getId",
+ "name": "getRootNode",
"sig": "()",
"type": "function",
- "desc": "Returns the id of this component."
+ "desc": "Returns the root node for this tree."
},
{
"name": "hasListener",
"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)",
"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": "()",
+ "name": "setRootNode",
+ "sig": "(Node node)",
"type": "function",
- "desc": "Fetch the element to display the tooltip on."
+ "desc": "Sets the root node for this tree."
},
{
"name": "un",
}
]
},
- "Roo.bootstrap.menu.Menu": {
+ "Roo.data.XmlReader": {
"props": [
{
- "name": "html",
+ "name": "totalRecords",
"type": "String",
- "desc": "Text of the menu",
+ "desc": "The DomQuery path from which to retrieve the total number of records\nin the dataset. This is only needed if the whole dataset is not passed in one go, but is being\npaged from the remote server.",
"memberOf": ""
},
{
- "name": "weight",
+ "name": "record",
"type": "String",
- "desc": "",
- "memberOf": "",
- "optvals": [
- "default",
- "primary",
- "success",
- "info",
- "warning",
- "danger",
- "inverse"
- ]
+ "desc": "The DomQuery path to the repeated element which contains record information.",
+ "memberOf": ""
},
{
- "name": "icon",
+ "name": "success",
"type": "String",
- "desc": "Font awesome icon",
+ "desc": "The DomQuery path to the success attribute used by forms.",
"memberOf": ""
},
{
- "name": "pos",
+ "name": "id",
"type": "String",
- "desc": "Menu align to (top | bottom) default bottom",
+ "desc": "The DomQuery path relative from the record element to the element that contains\na record identifier value.",
"memberOf": ""
- },
+ }
+ ],
+ "events": [],
+ "methods": [
{
- "name": "cls",
- "type": "String",
- "desc": "css class",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "newRow",
+ "sig": "(Object data)",
+ "type": "function",
+ "desc": "Create an empty record"
},
{
- "name": "style",
- "type": "String",
- "desc": "any extra css",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "read",
+ "sig": "(Object response)",
+ "type": "function",
+ "desc": "This method is only used by a DataProxy which has retrieved data from a remote server."
},
{
- "name": "xattr",
+ "name": "readRecords",
+ "sig": "(Object doc)",
+ "type": "function",
+ "desc": "Create a data block containing Roo.data.Records from an XML document."
+ }
+ ]
+ },
+ "Roo.dd": {
+ "props": [],
+ "events": [],
+ "methods": []
+ },
+ "Roo.dd.DD": {
+ "props": [
+ {
+ "name": "listeners",
"type": "Object",
- "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf": "Roo.bootstrap.Component"
+ "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": "can_build_overlaid",
- "type": "Boolean",
- "desc": "True if element can be rebuild from a HTML page",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "addInvalidHandleClass",
+ "sig": "(string cssClass)",
+ "type": "function",
+ "desc": "Lets you specify a css class of elements that will not initiate a drag"
},
{
- "name": "dataId",
- "type": "string",
- "desc": "cutomer id",
- "memberOf": "Roo.bootstrap.Component"
+ "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": "name",
- "type": "string",
- "desc": "Specifies name attribute",
- "memberOf": "Roo.bootstrap.Component"
+ "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": "tooltip",
- "type": "string",
- "desc": "Text for the tooltip",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this component"
},
{
- "name": "container_method",
- "type": "string",
- "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf": "Roo.bootstrap.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": "disableClass",
- "type": "String",
- "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf": "Roo.Component"
+ "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": "allowDomMove",
- "type": "Boolean",
- "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf": "Roo.Component"
+ "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": "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": "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": "actionMode",
- "type": "String",
- "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
- "memberOf": "Roo.Component"
+ "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": "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": "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": "beforedestroy",
- "sig": "function (_self)\n{\n\n}",
+ "name": "clearConstraints",
+ "sig": "()",
"type": "function",
- "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ "desc": "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time."
},
{
- "name": "beforehide",
- "sig": "function (_self)\n{\n\n}",
+ "name": "clearTicks",
+ "sig": "()",
"type": "function",
- "desc": "Fires before this menu is hidden"
+ "desc": "Clears any tick interval defined for this instance"
},
{
- "name": "beforerender",
- "sig": "function (_self)\n{\n\n}",
+ "name": "endDrag",
+ "sig": "(Event e)",
"type": "function",
- "desc": "Fires before the component is rendered. Return false to stop the render."
+ "desc": "Fired when we are done dragging the object"
},
{
- "name": "beforeshow",
- "sig": "function (_self)\n{\n\n}",
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
"type": "function",
- "desc": "Fires before this menu is displayed"
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "childrenrendered",
- "sig": "function (_self)\n{\n\n}",
+ "name": "function toString() {\n [native code]\n}",
+ "sig": "()",
"type": "function",
- "desc": "Fires when the children have been rendered.."
+ "desc": "toString method"
},
{
- "name": "click",
- "sig": "function (_self, e)\n{\n\n}",
+ "name": "getDragEl",
+ "sig": "()",
"type": "function",
- "desc": "Fires when this menu is clicked (or when the enter key is pressed while it is active)"
+ "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": "destroy",
- "sig": "function (_self)\n{\n\n}",
+ "name": "getEl",
+ "sig": "()",
"type": "function",
- "desc": "Fires after the component is destroyed."
+ "desc": "Returns a reference to the linked element"
},
{
- "name": "disable",
- "sig": "function (_self)\n{\n\n}",
+ "name": "hasListener",
+ "sig": "(String eventName)",
"type": "function",
- "desc": "Fires after the component is disabled."
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "enable",
- "sig": "function (_self)\n{\n\n}",
+ "name": "init",
+ "sig": "( id, String sGroup, object config)",
"type": "function",
- "desc": "Fires after the component is enabled."
+ "desc": "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass"
},
{
- "name": "hide",
- "sig": "function (_self)\n{\n\n}",
+ "name": "initTarget",
+ "sig": "( id, String sGroup, object config)",
"type": "function",
- "desc": "Fires after this menu is hidden"
+ "desc": "Initializes Targeting functionality only... the object does not\nget a mousedown handler."
},
{
- "name": "render",
- "sig": "function (_self)\n{\n\n}",
+ "name": "isLocked",
+ "sig": "()",
"type": "function",
- "desc": "Fires after the component is rendered."
+ "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": "show",
- "sig": "function (_self)\n{\n\n}",
+ "name": "isTarget",
+ "sig": "()",
"type": "function",
- "desc": "Fires after this menu is displayed"
- }
- ],
- "methods": [
+ "desc": "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false."
+ },
{
- "name": "addEvents",
- "sig": "(Object object)",
+ "name": "isValidHandleChild",
+ "sig": "(HTMLElement node)",
"type": "function",
- "desc": "Used to define events on this Observable"
+ "desc": "Checks the tag exclusion list to see if this click should be ignored"
},
{
- "name": "addListener",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "name": "lock",
+ "sig": "()",
"type": "function",
- "desc": "Appends an event handler to this component"
+ "desc": "Lock this instance"
},
{
- "name": "capture",
- "sig": "(Observable o, Function fn, Object scope)",
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"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."
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
},
{
- "name": "destroy",
+ "name": "onAvailable",
"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": "Override the onAvailable method to do what is needed after the initial\nposition was determined."
},
{
- "name": "disable",
- "sig": "()",
+ "name": "onDrag",
+ "sig": "(Event e)",
"type": "function",
- "desc": "Disable this component."
+ "desc": "Abstract method called during the onMouseMove event while dragging an\nobject."
},
{
- "name": "enable",
- "sig": "()",
+ "name": "onDragDrop",
+ "sig": "(Event e, String|DragDrop[] id)",
"type": "function",
- "desc": "Enable this component."
+ "desc": "Abstract method called when this item is dropped on another DragDrop\nobj"
},
{
- "name": "fireEvent",
- "sig": "(String eventName, Object... args)",
+ "name": "onDragEnter",
+ "sig": "(Event e, String|DragDrop[] id)",
"type": "function",
- "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ "desc": "Abstract method called when this element fist begins hovering over\nanother DragDrop obj"
},
{
- "name": "focus",
- "sig": "(Boolean selectText)",
+ "name": "onDragOut",
+ "sig": "(Event e, String|DragDrop[] id)",
"type": "function",
- "desc": "Try to focus this component."
+ "desc": "Abstract method called when we are no longer hovering over an element"
},
{
- "name": "getChildContainer",
- "sig": "()",
+ "name": "onDragOver",
+ "sig": "(Event e, String|DragDrop[] id)",
"type": "function",
- "desc": "Fetch the element to add children to"
+ "desc": "Abstract method called when this element is hovering over another\nDragDrop obj"
},
{
- "name": "getEl",
- "sig": "()",
+ "name": "onInvalidDrop",
+ "sig": "(Event e)",
"type": "function",
- "desc": "Returns the underlying {@link Roo.Element}."
+ "desc": "Abstract method called when this item is dropped on an area with no\ndrop target"
},
{
- "name": "getId",
- "sig": "()",
+ "name": "onMouseDown",
+ "sig": "(Event e)",
"type": "function",
- "desc": "Returns the id of this component."
+ "desc": "Event handler that fires when a drag/drop obj gets a mousedown"
},
{
- "name": "hasListener",
- "sig": "(String eventName)",
+ "name": "onMouseUp",
+ "sig": "(Event e)",
"type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
+ "desc": "Event handler that fires when a drag/drop obj gets a mouseup"
},
{
- "name": "hide",
+ "name": "padding",
"sig": "()",
"type": "function",
- "desc": "Hide a component - adds 'hidden' class"
+ "desc": "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object."
},
{
- "name": "initEvents",
+ "name": "purgeListeners",
"sig": "()",
"type": "function",
- "desc": "Initialize Events for the element"
+ "desc": "Removes all listeners for this object"
},
{
- "name": "isVisible",
- "sig": "()",
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
"type": "function",
- "desc": "Returns true if this component is visible."
+ "desc": "Removes <b>all</b> added captures from the Observable."
},
{
- "name": "on",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "name": "removeFromGroup",
+ "sig": "(string sGroup)",
"type": "function",
- "desc": "Appends an event handler to this element (shorthand for addListener)"
+ "desc": "Remove's this instance from the supplied interaction group"
},
{
- "name": "purgeListeners",
- "sig": "()",
+ "name": "removeInvalidHandleClass",
+ "sig": "(string cssClass)",
+ "type": "function",
+ "desc": "Unsets an invalid css class"
+ },
+ {
+ "name": "removeInvalidHandleId",
+ "sig": "(string id)",
"type": "function",
- "desc": "Removes all listeners for this object"
+ "desc": "Unsets an invalid handle id"
},
{
- "name": "releaseCapture",
- "sig": "(Observable o)",
+ "name": "removeInvalidHandleType",
+ "sig": "(string tagName)",
"type": "function",
- "desc": "Removes <b>all</b> added captures from the Observable."
+ "desc": "Unsets an excluded tag name set by addInvalidHandleType"
},
{
"name": "removeListener",
"desc": "Removes a listener"
},
{
- "name": "render",
- "sig": "(String/HTMLElement/Element container)",
+ "name": "resetConstraints",
+ "sig": "(boolean maintainOffset)",
"type": "function",
- "desc": "If this is a lazy rendering component, render it to its container element."
+ "desc": "resetConstraints must be called if you manually reposition a dd element."
},
{
- "name": "setDisabled",
- "sig": "(Boolean disabled)",
+ "name": "setDelta",
+ "sig": "(int iDeltaX, int iDeltaY)",
"type": "function",
- "desc": "Convenience function for setting disabled/enabled by boolean."
+ "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": "setVisible",
- "sig": "(Boolean visible)",
+ "name": "setDragElId",
+ "sig": "( id)",
"type": "function",
- "desc": "Convenience function to hide or show this component by boolean."
+ "desc": "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag"
},
{
- "name": "show",
- "sig": "()",
+ "name": "setDragElPos",
+ "sig": "(int iPageX, int iPageY)",
"type": "function",
- "desc": "Show a component - removes 'hidden' class"
+ "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": "tooltipEl",
- "sig": "()",
+ "name": "setHandleElId",
+ "sig": "( id)",
"type": "function",
- "desc": "Fetch the element to display the tooltip on."
+ "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": "un",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "setInitPosition",
+ "sig": "(int diffX, int diffY)",
"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"
+ "desc": "Stores the initial placement of the linked element."
},
{
- "name": "dataId",
- "type": "string",
- "desc": "cutomer id",
- "memberOf": "Roo.bootstrap.Component"
+ "name": "setOuterHandleElId",
+ "sig": "( id)",
+ "type": "function",
+ "desc": "Allows you to set an element outside of the linked element as a drag\nhandle"
},
{
- "name": "name",
- "type": "string",
- "desc": "Specifies name attribute",
- "memberOf": "Roo.bootstrap.Component"
+ "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": "tooltip",
- "type": "string",
- "desc": "Text for the tooltip",
- "memberOf": "Roo.bootstrap.Component"
+ "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": "container_method",
- "type": "string",
- "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf": "Roo.bootstrap.Component"
+ "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": "disableClass",
- "type": "String",
- "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf": "Roo.Component"
+ "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": "allowDomMove",
- "type": "Boolean",
- "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf": "Roo.Component"
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
},
{
- "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": "unlock",
+ "sig": "()",
+ "type": "function",
+ "desc": "Unlock this instace"
},
{
- "name": "actionMode",
- "type": "String",
- "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
- "memberOf": "Roo.Component"
- },
+ "name": "unreg",
+ "sig": "()",
+ "type": "function",
+ "desc": "Remove all drag and drop hooks for this element"
+ }
+ ]
+ },
+ "Roo.dd.DDProxy": {
+ "props": [
{
"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."
- },
+ "events": [],
+ "methods": [
{
- "name": "beforerender",
- "sig": "function (_self)\n{\n\n}",
+ "name": "addEvents",
+ "sig": "(Object object)",
"type": "function",
- "desc": "Fires before the component is rendered. Return false to stop the render."
+ "desc": "Used to define events on this Observable"
},
{
- "name": "beforeshow",
- "sig": "function (_self)\n{\n\n}",
+ "name": "addInvalidHandleClass",
+ "sig": "(string cssClass)",
"type": "function",
- "desc": "Fires before the component is shown. Return false to stop the show."
+ "desc": "Lets you specify a css class of elements that will not initiate a drag"
},
{
- "name": "childrenrendered",
- "sig": "function (_self)\n{\n\n}",
+ "name": "addInvalidHandleId",
+ "sig": "(string id)",
"type": "function",
- "desc": "Fires when the children have been rendered.."
+ "desc": "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag"
},
{
- "name": "destroy",
- "sig": "function (_self)\n{\n\n}",
+ "name": "addInvalidHandleType",
+ "sig": "(string tagName)",
"type": "function",
- "desc": "Fires after the component is destroyed."
+ "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": "disable",
- "sig": "function (_self)\n{\n\n}",
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "Fires after the component is disabled."
+ "desc": "Appends an event handler to this component"
},
{
- "name": "enable",
- "sig": "function (_self)\n{\n\n}",
+ "name": "addToGroup",
+ "sig": "( sGroup)",
"type": "function",
- "desc": "Fires after the component is enabled."
+ "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": "hide",
- "sig": "function (_self)\n{\n\n}",
+ "name": "alignElWithMouse",
+ "sig": "(HTMLElement el, int iPageX, int iPageY)",
"type": "function",
- "desc": "Fires after the component is hidden."
+ "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": "render",
- "sig": "function (_self)\n{\n\n}",
+ "name": "applyConfig",
+ "sig": "()",
"type": "function",
- "desc": "Fires after the component is rendered."
+ "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": "show",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is shown."
- }
- ],
- "methods": [
- {
- "name": "addEvents",
- "sig": "(Object object)",
+ "name": "autoOffset",
+ "sig": "(int iPageX, int iPageY)",
"type": "function",
- "desc": "Used to define events on this Observable"
+ "desc": "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked"
},
{
- "name": "addListener",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "name": "cachePosition",
+ "sig": "( iPageX, iPageY)",
"type": "function",
- "desc": "Appends an event handler to this component"
+ "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",
"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": "clearConstraints",
"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 any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time."
},
{
- "name": "disable",
+ "name": "clearTicks",
"sig": "()",
"type": "function",
- "desc": "Disable this component."
+ "desc": "Clears any tick interval defined for this instance"
},
{
- "name": "enable",
+ "name": "createFrame",
"sig": "()",
"type": "function",
- "desc": "Enable this component."
+ "desc": "Creates the proxy element if it does not yet exist"
},
{
- "name": "fireEvent",
- "sig": "(String eventName, Object... args)",
+ "name": "endDrag",
+ "sig": "(Event e)",
"type": "function",
- "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ "desc": "Fired when we are done dragging the object"
},
{
- "name": "focus",
- "sig": "(Boolean selectText)",
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
"type": "function",
- "desc": "Try to focus this component."
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "getChildContainer",
+ "name": "function toString() {\n [native code]\n}",
"sig": "()",
"type": "function",
- "desc": "Fetch the element to add children to"
+ "desc": "toString method"
},
{
- "name": "getEl",
+ "name": "getDragEl",
"sig": "()",
"type": "function",
- "desc": "Returns the underlying {@link Roo.Element}."
+ "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": "getId",
+ "name": "getEl",
"sig": "()",
"type": "function",
- "desc": "Returns the id of this component."
+ "desc": "Returns a reference to the linked element"
},
{
"name": "hasListener",
"desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "hide",
- "sig": "()",
+ "name": "init",
+ "sig": "( id, String sGroup, object config)",
"type": "function",
- "desc": "Hide a component - adds 'hidden' class"
+ "desc": "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass"
},
{
- "name": "initEvents",
+ "name": "initFrame",
"sig": "()",
"type": "function",
- "desc": "Initialize Events for the element"
+ "desc": "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses"
},
{
- "name": "isVisible",
- "sig": "()",
+ "name": "initTarget",
+ "sig": "( id, String sGroup, object config)",
"type": "function",
- "desc": "Returns true if this component is visible."
+ "desc": "Initializes Targeting functionality only... the object does not\nget a mousedown handler."
},
{
- "name": "on",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "name": "isLocked",
+ "sig": "()",
"type": "function",
- "desc": "Appends an event handler to this element (shorthand for addListener)"
+ "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": "purgeListeners",
+ "name": "isTarget",
"sig": "()",
"type": "function",
- "desc": "Removes all listeners for this object"
+ "desc": "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false."
},
{
- "name": "releaseCapture",
- "sig": "(Observable o)",
+ "name": "isValidHandleChild",
+ "sig": "(HTMLElement node)",
"type": "function",
- "desc": "Removes <b>all</b> added captures from the Observable."
+ "desc": "Checks the tag exclusion list to see if this click should be ignored"
},
{
- "name": "removeListener",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "lock",
+ "sig": "()",
"type": "function",
- "desc": "Removes a listener"
+ "desc": "Lock this instance"
},
{
- "name": "render",
- "sig": "(String/HTMLElement/Element container)",
+ "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."
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
},
{
- "name": "setDisabled",
- "sig": "(Boolean disabled)",
+ "name": "onAvailable",
+ "sig": "()",
"type": "function",
- "desc": "Convenience function for setting disabled/enabled by boolean."
+ "desc": "Override the onAvailable method to do what is needed after the initial\nposition was determined."
},
{
- "name": "setVisible",
- "sig": "(Boolean visible)",
+ "name": "onDrag",
+ "sig": "(Event e)",
"type": "function",
- "desc": "Convenience function to hide or show this component by boolean."
+ "desc": "Abstract method called during the onMouseMove event while dragging an\nobject."
},
{
- "name": "show",
- "sig": "()",
+ "name": "onDragDrop",
+ "sig": "(Event e, String|DragDrop[] id)",
"type": "function",
- "desc": "Show a component - removes 'hidden' class"
+ "desc": "Abstract method called when this item is dropped on another DragDrop\nobj"
},
{
- "name": "tooltipEl",
- "sig": "()",
+ "name": "onDragEnter",
+ "sig": "(Event e, String|DragDrop[] id)",
"type": "function",
- "desc": "Fetch the element to display the tooltip on."
+ "desc": "Abstract method called when this element fist begins hovering over\nanother DragDrop obj"
},
{
- "name": "un",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "onDragOut",
+ "sig": "(Event e, String|DragDrop[] id)",
"type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
- }
- ]
- },
- "Roo.data": {
- "props": [],
- "events": [],
- "methods": []
- },
- "Roo.data.ArrayReader": {
- "props": [
- {
- "name": "id",
- "type": "String",
- "desc": "(optional) The subscript within row Array that provides an ID for the Record",
- "memberOf": ""
- }
- ],
- "events": [],
- "methods": [
+ "desc": "Abstract method called when we are no longer hovering over an element"
+ },
{
- "name": "newRow",
- "sig": "(Object data)",
+ "name": "onDragOver",
+ "sig": "(Event e, String|DragDrop[] id)",
"type": "function",
- "desc": "Create an empty record"
+ "desc": "Abstract method called when this element is hovering over another\nDragDrop obj"
},
{
- "name": "readRecords",
- "sig": "(Object o)",
+ "name": "onInvalidDrop",
+ "sig": "(Event e)",
"type": "function",
- "desc": "Create a data block containing Roo.data.Records from an XML document."
- }
- ]
- },
- "Roo.data.Connection": {
- "props": [
- {
- "name": "url",
- "type": "String",
- "desc": "(Optional) The default URL to be used for requests to the server. (defaults to undefined)",
- "memberOf": ""
+ "desc": "Abstract method called when this item is dropped on an area with no\ndrop target"
},
{
- "name": "extraParams",
- "type": "Object",
- "desc": "(Optional) An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)",
- "memberOf": ""
+ "name": "onMouseDown",
+ "sig": "(Event e)",
+ "type": "function",
+ "desc": "Event handler that fires when a drag/drop obj gets a mousedown"
},
{
- "name": "defaultHeaders",
- "type": "Object",
- "desc": "(Optional) An object containing request headers which are added\n to each request made by this object. (defaults to undefined)",
- "memberOf": ""
+ "name": "onMouseUp",
+ "sig": "(Event e)",
+ "type": "function",
+ "desc": "Event handler that fires when a drag/drop obj gets a mouseup"
},
{
- "name": "method",
- "type": "String",
- "desc": "(Optional) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)",
- "memberOf": ""
+ "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": "timeout",
- "type": "Number",
- "desc": "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)",
- "memberOf": ""
+ "name": "purgeListeners",
+ "sig": "()",
+ "type": "function",
+ "desc": "Removes all listeners for this object"
},
{
- "name": "autoAbort",
- "type": "Boolean",
- "desc": "(Optional) Whether this request should abort any pending requests. (defaults to false)",
- "memberOf": ""
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
},
{
- "name": "disableCaching",
- "type": "Boolean",
- "desc": "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)",
- "memberOf": ""
+ "name": "removeFromGroup",
+ "sig": "(string sGroup)",
+ "type": "function",
+ "desc": "Remove's this instance from the supplied interaction group"
},
{
- "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": "beforerequest",
- "sig": "function (conn, options)\n{\n\n}",
+ "name": "removeInvalidHandleClass",
+ "sig": "(string cssClass)",
"type": "function",
- "desc": "Fires before a network request is made to retrieve a data object."
+ "desc": "Unsets an invalid css class"
},
{
- "name": "requestcomplete",
- "sig": "function (conn, response, options)\n{\n\n}",
+ "name": "removeInvalidHandleId",
+ "sig": "(string id)",
"type": "function",
- "desc": "Fires if the request was successfully completed."
+ "desc": "Unsets an invalid handle id"
},
{
- "name": "requestexception",
- "sig": "function (conn, response, options)\n{\n\n}",
+ "name": "removeInvalidHandleType",
+ "sig": "(string tagName)",
"type": "function",
- "desc": "Fires if an error HTTP status was returned from the server.\nSee {@link http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html} for details of HTTP status codes."
- }
- ],
- "methods": [
+ "desc": "Unsets an excluded tag name set by addInvalidHandleType"
+ },
{
- "name": "abort",
- "sig": "(Number transactionId)",
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
"type": "function",
- "desc": "Aborts any outstanding request."
+ "desc": "Removes a listener"
},
{
- "name": "addEvents",
- "sig": "(Object object)",
+ "name": "resetConstraints",
+ "sig": "(boolean maintainOffset)",
"type": "function",
- "desc": "Used to define events on this Observable"
+ "desc": "resetConstraints must be called if you manually reposition a dd element."
},
{
- "name": "addListener",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "name": "setDelta",
+ "sig": "(int iDeltaX, int iDeltaY)",
"type": "function",
- "desc": "Appends an event handler to this component"
+ "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": "capture",
- "sig": "(Observable o, Function fn, Object scope)",
+ "name": "setDragElId",
+ "sig": "( id)",
"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."
+ "desc": "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag"
},
{
- "name": "fireEvent",
- "sig": "(String eventName, Object... args)",
+ "name": "setDragElPos",
+ "sig": "(int iPageX, int iPageY)",
"type": "function",
- "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ "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": "hasListener",
- "sig": "(String eventName)",
+ "name": "setHandleElId",
+ "sig": "( id)",
"type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
+ "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": "isLoading",
- "sig": "(Number transactionId)",
+ "name": "setInitPosition",
+ "sig": "(int diffX, int diffY)",
"type": "function",
- "desc": "Determine whether this object has a request outstanding."
+ "desc": "Stores the initial placement of the linked element."
},
{
- "name": "on",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "name": "setOuterHandleElId",
+ "sig": "( id)",
"type": "function",
- "desc": "Appends an event handler to this element (shorthand for addListener)"
+ "desc": "Allows you to set an element outside of the linked element as a drag\nhandle"
},
- {
- "name": "purgeListeners",
- "sig": "()",
+ {
+ "name": "setPadding",
+ "sig": "(int iTop, int iRight, int iBot, int iLeft)",
"type": "function",
- "desc": "Removes all listeners for this object"
+ "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": "releaseCapture",
- "sig": "(Observable o)",
+ "name": "setXConstraint",
+ "sig": "(int iLeft, int iRight, int iTickSize)",
"type": "function",
- "desc": "Removes <b>all</b> added captures from the Observable."
+ "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": "removeListener",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "setYConstraint",
+ "sig": "(int iUp, int iDown, int iTickSize)",
"type": "function",
- "desc": "Removes a listener"
+ "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": "request",
- "sig": "(Object options)",
+ "name": "startDrag",
+ "sig": "(int X, int Y)",
"type": "function",
- "desc": "Sends an HTTP request to a remote server."
+ "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)"
- }
- ]
- },
- "Roo.data.DataProxy": {
- "props": [],
- "events": [
- {
- "name": "beforeload",
- "sig": "function (This, params)\n{\n\n}",
- "type": "function",
- "desc": "Fires before a network request is made to retrieve a data object."
},
{
- "name": "load",
- "sig": "function (This, o, arg)\n{\n\n}",
+ "name": "unlock",
+ "sig": "()",
"type": "function",
- "desc": "Fires before the load method's callback is called."
+ "desc": "Unlock this instace"
},
{
- "name": "loadexception",
- "sig": "function (This, o, arg, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires if an Exception occurs during data retrieval."
- }
- ],
- "methods": []
- },
- "Roo.data.DataReader": {
- "props": [],
- "events": [],
- "methods": [
- {
- "name": "newRow",
- "sig": "(Object data)",
+ "name": "unreg",
+ "sig": "()",
"type": "function",
- "desc": "Create an empty record"
+ "desc": "Remove all drag and drop hooks for this element"
}
]
},
- "Roo.data.HttpProxy": {
+ "Roo.dd.DDTarget": {
"props": [
{
- "name": "url",
- "type": "String",
- "desc": "(Optional) The default URL to be used for requests to the server. (defaults to undefined)",
- "memberOf": ""
- },
- {
- "name": "extraParams",
- "type": "Object",
- "desc": "(Optional) An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)",
- "memberOf": ""
- },
- {
- "name": "defaultHeaders",
+ "name": "listeners",
"type": "Object",
- "desc": "(Optional) An object containing request headers which are added\n to each request made by this object. (defaults to undefined)",
- "memberOf": ""
- },
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [],
+ "methods": [
{
- "name": "method",
- "type": "String",
- "desc": "(Optional) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)",
- "memberOf": ""
+ "name": "addEvents",
+ "sig": "(Object object)",
+ "type": "function",
+ "desc": "Used to define events on this Observable"
},
{
- "name": "timeout",
- "type": "Number",
- "desc": "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)",
- "memberOf": ""
+ "name": "addInvalidHandleClass",
+ "sig": "(string cssClass)",
+ "type": "function",
+ "desc": "Lets you specify a css class of elements that will not initiate a drag"
},
{
- "name": "autoAbort",
- "type": "Boolean",
- "desc": "(Optional) Whether this request should abort any pending requests. (defaults to false)",
- "memberOf": ""
+ "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": "disableCaching",
- "type": "Boolean",
- "desc": "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)",
- "memberOf": ""
- }
- ],
- "events": [
- {
- "name": "beforeload",
- "sig": "function (This, params)\n{\n\n}",
+ "name": "addInvalidHandleType",
+ "sig": "(string tagName)",
"type": "function",
- "desc": "Fires before a network request is made to retrieve a data object."
+ "desc": "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag."
},
{
- "name": "load",
- "sig": "function (This, o, arg)\n{\n\n}",
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "Fires before the load method's callback is called."
+ "desc": "Appends an event handler to this component"
},
{
- "name": "loadexception",
- "sig": "function (This, o, arg, e)\n{\n\n}",
+ "name": "addToGroup",
+ "sig": "( sGroup)",
"type": "function",
- "desc": "Fires if an Exception occurs during data retrieval."
- }
- ],
- "methods": [
+ "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": "getConnection",
+ "name": "applyConfig",
"sig": "()",
"type": "function",
- "desc": "Return the {@link Roo.data.Connection} object being used by this Proxy."
+ "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": "load",
- "sig": "(Object params, Roo.data.DataReader reader, Function callback, Object scope, Object arg)",
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
"type": "function",
- "desc": "Load data from the configured {@link Roo.data.Connection}, read the data object into\na block of Roo.data.Records using the passed {@link Roo.data.DataReader} implementation, and\nprocess that block using the passed callback."
- }
- ]
- },
- "Roo.data.JsonReader": {
- "props": [
- {
- "name": "totalProperty",
- "type": "String",
- "desc": "Name of the property from which to retrieve the total number of records\nin the dataset. This is only needed if the whole dataset is not passed in one go, but is being\npaged from the remote server.",
- "memberOf": ""
+ "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": "successProperty",
- "type": "String",
- "desc": "Name of the property from which to retrieve the success attribute used by forms.",
- "memberOf": ""
+ "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": "root",
- "type": "String",
- "desc": "name of the property which contains the Array of row objects.",
- "memberOf": ""
+ "name": "clearTicks",
+ "sig": "()",
+ "type": "function",
+ "desc": "Clears any tick interval defined for this instance"
},
{
- "name": "id",
- "type": "String",
- "desc": "Name of the property within a row object that contains a record identifier value.",
- "memberOf": ""
+ "name": "endDrag",
+ "sig": "(Event e)",
+ "type": "function",
+ "desc": "Fired when we are done dragging the object"
},
{
- "name": "fields",
- "type": "Array",
- "desc": "Array of field definition objects",
- "memberOf": ""
- }
- ],
- "events": [],
- "methods": [
- {
- "name": "newRow",
- "sig": "(Object data)",
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
"type": "function",
- "desc": "Create an empty record"
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "read",
- "sig": "(Object response)",
+ "name": "function toString() {\n [native code]\n}",
+ "sig": "()",
"type": "function",
- "desc": "This method is only used by a DataProxy which has retrieved data from a remote server."
+ "desc": "toString method"
},
{
- "name": "readRecords",
- "sig": "(Object o)",
+ "name": "getDragEl",
+ "sig": "()",
"type": "function",
- "desc": "Create a data block containing Roo.data.Records from an XML document."
- }
- ]
- },
- "Roo.data.JsonStore": {
- "props": [
- {
- "name": "fields",
- "type": "Array",
- "desc": "An array of field definition objects, or field name strings.",
- "memberOf": ""
+ "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": "isLocal",
- "type": "boolean",
- "desc": "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
- "memberOf": "Roo.data.Store"
+ "name": "getEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns a reference to the linked element"
},
{
- "name": "proxy",
- "type": "Roo.data.DataProxy",
- "desc": "The Proxy object which provides access to a data object.",
- "memberOf": "Roo.data.Store"
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "data",
- "type": "Array",
- "desc": "Inline data to be loaded when the store is initialized.",
- "memberOf": "Roo.data.Store"
+ "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": "reader",
- "type": "Roo.data.Reader",
- "desc": "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.",
- "memberOf": "Roo.data.Store"
+ "name": "initTarget",
+ "sig": "( id, String sGroup, object config)",
+ "type": "function",
+ "desc": "Initializes Targeting functionality only... the object does not\nget a mousedown handler."
},
{
- "name": "baseParams",
- "type": "Object",
- "desc": "An object containing properties which are to be sent as parameters\non any HTTP request",
- "memberOf": "Roo.data.Store"
+ "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": "sortInfo",
- "type": "Object",
- "desc": "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
- "memberOf": "Roo.data.Store"
+ "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": "multiSort",
- "type": "Boolean",
- "desc": "enable multi column sorting (sort is based on the order of columns, remote only at present)",
- "memberOf": "Roo.data.Store"
+ "name": "isValidHandleChild",
+ "sig": "(HTMLElement node)",
+ "type": "function",
+ "desc": "Checks the tag exclusion list to see if this click should be ignored"
},
{
- "name": "remoteSort",
- "type": "boolean",
- "desc": "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
- "memberOf": "Roo.data.Store"
+ "name": "lock",
+ "sig": "()",
+ "type": "function",
+ "desc": "Lock this instance"
},
{
- "name": "pruneModifiedRecords",
- "type": "boolean",
- "desc": "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
- "memberOf": "Roo.data.Store"
+ "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": "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": "add",
- "sig": "function (_self, records, index)\n{\n\n}",
+ "name": "onAvailable",
+ "sig": "()",
"type": "function",
- "desc": "Fires when Records have been added to the Store"
+ "desc": "Override the onAvailable method to do what is needed after the initial\nposition was determined."
},
{
- "name": "beforeload",
- "sig": "function (_self, options)\n{\n\n}",
+ "name": "onDrag",
+ "sig": "(Event e)",
"type": "function",
- "desc": "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled."
+ "desc": "Abstract method called during the onMouseMove event while dragging an\nobject."
},
{
- "name": "beforeloadadd",
- "sig": "function (_self, records, options)\n{\n\n}",
+ "name": "onDragDrop",
+ "sig": "(Event e, String|DragDrop[] id)",
"type": "function",
- "desc": "Fires after a new set of Records has been loaded."
+ "desc": "Abstract method called when this item is dropped on another DragDrop\nobj"
},
{
- "name": "clear",
- "sig": "function (_self)\n{\n\n}",
+ "name": "onDragEnter",
+ "sig": "(Event e, String|DragDrop[] id)",
"type": "function",
- "desc": "Fires when the data cache has been cleared."
+ "desc": "Abstract method called when this element fist begins hovering over\nanother DragDrop obj"
},
{
- "name": "datachanged",
- "sig": "function (_self)\n{\n\n}",
+ "name": "onDragOut",
+ "sig": "(Event e, String|DragDrop[] id)",
"type": "function",
- "desc": "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view."
+ "desc": "Abstract method called when we are no longer hovering over an element"
},
{
- "name": "load",
- "sig": "function (_self, records, options)\n{\n\n}",
+ "name": "onDragOver",
+ "sig": "(Event e, String|DragDrop[] id)",
"type": "function",
- "desc": "Fires after a new set of Records has been loaded, before they are added to the store."
+ "desc": "Abstract method called when this element is hovering over another\nDragDrop obj"
},
{
- "name": "loadexception",
- "sig": "function (, return, load, jsonData)\n{\n\n}",
+ "name": "onInvalidDrop",
+ "sig": "(Event e)",
"type": "function",
- "desc": "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args"
+ "desc": "Abstract method called when this item is dropped on an area with no\ndrop target"
},
{
- "name": "metachange",
- "sig": "function (_self, meta)\n{\n\n}",
+ "name": "onMouseDown",
+ "sig": "(Event e)",
"type": "function",
- "desc": "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders."
+ "desc": "Event handler that fires when a drag/drop obj gets a mousedown"
},
{
- "name": "remove",
- "sig": "function (_self, record, index)\n{\n\n}",
+ "name": "onMouseUp",
+ "sig": "(Event e)",
"type": "function",
- "desc": "Fires when a Record has been removed from the Store"
+ "desc": "Event handler that fires when a drag/drop obj gets a mouseup"
},
{
- "name": "update",
- "sig": "function (_self, record, operation)\n{\n\n}",
+ "name": "padding",
+ "sig": "()",
"type": "function",
- "desc": "Fires when a Record has been updated"
- }
- ],
- "methods": [
+ "desc": "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object."
+ },
{
- "name": "add",
- "sig": "(Roo.data.Record[] records)",
+ "name": "purgeListeners",
+ "sig": "()",
"type": "function",
- "desc": "Add Records to the Store and fires the add event."
+ "desc": "Removes all listeners for this object"
},
{
- "name": "addEvents",
- "sig": "(Object object)",
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
"type": "function",
- "desc": "Used to define events on this Observable"
+ "desc": "Removes <b>all</b> added captures from the Observable."
},
{
- "name": "addListener",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "name": "removeFromGroup",
+ "sig": "(string sGroup)",
"type": "function",
- "desc": "Appends an event handler to this component"
+ "desc": "Remove's this instance from the supplied interaction group"
},
{
- "name": "capture",
- "sig": "(Observable o, Function fn, Object scope)",
+ "name": "removeInvalidHandleClass",
+ "sig": "(string cssClass)",
"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."
+ "desc": "Unsets an invalid css class"
},
{
- "name": "clearFilter",
- "sig": "(Boolean suppressEvent)",
+ "name": "removeInvalidHandleId",
+ "sig": "(string id)",
"type": "function",
- "desc": "Revert to a view of the Record cache with no filtering applied."
+ "desc": "Unsets an invalid handle id"
},
{
- "name": "collect",
- "sig": "(String dataIndex, Boolean allowNull, Boolean bypassFilter)",
+ "name": "removeInvalidHandleType",
+ "sig": "(string tagName)",
"type": "function",
- "desc": "Collects unique values for a particular dataIndex from this store."
+ "desc": "Unsets an excluded tag name set by addInvalidHandleType"
},
{
- "name": "commitChanges",
- "sig": "()",
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
"type": "function",
- "desc": "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT."
+ "desc": "Removes a listener"
},
{
- "name": "each",
- "sig": "(Function fn, Object scope)",
+ "name": "resetConstraints",
+ "sig": "(boolean maintainOffset)",
"type": "function",
- "desc": "Calls the specified function for each of the Records in the cache."
+ "desc": "resetConstraints must be called if you manually reposition a dd element."
},
{
- "name": "filter",
- "sig": "(String field, String/RegExp value, Boolean anyMatch)",
+ "name": "setDragElId",
+ "sig": "( id)",
"type": "function",
- "desc": "Filter the records by a specified property."
+ "desc": "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag"
},
{
- "name": "filterBy",
- "sig": "(Function fn, Object scope)",
+ "name": "setHandleElId",
+ "sig": "( id)",
"type": "function",
- "desc": "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered."
+ "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": "fireEvent",
- "sig": "(String eventName, Object... args)",
+ "name": "setInitPosition",
+ "sig": "(int diffX, int diffY)",
"type": "function",
- "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ "desc": "Stores the initial placement of the linked element."
},
{
- "name": "getAt",
- "sig": "(Number index)",
+ "name": "setOuterHandleElId",
+ "sig": "( id)",
"type": "function",
- "desc": "Get the Record at the specified index."
+ "desc": "Allows you to set an element outside of the linked element as a drag\nhandle"
},
{
- "name": "getById",
- "sig": "(String id)",
+ "name": "setPadding",
+ "sig": "(int iTop, int iRight, int iBot, int iLeft)",
"type": "function",
- "desc": "Get the Record with the specified id."
+ "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": "getCount",
- "sig": "()",
+ "name": "setXConstraint",
+ "sig": "(int iLeft, int iRight, int iTickSize)",
"type": "function",
- "desc": "Gets the number of cached records.\n<p>\n<em>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size</em>"
+ "desc": "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": "getModifiedRecords",
- "sig": "()",
+ "name": "setYConstraint",
+ "sig": "(int iUp, int iDown, int iTickSize)",
"type": "function",
- "desc": "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging)."
+ "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": "getRange",
- "sig": "(Number startIndex, Number endIndex)",
+ "name": "startDrag",
+ "sig": "(int X, int Y)",
"type": "function",
- "desc": "Returns a range of Records between specified indices."
+ "desc": "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met."
},
{
- "name": "getSortState",
- "sig": "()",
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
"type": "function",
- "desc": "Returns the sort state of the Store as an object with two properties:\n<pre><code>\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n</code></pre>"
+ "desc": "Removes a listener (shorthand for removeListener)"
},
{
- "name": "getTotalCount",
+ "name": "unlock",
"sig": "()",
"type": "function",
- "desc": "Gets the total number of records in the dataset as returned by the server.\n<p>\n<em>If using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size</em>"
+ "desc": "Unlock this instace"
},
{
- "name": "hasListener",
- "sig": "(String eventName)",
+ "name": "unreg",
+ "sig": "()",
"type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
- },
+ "desc": "Remove all drag and drop hooks for this element"
+ }
+ ]
+ },
+ "Roo.dd.DragDrop": {
+ "props": [
{
- "name": "indexOf",
- "sig": "(Roo.data.Record record)",
+ "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": "Get the index within the cache of the passed Record."
+ "desc": "Used to define events on this Observable"
},
{
- "name": "indexOfId",
- "sig": "(String id)",
+ "name": "addInvalidHandleClass",
+ "sig": "(string cssClass)",
"type": "function",
- "desc": "Get the index within the cache of the Record with the passed id."
+ "desc": "Lets you specify a css class of elements that will not initiate a drag"
},
{
- "name": "insert",
- "sig": "(Number index, Roo.data.Record[] records)",
+ "name": "addInvalidHandleId",
+ "sig": "(string id)",
"type": "function",
- "desc": "Inserts Records to the Store at the given index and fires the add event."
+ "desc": "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag"
},
{
- "name": "load",
- "sig": "(Object options)",
+ "name": "addInvalidHandleType",
+ "sig": "(string tagName)",
"type": "function",
- "desc": "Loads the Record cache from the configured Proxy using the configured Reader.\n<p>\nIf using remote paging, then the first load call must specify the <em>start</em>\nand <em>limit</em> properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n<p>\n<strong>It is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.</strong>\n<p>"
+ "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": "loadData",
- "sig": "(Object data, Boolean append)",
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor."
+ "desc": "Appends an event handler to this component"
},
{
- "name": "on",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "name": "addToGroup",
+ "sig": "( sGroup)",
"type": "function",
- "desc": "Appends an event handler to this element (shorthand for addListener)"
+ "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": "purgeListeners",
+ "name": "applyConfig",
"sig": "()",
"type": "function",
- "desc": "Removes all listeners for this object"
+ "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": "query",
- "sig": "(String field, String/RegExp value, Boolean anyMatch)",
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
"type": "function",
- "desc": "Query the records by a specified property."
+ "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": "queryBy",
- "sig": "(Function fn, Object scope)",
+ "name": "clearConstraints",
+ "sig": "()",
"type": "function",
- "desc": "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results."
+ "desc": "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time."
},
{
- "name": "rejectChanges",
+ "name": "clearTicks",
"sig": "()",
"type": "function",
- "desc": "Cancel outstanding changes on all changed records."
+ "desc": "Clears any tick interval defined for this instance"
},
{
- "name": "releaseCapture",
- "sig": "(Observable o)",
+ "name": "endDrag",
+ "sig": "(Event e)",
"type": "function",
- "desc": "Removes <b>all</b> added captures from the Observable."
+ "desc": "Fired when we are done dragging the object"
},
{
- "name": "reload",
- "sig": "(Object options)",
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
"type": "function",
- "desc": "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed."
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "remove",
- "sig": "(Ext.data.Record record)",
+ "name": "function toString() {\n [native code]\n}",
+ "sig": "()",
"type": "function",
- "desc": "Remove a Record from the Store and fires the remove event."
+ "desc": "toString method"
},
{
- "name": "removeAll",
+ "name": "getDragEl",
"sig": "()",
"type": "function",
- "desc": "Remove all Records from the Store and fires the clear event."
+ "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": "removeListener",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "getEl",
+ "sig": "()",
"type": "function",
- "desc": "Removes a listener"
+ "desc": "Returns a reference to the linked element"
},
{
- "name": "setDefaultSort",
- "sig": "(String fieldName, String dir)",
+ "name": "hasListener",
+ "sig": "(String eventName)",
"type": "function",
- "desc": "Sets the default sort column and order to be used by the next load operation."
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "sort",
- "sig": "(String fieldName, String dir)",
+ "name": "init",
+ "sig": "( id, String sGroup, object config)",
"type": "function",
- "desc": "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally."
+ "desc": "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass"
},
{
- "name": "sum",
- "sig": "(String property, Number start, Number end)",
+ "name": "initTarget",
+ "sig": "( id, String sGroup, object config)",
"type": "function",
- "desc": "Sums the value of <i>property</i> for each record between start and end and returns the result."
+ "desc": "Initializes Targeting functionality only... the object does not\nget a mousedown handler."
},
{
- "name": "un",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "isLocked",
+ "sig": "()",
"type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
- }
- ]
- },
- "Roo.data.MemoryProxy": {
- "props": [],
- "events": [],
- "methods": [
+ "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": "load",
- "sig": "(Object params, Roo.data.DataReader reader, Function callback, Object scope, Object arg)",
+ "name": "isTarget",
+ "sig": "()",
"type": "function",
- "desc": "Load data from the requested source (in this case an in-memory\ndata object passed to the constructor), read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback."
- }
- ]
- },
- "Roo.data.Node": {
- "props": [
+ "desc": "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false."
+ },
{
- "name": "leaf",
- "type": "Boolean",
- "desc": "true if this node is a leaf and does not have children",
- "memberOf": ""
+ "name": "isValidHandleChild",
+ "sig": "(HTMLElement node)",
+ "type": "function",
+ "desc": "Checks the tag exclusion list to see if this click should be ignored"
},
{
- "name": "id",
- "type": "String",
- "desc": "The id for this node. If one is not specified, one is generated.",
- "memberOf": ""
+ "name": "lock",
+ "sig": "()",
+ "type": "function",
+ "desc": "Lock this instance"
},
{
- "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": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
+ },
{
- "name": "append",
- "sig": "function (tree, _self, node, index)\n{\n\n}",
+ "name": "onAvailable",
+ "sig": "()",
"type": "function",
- "desc": "Fires when a new child node is appended"
+ "desc": "Override the onAvailable method to do what is needed after the initial\nposition was determined."
},
{
- "name": "beforeappend",
- "sig": "function (tree, _self, node)\n{\n\n}",
+ "name": "onDrag",
+ "sig": "(Event e)",
"type": "function",
- "desc": "Fires before a new child is appended, return false to cancel the append."
+ "desc": "Abstract method called during the onMouseMove event while dragging an\nobject."
},
{
- "name": "beforeinsert",
- "sig": "function (tree, _self, node, refNode)\n{\n\n}",
+ "name": "onDragDrop",
+ "sig": "(Event e, String|DragDrop[] id)",
"type": "function",
- "desc": "Fires before a new child is inserted, return false to cancel the insert."
+ "desc": "Abstract method called when this item is dropped on another DragDrop\nobj"
},
{
- "name": "beforemove",
- "sig": "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
+ "name": "onDragEnter",
+ "sig": "(Event e, String|DragDrop[] id)",
"type": "function",
- "desc": "Fires before this node is moved to a new location in the tree. Return false to cancel the move."
+ "desc": "Abstract method called when this element fist begins hovering over\nanother DragDrop obj"
},
{
- "name": "beforeremove",
- "sig": "function (tree, _self, node)\n{\n\n}",
+ "name": "onDragOut",
+ "sig": "(Event e, String|DragDrop[] id)",
"type": "function",
- "desc": "Fires before a child is removed, return false to cancel the remove."
+ "desc": "Abstract method called when we are no longer hovering over an element"
},
{
- "name": "insert",
- "sig": "function (tree, _self, node, refNode)\n{\n\n}",
+ "name": "onDragOver",
+ "sig": "(Event e, String|DragDrop[] id)",
"type": "function",
- "desc": "Fires when a new child node is inserted."
+ "desc": "Abstract method called when this element is hovering over another\nDragDrop obj"
},
{
- "name": "move",
- "sig": "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
+ "name": "onInvalidDrop",
+ "sig": "(Event e)",
"type": "function",
- "desc": "Fires when this node is moved to a new location in the tree"
+ "desc": "Abstract method called when this item is dropped on an area with no\ndrop target"
},
{
- "name": "remove",
- "sig": "function (tree, _self, node)\n{\n\n}",
+ "name": "onMouseDown",
+ "sig": "(Event e)",
"type": "function",
- "desc": "Fires when a child node is removed"
- }
- ],
- "methods": [
+ "desc": "Event handler that fires when a drag/drop obj gets a mousedown"
+ },
{
- "name": "addEvents",
- "sig": "(Object object)",
+ "name": "onMouseUp",
+ "sig": "(Event e)",
"type": "function",
- "desc": "Used to define events on this Observable"
+ "desc": "Event handler that fires when a drag/drop obj gets a mouseup"
},
{
- "name": "addListener",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "name": "padding",
+ "sig": "()",
"type": "function",
- "desc": "Appends an event handler to this component"
+ "desc": "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object."
},
{
- "name": "appendChild",
- "sig": "(Node/Array node)",
+ "name": "purgeListeners",
+ "sig": "()",
"type": "function",
- "desc": "Insert node(s) as the last child node of this node."
+ "desc": "Removes all listeners for this object"
},
{
- "name": "bubble",
- "sig": "(Function fn, Object scope, Array args)",
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
"type": "function",
- "desc": "Bubbles up the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe bubble is stopped."
+ "desc": "Removes <b>all</b> added captures from the Observable."
},
{
- "name": "capture",
- "sig": "(Observable o, Function fn, Object scope)",
+ "name": "removeFromGroup",
+ "sig": "(string sGroup)",
"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."
+ "desc": "Remove's this instance from the supplied interaction group"
},
{
- "name": "cascade",
- "sig": "(Function fn, Object scope, Array args)",
+ "name": "removeInvalidHandleClass",
+ "sig": "(string cssClass)",
"type": "function",
- "desc": "Cascades down the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe cascade is stopped on that branch."
+ "desc": "Unsets an invalid css class"
},
{
- "name": "contains",
- "sig": "(Node node)",
+ "name": "removeInvalidHandleId",
+ "sig": "(string id)",
"type": "function",
- "desc": "Returns true if this node is an ancestor (at any point) of the passed node."
+ "desc": "Unsets an invalid handle id"
},
{
- "name": "eachChild",
- "sig": "(Function fn, Object scope, Array args)",
+ "name": "removeInvalidHandleType",
+ "sig": "(string tagName)",
"type": "function",
- "desc": "Interates the child nodes of this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe iteration stops."
+ "desc": "Unsets an excluded tag name set by addInvalidHandleType"
},
{
- "name": "findChild",
- "sig": "(String attribute, Mixed value)",
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
"type": "function",
- "desc": "Finds the first child that has the attribute with the specified value."
+ "desc": "Removes a listener"
},
{
- "name": "findChildBy",
- "sig": "(Function fn, Object scope)",
+ "name": "resetConstraints",
+ "sig": "(boolean maintainOffset)",
"type": "function",
- "desc": "Finds the first child by a custom function. The child matches if the function passed\nreturns true."
+ "desc": "resetConstraints must be called if you manually reposition a dd element."
},
{
- "name": "fireEvent",
- "sig": "(String eventName, Object... args)",
+ "name": "setDragElId",
+ "sig": "( id)",
"type": "function",
- "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ "desc": "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag"
},
{
- "name": "getDepth",
- "sig": "()",
+ "name": "setHandleElId",
+ "sig": "( id)",
"type": "function",
- "desc": "Returns depth of this node (the root node has a depth of 0)"
+ "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": "getOwnerTree",
- "sig": "()",
+ "name": "setInitPosition",
+ "sig": "(int diffX, int diffY)",
"type": "function",
- "desc": "Returns the tree this node is in."
+ "desc": "Stores the initial placement of the linked element."
},
{
- "name": "getPath",
- "sig": "(String attr)",
+ "name": "setOuterHandleElId",
+ "sig": "( id)",
"type": "function",
- "desc": "Returns the path for this node. The path can be used to expand or select this node programmatically."
+ "desc": "Allows you to set an element outside of the linked element as a drag\nhandle"
},
{
- "name": "hasListener",
- "sig": "(String eventName)",
+ "name": "setPadding",
+ "sig": "(int iTop, int iRight, int iBot, int iLeft)",
"type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
+ "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": "indexOf",
- "sig": "(Node node)",
+ "name": "setXConstraint",
+ "sig": "(int iLeft, int iRight, int iTickSize)",
"type": "function",
- "desc": "Returns the index of a child node"
+ "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": "insertBefore",
- "sig": "(Node node, Node refNode)",
+ "name": "setYConstraint",
+ "sig": "(int iUp, int iDown, int iTickSize)",
"type": "function",
- "desc": "Inserts the first node before the second node in this nodes childNodes collection."
+ "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": "isAncestor",
- "sig": "(Node node)",
+ "name": "startDrag",
+ "sig": "(int X, int Y)",
"type": "function",
- "desc": "Returns true if the passed node is an ancestor (at any point) of this node."
+ "desc": "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met."
},
{
- "name": "isFirst",
- "sig": "()",
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
"type": "function",
- "desc": "Returns true if this node is the first child of its parent"
+ "desc": "Removes a listener (shorthand for removeListener)"
},
{
- "name": "isLast",
+ "name": "unlock",
"sig": "()",
"type": "function",
- "desc": "Returns true if this node is the last child of its parent"
+ "desc": "Unlock this instace"
},
{
- "name": "isLeaf",
+ "name": "unreg",
"sig": "()",
"type": "function",
- "desc": "Returns true if this node is a leaf"
- },
+ "desc": "Remove all drag and drop hooks for this element"
+ }
+ ]
+ },
+ "Roo.dd.DragDropMgr": {
+ "props": [],
+ "events": [],
+ "methods": [
{
- "name": "item",
- "sig": "(Number index)",
+ "name": "getBestMatch",
+ "sig": "(DragDrop[] dds)",
"type": "function",
- "desc": "Returns the child node at the specified index."
+ "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": "on",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "name": "getCss",
+ "sig": "(String id)",
"type": "function",
- "desc": "Appends an event handler to this element (shorthand for addListener)"
+ "desc": "Returns the style property for the DOM element (i.e.,\ndocument.getElById(id).style)"
},
{
- "name": "purgeListeners",
- "sig": "()",
+ "name": "getDDById",
+ "sig": "(String id)",
"type": "function",
- "desc": "Removes all listeners for this object"
+ "desc": "Returns the DragDrop instance for a given id"
},
{
- "name": "releaseCapture",
- "sig": "(Observable o)",
+ "name": "getElement",
+ "sig": "(String id)",
"type": "function",
- "desc": "Removes <b>all</b> added captures from the Observable."
+ "desc": "Returns the actual DOM element"
},
{
- "name": "removeChild",
- "sig": "(Node node)",
+ "name": "getLocation",
+ "sig": "(DragDrop oDD)",
"type": "function",
- "desc": "Removes a child node from this node."
+ "desc": "Returns a Region object containing the drag and drop element's position\nand size, including the padding configured for it"
},
{
- "name": "removeListener",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "getPosX",
+ "sig": "( el)",
"type": "function",
- "desc": "Removes a listener"
+ "desc": "Returns the X position of an html element"
},
{
- "name": "replaceChild",
- "sig": "(Node newChild, Node oldChild)",
+ "name": "getPosY",
+ "sig": "( el)",
"type": "function",
- "desc": "Replaces one child node in this node with another."
+ "desc": "Returns the Y position of an html element"
},
{
- "name": "sort",
- "sig": "(Function fn, Object scope)",
+ "name": "getRelated",
+ "sig": "(DragDrop p_oDD, boolean bTargetsOnly)",
"type": "function",
- "desc": "Sorts this nodes children using the supplied sort function"
+ "desc": "Returns the drag and drop instances that are in all groups the\npassed in instance belongs to."
},
{
- "name": "un",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "getScrollLeft",
+ "sig": "()",
"type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
- }
- ]
- },
- "Roo.data.Record": {
- "props": [],
- "events": [],
- "methods": [
+ "desc": "Gets the scrollLeft"
+ },
{
- "name": "commit",
+ "name": "getScrollTop",
"sig": "()",
"type": "function",
- "desc": "Usually called by the {@link Roo.data.Store} which owns the Record.\nCommits all changes made to the Record since either creation, or the last commit operation.\n<p>\nDevelopers should subscribe to the {@link Roo.data.Store#update} event to have their code notified\nof commit operations."
+ "desc": "Gets the scrollTop"
},
{
- "name": "copy",
- "sig": "(String id)",
+ "name": "getStyle",
+ "sig": "(HTMLElement el, string styleProp)",
"type": "function",
- "desc": "Creates a copy of this record."
+ "desc": "Returns the specified element style property"
},
{
- "name": "create",
- "sig": "(Array o)",
+ "name": "handleWasClicked",
+ "sig": "( node)",
"type": "function",
- "desc": "Generate a constructor for a specific record layout."
+ "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": "get",
- "sig": "(String name)",
+ "name": "isDragDrop",
+ "sig": "(String id)",
"type": "function",
- "desc": "Get the value of the named field."
+ "desc": "Utility function to determine if a given element has been\nregistered as a drag drop item."
},
{
- "name": "reject",
- "sig": "()",
+ "name": "isHandle",
+ "sig": "(String id)",
"type": "function",
- "desc": "Usually called by the {@link Roo.data.Store} which owns the Record.\nRejects all changes made to the Record since either creation, or the last commit operation.\nModified fields are reverted to their original values.\n<p>\nDevelopers should subscribe to the {@link Roo.data.Store#update} event to have their code notified\nof reject operations."
+ "desc": "Utility function to determine if a given element has been\nregistered as a drag drop handle for the given Drag Drop object."
},
{
- "name": "set",
- "sig": "(String name, Object value)",
+ "name": "isLegalTarget",
+ "sig": "(DragDrop the, DragDrop the)",
"type": "function",
- "desc": "Set the named field to the specified value."
- }
- ]
- },
- "Roo.data.ScriptTagProxy": {
- "props": [
- {
- "name": "url",
- "type": "String",
- "desc": "The URL from which to request the data object.",
- "memberOf": ""
+ "desc": "Returns true if the specified dd target is a legal target for\nthe specifice drag obj"
},
{
- "name": "timeout",
- "type": "Number",
- "desc": "(Optional) The number of milliseconds to wait for a response. Defaults to 30 seconds.",
- "memberOf": ""
+ "name": "isLocked",
+ "sig": "()",
+ "type": "function",
+ "desc": "Is drag and drop locked?"
},
{
- "name": "callbackParam",
- "type": "String",
- "desc": "(Optional) The name of the parameter to pass to the server which tells\nthe server the name of the callback function set up by the load call to process the returned data object.\nDefaults to \"callback\".<p>The server-side processing must read this parameter value, and generate\njavascript output which calls this named function passing the data object as its only parameter.",
- "memberOf": ""
+ "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": "nocache",
- "type": "Boolean",
- "desc": "(Optional) Defaults to true. Disable cacheing by adding a unique parameter\nname to the request.",
- "memberOf": ""
- }
- ],
- "events": [],
- "methods": [
- {
- "name": "abort",
+ "name": "lock",
"sig": "()",
"type": "function",
- "desc": "Abort the current server request."
+ "desc": "Lock all drag and drop functionality"
},
{
- "name": "load",
- "sig": "(Object params, Roo.data.DataReader reader, Function callback, Object scope, Object arg)",
+ "name": "moveToEl",
+ "sig": "(HTMLElement moveEl, HTMLElement targetEl)",
"type": "function",
- "desc": "Load data from the configured URL, read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback."
- }
- ]
- },
- "Roo.data.SimpleStore": {
- "props": [
- {
- "name": "id",
- "type": "Number",
- "desc": "The array index of the record id. Leave blank to auto generate ids.",
- "memberOf": ""
+ "desc": "Sets the x/y position of an element to the location of the\ntarget element."
},
{
- "name": "fields",
- "type": "Array",
- "desc": "An array of field definition objects, or field name strings.",
- "memberOf": ""
+ "name": "numericSort",
+ "sig": "()",
+ "type": "function",
+ "desc": "Numeric array sort function"
},
{
- "name": "data",
- "type": "Array",
- "desc": "The multi-dimensional array of data",
- "memberOf": ""
+ "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": "isLocal",
- "type": "boolean",
- "desc": "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
- "memberOf": "Roo.data.Store"
+ "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": "proxy",
- "type": "Roo.data.DataProxy",
- "desc": "The Proxy object which provides access to a data object.",
- "memberOf": "Roo.data.Store"
+ "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": "reader",
- "type": "Roo.data.Reader",
- "desc": "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.",
- "memberOf": "Roo.data.Store"
+ "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": "baseParams",
- "type": "Object",
- "desc": "An object containing properties which are to be sent as parameters\non any HTTP request",
- "memberOf": "Roo.data.Store"
+ "name": "stopEvent",
+ "sig": "(Event e)",
+ "type": "function",
+ "desc": "Utility to stop event propagation and event default, if these\nfeatures are turned on."
},
{
- "name": "sortInfo",
- "type": "Object",
- "desc": "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
- "memberOf": "Roo.data.Store"
+ "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": "multiSort",
- "type": "Boolean",
- "desc": "enable multi column sorting (sort is based on the order of columns, remote only at present)",
- "memberOf": "Roo.data.Store"
+ "name": "unlock",
+ "sig": "()",
+ "type": "function",
+ "desc": "Unlock all drag and drop functionality"
},
{
- "name": "remoteSort",
- "type": "boolean",
- "desc": "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
- "memberOf": "Roo.data.Store"
+ "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": "pruneModifiedRecords",
- "type": "boolean",
- "desc": "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
- "memberOf": "Roo.data.Store"
+ "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",
"memberOf": "Roo.util.Observable"
}
],
- "events": [
+ "events": [],
+ "methods": [
{
- "name": "add",
- "sig": "function (_self, records, index)\n{\n\n}",
+ "name": "addEvents",
+ "sig": "(Object object)",
"type": "function",
- "desc": "Fires when Records have been added to the Store"
+ "desc": "Used to define events on this Observable"
},
{
- "name": "beforeload",
- "sig": "function (_self, options)\n{\n\n}",
+ "name": "addInvalidHandleClass",
+ "sig": "(string cssClass)",
"type": "function",
- "desc": "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled."
+ "desc": "Lets you specify a css class of elements that will not initiate a drag"
},
{
- "name": "beforeloadadd",
- "sig": "function (_self, records, options)\n{\n\n}",
+ "name": "addInvalidHandleId",
+ "sig": "(string id)",
"type": "function",
- "desc": "Fires after a new set of Records has been loaded."
+ "desc": "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag"
},
{
- "name": "clear",
- "sig": "function (_self)\n{\n\n}",
+ "name": "addInvalidHandleType",
+ "sig": "(string tagName)",
"type": "function",
- "desc": "Fires when the data cache has been cleared."
+ "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": "datachanged",
- "sig": "function (_self)\n{\n\n}",
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view."
+ "desc": "Appends an event handler to this component"
},
{
- "name": "load",
- "sig": "function (_self, records, options)\n{\n\n}",
+ "name": "addToGroup",
+ "sig": "( sGroup)",
"type": "function",
- "desc": "Fires after a new set of Records has been loaded, before they are added to the store."
+ "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": "loadexception",
- "sig": "function (, return, load, jsonData)\n{\n\n}",
+ "name": "alignElWithMouse",
+ "sig": "(HTMLElement el, int iPageX, int iPageY)",
"type": "function",
- "desc": "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args"
+ "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": "metachange",
- "sig": "function (_self, meta)\n{\n\n}",
+ "name": "applyConfig",
+ "sig": "()",
"type": "function",
- "desc": "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders."
+ "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": "remove",
- "sig": "function (_self, record, index)\n{\n\n}",
+ "name": "autoOffset",
+ "sig": "(int iPageX, int iPageY)",
"type": "function",
- "desc": "Fires when a Record has been removed from the Store"
+ "desc": "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked"
},
{
- "name": "update",
- "sig": "function (_self, record, operation)\n{\n\n}",
+ "name": "beforeDragDrop",
+ "sig": "(Roo.dd.DragDrop target, Event e, String id)",
"type": "function",
- "desc": "Fires when a Record has been updated"
- }
- ],
- "methods": [
+ "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": "add",
- "sig": "(Roo.data.Record[] records)",
+ "name": "beforeDragEnter",
+ "sig": "(Roo.dd.DragDrop target, Event e, String id)",
"type": "function",
- "desc": "Add Records to the Store and fires the add event."
+ "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": "addEvents",
- "sig": "(Object object)",
+ "name": "beforeDragOut",
+ "sig": "(Roo.dd.DragDrop target, Event e, String id)",
"type": "function",
- "desc": "Used to define events on this Observable"
+ "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": "addListener",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "name": "beforeDragOver",
+ "sig": "(Roo.dd.DragDrop target, Event e, String id)",
"type": "function",
- "desc": "Appends an event handler to this component"
+ "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": "capture",
- "sig": "(Observable o, Function fn, Object scope)",
+ "name": "beforeInvalidDrop",
+ "sig": "(Roo.dd.DragDrop target, Event e, String id)",
"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."
+ "desc": "An empty function by default, but provided so that you can perform a custom action after an invalid\ndrop has occurred."
},
{
- "name": "clearFilter",
- "sig": "(Boolean suppressEvent)",
+ "name": "cachePosition",
+ "sig": "( iPageX, iPageY)",
"type": "function",
- "desc": "Revert to a view of the Record cache with no filtering applied."
+ "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": "collect",
- "sig": "(String dataIndex, Boolean allowNull, Boolean bypassFilter)",
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
"type": "function",
- "desc": "Collects unique values for a particular dataIndex from this store."
+ "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": "commitChanges",
+ "name": "clearConstraints",
"sig": "()",
"type": "function",
- "desc": "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT."
+ "desc": "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time."
},
{
- "name": "each",
- "sig": "(Function fn, Object scope)",
+ "name": "clearTicks",
+ "sig": "()",
"type": "function",
- "desc": "Calls the specified function for each of the Records in the cache."
+ "desc": "Clears any tick interval defined for this instance"
},
{
- "name": "filter",
- "sig": "(String field, String/RegExp value, Boolean anyMatch)",
+ "name": "createFrame",
+ "sig": "()",
"type": "function",
- "desc": "Filter the records by a specified property."
+ "desc": "Creates the proxy element if it does not yet exist"
},
{
- "name": "filterBy",
- "sig": "(Function fn, Object scope)",
+ "name": "endDrag",
+ "sig": "(Event e)",
"type": "function",
- "desc": "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered."
+ "desc": "Fired when we are done dragging the object"
},
{
"name": "fireEvent",
"desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "getAt",
- "sig": "(Number index)",
+ "name": "function toString() {\n [native code]\n}",
+ "sig": "()",
"type": "function",
- "desc": "Get the Record at the specified index."
+ "desc": "toString method"
},
{
- "name": "getById",
- "sig": "(String id)",
+ "name": "getDragData",
+ "sig": "()",
"type": "function",
- "desc": "Get the Record with the specified id."
+ "desc": "Returns the data object associated with this drag source"
},
{
- "name": "getCount",
+ "name": "getDragEl",
"sig": "()",
"type": "function",
- "desc": "Gets the number of cached records.\n<p>\n<em>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size</em>"
+ "desc": "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": "getModifiedRecords",
+ "name": "getEl",
"sig": "()",
"type": "function",
- "desc": "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging)."
+ "desc": "Returns a reference to the linked element"
},
{
- "name": "getRange",
- "sig": "(Number startIndex, Number endIndex)",
+ "name": "getProxy",
+ "sig": "()",
"type": "function",
- "desc": "Returns a range of Records between specified indices."
+ "desc": "Returns the drag source's underlying {@link Roo.dd.StatusProxy}"
},
{
- "name": "getSortState",
- "sig": "()",
+ "name": "hasListener",
+ "sig": "(String eventName)",
"type": "function",
- "desc": "Returns the sort state of the Store as an object with two properties:\n<pre><code>\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n</code></pre>"
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "getTotalCount",
+ "name": "hideProxy",
"sig": "()",
"type": "function",
- "desc": "Gets the total number of records in the dataset as returned by the server.\n<p>\n<em>If using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size</em>"
+ "desc": "Hides the drag source's {@link Roo.dd.StatusProxy}"
},
{
- "name": "hasListener",
- "sig": "(String eventName)",
+ "name": "init",
+ "sig": "( id, String sGroup, object config)",
"type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
+ "desc": "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass"
},
{
- "name": "indexOf",
- "sig": "(Roo.data.Record record)",
+ "name": "initFrame",
+ "sig": "()",
"type": "function",
- "desc": "Get the index within the cache of the passed Record."
+ "desc": "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses"
},
{
- "name": "indexOfId",
- "sig": "(String id)",
+ "name": "initTarget",
+ "sig": "( id, String sGroup, object config)",
"type": "function",
- "desc": "Get the index within the cache of the Record with the passed id."
+ "desc": "Initializes Targeting functionality only... the object does not\nget a mousedown handler."
},
{
- "name": "insert",
- "sig": "(Number index, Roo.data.Record[] records)",
+ "name": "isLocked",
+ "sig": "()",
"type": "function",
- "desc": "Inserts Records to the Store at the given index and fires the add event."
+ "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": "load",
- "sig": "(Object options)",
+ "name": "isTarget",
+ "sig": "()",
"type": "function",
- "desc": "Loads the Record cache from the configured Proxy using the configured Reader.\n<p>\nIf using remote paging, then the first load call must specify the <em>start</em>\nand <em>limit</em> properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n<p>\n<strong>It is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.</strong>\n<p>"
+ "desc": "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false."
},
{
- "name": "loadData",
- "sig": "(Object data, Boolean append)",
+ "name": "isValidHandleChild",
+ "sig": "(HTMLElement node)",
"type": "function",
- "desc": "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor."
+ "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",
"desc": "Appends an event handler to this element (shorthand for addListener)"
},
{
- "name": "purgeListeners",
+ "name": "onAvailable",
"sig": "()",
"type": "function",
- "desc": "Removes all listeners for this object"
+ "desc": "Override the onAvailable method to do what is needed after the initial\nposition was determined."
},
{
- "name": "query",
- "sig": "(String field, String/RegExp value, Boolean anyMatch)",
+ "name": "onBeforeDrag",
+ "sig": "(Object data, Event e)",
"type": "function",
- "desc": "Query the records by a specified property."
+ "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": "queryBy",
- "sig": "(Function fn, Object scope)",
+ "name": "onDrag",
+ "sig": "(Event e)",
"type": "function",
- "desc": "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results."
+ "desc": "Abstract method called during the onMouseMove event while dragging an\nobject."
},
{
- "name": "rejectChanges",
- "sig": "()",
+ "name": "onDragDrop",
+ "sig": "(Event e, String|DragDrop[] id)",
"type": "function",
- "desc": "Cancel outstanding changes on all changed records."
+ "desc": "Abstract method called when this item is dropped on another DragDrop\nobj"
},
{
- "name": "releaseCapture",
- "sig": "(Observable o)",
+ "name": "onDragEnter",
+ "sig": "(Event e, String|DragDrop[] id)",
"type": "function",
- "desc": "Removes <b>all</b> added captures from the Observable."
+ "desc": "Abstract method called when this element fist begins hovering over\nanother DragDrop obj"
},
{
- "name": "reload",
- "sig": "(Object options)",
+ "name": "onDragOut",
+ "sig": "(Event e, String|DragDrop[] id)",
"type": "function",
- "desc": "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed."
+ "desc": "Abstract method called when we are no longer hovering over an element"
},
{
- "name": "remove",
- "sig": "(Ext.data.Record record)",
+ "name": "onDragOver",
+ "sig": "(Event e, String|DragDrop[] id)",
"type": "function",
- "desc": "Remove a Record from the Store and fires the remove event."
+ "desc": "Abstract method called when this element is hovering over another\nDragDrop obj"
},
{
- "name": "removeAll",
+ "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": "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": "Remove all Records from the Store and fires the clear event."
+ "desc": "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object."
},
{
- "name": "removeListener",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "purgeListeners",
+ "sig": "()",
"type": "function",
- "desc": "Removes a listener"
+ "desc": "Removes all listeners for this object"
},
{
- "name": "setDefaultSort",
- "sig": "(String fieldName, String dir)",
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
"type": "function",
- "desc": "Sets the default sort column and order to be used by the next load operation."
+ "desc": "Removes <b>all</b> added captures from the Observable."
},
{
- "name": "sort",
- "sig": "(String fieldName, String dir)",
+ "name": "removeFromGroup",
+ "sig": "(string sGroup)",
"type": "function",
- "desc": "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally."
+ "desc": "Remove's this instance from the supplied interaction group"
},
{
- "name": "sum",
- "sig": "(String property, Number start, Number end)",
+ "name": "removeInvalidHandleClass",
+ "sig": "(string cssClass)",
"type": "function",
- "desc": "Sums the value of <i>property</i> for each record between start and end and returns the result."
+ "desc": "Unsets an invalid css class"
},
{
- "name": "un",
+ "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 (shorthand for removeListener)"
- }
- ]
- },
- "Roo.data.SortTypes": {
- "props": [],
- "events": [],
- "methods": [
+ "desc": "Removes a listener"
+ },
{
- "name": "asDate",
- "sig": "(Mixed s)",
+ "name": "resetConstraints",
+ "sig": "(boolean maintainOffset)",
"type": "function",
- "desc": "Date sorting"
+ "desc": "resetConstraints must be called if you manually reposition a dd element."
},
{
- "name": "asFloat",
- "sig": "(Mixed s)",
+ "name": "setDelta",
+ "sig": "(int iDeltaX, int iDeltaY)",
"type": "function",
- "desc": "Float sorting"
+ "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": "asInt",
- "sig": "(Mixed s)",
+ "name": "setDragElId",
+ "sig": "( id)",
"type": "function",
- "desc": "Integer sorting"
+ "desc": "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag"
},
{
- "name": "asText",
- "sig": "(Mixed s)",
+ "name": "setDragElPos",
+ "sig": "(int iPageX, int iPageY)",
"type": "function",
- "desc": "Strips all HTML tags to sort on text only"
+ "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": "asUCString",
- "sig": "(Mixed s)",
+ "name": "setHandleElId",
+ "sig": "( id)",
"type": "function",
- "desc": "Case insensitive string"
+ "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": "asUCText",
- "sig": "(Mixed s)",
+ "name": "setInitPosition",
+ "sig": "(int diffX, int diffY)",
"type": "function",
- "desc": "Strips all HTML tags to sort on text only - Case insensitive"
+ "desc": "Stores the initial placement of the linked element."
},
{
- "name": "none",
- "sig": "(Mixed s)",
+ "name": "setOuterHandleElId",
+ "sig": "( id)",
"type": "function",
- "desc": "Default sort that does nothing"
- }
- ]
- },
- "Roo.data.Store": {
- "props": [
+ "desc": "Allows you to set an element outside of the linked element as a drag\nhandle"
+ },
{
- "name": "isLocal",
- "type": "boolean",
- "desc": "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
- "memberOf": ""
+ "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": "proxy",
- "type": "Roo.data.DataProxy",
- "desc": "The Proxy object which provides access to a data object.",
- "memberOf": ""
+ "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": "data",
- "type": "Array",
- "desc": "Inline data to be loaded when the store is initialized.",
- "memberOf": ""
+ "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": "reader",
- "type": "Roo.data.Reader",
- "desc": "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.",
- "memberOf": ""
+ "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": "baseParams",
- "type": "Object",
- "desc": "An object containing properties which are to be sent as parameters\non any HTTP request",
- "memberOf": ""
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
},
{
- "name": "sortInfo",
- "type": "Object",
- "desc": "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
- "memberOf": ""
+ "name": "unlock",
+ "sig": "()",
+ "type": "function",
+ "desc": "Unlock this instace"
},
{
- "name": "multiSort",
+ "name": "unreg",
+ "sig": "()",
+ "type": "function",
+ "desc": "Remove all drag and drop hooks for this element"
+ }
+ ]
+ },
+ "Roo.dd.DragZone": {
+ "props": [
+ {
+ "name": "containerScroll",
"type": "Boolean",
- "desc": "enable multi column sorting (sort is based on the order of columns, remote only at present)",
+ "desc": "True to register this container with the Scrollmanager\nfor auto scrolling during drag operations.",
"memberOf": ""
},
{
- "name": "remoteSort",
- "type": "boolean",
- "desc": "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
+ "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": "pruneModifiedRecords",
- "type": "boolean",
- "desc": "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
- "memberOf": ""
+ "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"
+ },
+ {
+ "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"
},
{
"name": "listeners",
"memberOf": "Roo.util.Observable"
}
],
- "events": [
+ "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": "add",
- "sig": "function (_self, records, index)\n{\n\n}",
+ "name": "addInvalidHandleType",
+ "sig": "(string tagName)",
"type": "function",
- "desc": "Fires when Records have been added to the Store"
+ "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": "beforeload",
- "sig": "function (_self, options)\n{\n\n}",
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled."
+ "desc": "Appends an event handler to this component"
},
{
- "name": "beforeloadadd",
- "sig": "function (_self, records, options)\n{\n\n}",
+ "name": "addToGroup",
+ "sig": "( sGroup)",
"type": "function",
- "desc": "Fires after a new set of Records has been loaded."
+ "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": "clear",
- "sig": "function (_self)\n{\n\n}",
+ "name": "afterRepair",
+ "sig": "()",
"type": "function",
- "desc": "Fires when the data cache has been cleared."
+ "desc": "Called after a repair of an invalid drop. By default, highlights this.dragData.ddel"
},
{
- "name": "datachanged",
- "sig": "function (_self)\n{\n\n}",
+ "name": "alignElWithMouse",
+ "sig": "(HTMLElement el, int iPageX, int iPageY)",
"type": "function",
- "desc": "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view."
+ "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": "load",
- "sig": "function (_self, records, options)\n{\n\n}",
+ "name": "applyConfig",
+ "sig": "()",
"type": "function",
- "desc": "Fires after a new set of Records has been loaded, before they are added to the store."
+ "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": "loadexception",
- "sig": "function (, return, load, jsonData)\n{\n\n}",
+ "name": "autoOffset",
+ "sig": "(int iPageX, int iPageY)",
"type": "function",
- "desc": "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args"
+ "desc": "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked"
},
{
- "name": "metachange",
- "sig": "function (_self, meta)\n{\n\n}",
+ "name": "beforeDragDrop",
+ "sig": "(Roo.dd.DragDrop target, Event e, String id)",
"type": "function",
- "desc": "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders."
+ "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": "remove",
- "sig": "function (_self, record, index)\n{\n\n}",
+ "name": "beforeDragEnter",
+ "sig": "(Roo.dd.DragDrop target, Event e, String id)",
"type": "function",
- "desc": "Fires when a Record has been removed from the Store"
+ "desc": "An empty function by default, but provided so that you can perform a custom action\nbefore the dragged item enters the drop target and optionally cancel the onDragEnter."
},
{
- "name": "update",
- "sig": "function (_self, record, operation)\n{\n\n}",
+ "name": "beforeDragOut",
+ "sig": "(Roo.dd.DragDrop target, Event e, String id)",
"type": "function",
- "desc": "Fires when a Record has been updated"
- }
- ],
- "methods": [
+ "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": "add",
- "sig": "(Roo.data.Record[] records)",
+ "name": "beforeDragOver",
+ "sig": "(Roo.dd.DragDrop target, Event e, String id)",
"type": "function",
- "desc": "Add Records to the Store and fires the add event."
+ "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": "addEvents",
- "sig": "(Object object)",
+ "name": "beforeInvalidDrop",
+ "sig": "(Roo.dd.DragDrop target, Event e, String id)",
"type": "function",
- "desc": "Used to define events on this Observable"
+ "desc": "An empty function by default, but provided so that you can perform a custom action after an invalid\ndrop has occurred."
},
{
- "name": "addListener",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "name": "cachePosition",
+ "sig": "( iPageX, iPageY)",
"type": "function",
- "desc": "Appends an event handler to this component"
+ "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",
"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": "clearFilter",
- "sig": "(Boolean suppressEvent)",
+ "name": "clearConstraints",
+ "sig": "()",
"type": "function",
- "desc": "Revert to a view of the Record cache with no filtering applied."
+ "desc": "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time."
},
{
- "name": "collect",
- "sig": "(String dataIndex, Boolean allowNull, Boolean bypassFilter)",
+ "name": "clearTicks",
+ "sig": "()",
"type": "function",
- "desc": "Collects unique values for a particular dataIndex from this store."
+ "desc": "Clears any tick interval defined for this instance"
},
{
- "name": "commitChanges",
+ "name": "createFrame",
"sig": "()",
"type": "function",
- "desc": "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT."
+ "desc": "Creates the proxy element if it does not yet exist"
},
{
- "name": "each",
- "sig": "(Function fn, Object scope)",
+ "name": "endDrag",
+ "sig": "(Event e)",
"type": "function",
- "desc": "Calls the specified function for each of the Records in the cache."
+ "desc": "Fired when we are done dragging the object"
},
{
- "name": "filter",
- "sig": "(String field, String/RegExp value, Boolean anyMatch)",
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
"type": "function",
- "desc": "Filter the records by a specified property."
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "filterBy",
- "sig": "(Function fn, Object scope)",
+ "name": "function toString() {\n [native code]\n}",
+ "sig": "()",
"type": "function",
- "desc": "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered."
+ "desc": "toString method"
},
{
- "name": "fireEvent",
- "sig": "(String eventName, Object... args)",
+ "name": "getDragData",
+ "sig": "(EventObject e)",
"type": "function",
- "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ "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": "getAt",
- "sig": "(Number index)",
+ "name": "getDragEl",
+ "sig": "()",
"type": "function",
- "desc": "Get the Record at the specified index."
+ "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": "getById",
- "sig": "(String id)",
+ "name": "getEl",
+ "sig": "()",
"type": "function",
- "desc": "Get the Record with the specified id."
+ "desc": "Returns a reference to the linked element"
},
{
- "name": "getCount",
+ "name": "getProxy",
"sig": "()",
"type": "function",
- "desc": "Gets the number of cached records.\n<p>\n<em>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size</em>"
+ "desc": "Returns the drag source's underlying {@link Roo.dd.StatusProxy}"
},
{
- "name": "getModifiedRecords",
- "sig": "()",
+ "name": "getRepairXY",
+ "sig": "(EventObject e)",
"type": "function",
- "desc": "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging)."
+ "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": "getRange",
- "sig": "(Number startIndex, Number endIndex)",
+ "name": "hasListener",
+ "sig": "(String eventName)",
"type": "function",
- "desc": "Returns a range of Records between specified indices."
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "getSortState",
+ "name": "hideProxy",
"sig": "()",
"type": "function",
- "desc": "Returns the sort state of the Store as an object with two properties:\n<pre><code>\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n</code></pre>"
+ "desc": "Hides the drag source's {@link Roo.dd.StatusProxy}"
},
{
- "name": "getTotalCount",
- "sig": "()",
+ "name": "init",
+ "sig": "( id, String sGroup, object config)",
"type": "function",
- "desc": "Gets the total number of records in the dataset as returned by the server.\n<p>\n<em>If using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size</em>"
+ "desc": "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass"
},
{
- "name": "hasListener",
- "sig": "(String eventName)",
+ "name": "initFrame",
+ "sig": "()",
"type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
+ "desc": "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses"
},
{
- "name": "indexOf",
- "sig": "(Roo.data.Record record)",
+ "name": "initTarget",
+ "sig": "( id, String sGroup, object config)",
"type": "function",
- "desc": "Get the index within the cache of the passed Record."
+ "desc": "Initializes Targeting functionality only... the object does not\nget a mousedown handler."
},
{
- "name": "indexOfId",
- "sig": "(String id)",
+ "name": "isLocked",
+ "sig": "()",
"type": "function",
- "desc": "Get the index within the cache of the Record with the passed id."
+ "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": "insert",
- "sig": "(Number index, Roo.data.Record[] records)",
+ "name": "isTarget",
+ "sig": "()",
"type": "function",
- "desc": "Inserts Records to the Store at the given index and fires the add event."
+ "desc": "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false."
},
{
- "name": "load",
- "sig": "(Object options)",
+ "name": "isValidHandleChild",
+ "sig": "(HTMLElement node)",
"type": "function",
- "desc": "Loads the Record cache from the configured Proxy using the configured Reader.\n<p>\nIf using remote paging, then the first load call must specify the <em>start</em>\nand <em>limit</em> properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n<p>\n<strong>It is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.</strong>\n<p>"
+ "desc": "Checks the tag exclusion list to see if this click should be ignored"
},
{
- "name": "loadData",
- "sig": "(Object data, Boolean append)",
+ "name": "lock",
+ "sig": "()",
"type": "function",
- "desc": "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor."
+ "desc": "Lock this instance"
},
{
"name": "on",
"desc": "Appends an event handler to this element (shorthand for addListener)"
},
{
- "name": "purgeListeners",
+ "name": "onAvailable",
"sig": "()",
"type": "function",
- "desc": "Removes all listeners for this object"
+ "desc": "Override the onAvailable method to do what is needed after the initial\nposition was determined."
},
{
- "name": "query",
- "sig": "(String field, String/RegExp value, Boolean anyMatch)",
+ "name": "onBeforeDrag",
+ "sig": "(Object data, Event e)",
"type": "function",
- "desc": "Query the records by a specified property."
+ "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": "queryBy",
- "sig": "(Function fn, Object scope)",
+ "name": "onDrag",
+ "sig": "(Event e)",
"type": "function",
- "desc": "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results."
+ "desc": "Abstract method called during the onMouseMove event while dragging an\nobject."
},
{
- "name": "rejectChanges",
- "sig": "()",
+ "name": "onDragDrop",
+ "sig": "(Event e, String|DragDrop[] id)",
"type": "function",
- "desc": "Cancel outstanding changes on all changed records."
+ "desc": "Abstract method called when this item is dropped on another DragDrop\nobj"
},
{
- "name": "releaseCapture",
- "sig": "(Observable o)",
+ "name": "onDragEnter",
+ "sig": "(Event e, String|DragDrop[] id)",
"type": "function",
- "desc": "Removes <b>all</b> added captures from the Observable."
+ "desc": "Abstract method called when this element fist begins hovering over\nanother DragDrop obj"
},
{
- "name": "reload",
- "sig": "(Object options)",
+ "name": "onDragOut",
+ "sig": "(Event e, String|DragDrop[] id)",
"type": "function",
- "desc": "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed."
+ "desc": "Abstract method called when we are no longer hovering over an element"
},
{
- "name": "remove",
- "sig": "(Ext.data.Record record)",
+ "name": "onDragOver",
+ "sig": "(Event e, String|DragDrop[] id)",
"type": "function",
- "desc": "Remove a Record from the Store and fires the remove event."
+ "desc": "Abstract method called when this element is hovering over another\nDragDrop obj"
},
{
- "name": "removeAll",
- "sig": "()",
+ "name": "onInitDrag",
+ "sig": "(Number x, Number y)",
"type": "function",
- "desc": "Remove all Records from the Store and fires the clear event."
+ "desc": "Called once drag threshold has been reached to initialize the proxy element. By default, it clones the\nthis.dragData.ddel"
},
{
- "name": "removeListener",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "onInvalidDrop",
+ "sig": "(Event e)",
"type": "function",
- "desc": "Removes a listener"
+ "desc": "Abstract method called when this item is dropped on an area with no\ndrop target"
},
{
- "name": "setDefaultSort",
- "sig": "(String fieldName, String dir)",
+ "name": "onMouseDown",
+ "sig": "(Event e)",
"type": "function",
- "desc": "Sets the default sort column and order to be used by the next load operation."
+ "desc": "Event handler that fires when a drag/drop obj gets a mousedown"
},
{
- "name": "sort",
- "sig": "(String fieldName, String dir)",
+ "name": "onMouseUp",
+ "sig": "(Event e)",
"type": "function",
- "desc": "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally."
+ "desc": "Event handler that fires when a drag/drop obj gets a mouseup"
},
{
- "name": "sum",
- "sig": "(String property, Number start, Number end)",
+ "name": "onStartDrag",
+ "sig": "(Number x, Number y)",
"type": "function",
- "desc": "Sums the value of <i>property</i> for each record between start and end and returns the result."
+ "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": "un",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "padding",
+ "sig": "()",
"type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
- }
- ]
- },
- "Roo.data.Tree": {
- "props": [
- {
- "name": "listeners",
- "type": "Object",
- "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf": "Roo.util.Observable"
- }
- ],
- "events": [
+ "desc": "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object."
+ },
{
- "name": "append",
- "sig": "function (tree, parent, node, index)\n{\n\n}",
+ "name": "purgeListeners",
+ "sig": "()",
"type": "function",
- "desc": "Fires when a new child node is appended to a node in this tree."
+ "desc": "Removes all listeners for this object"
},
{
- "name": "beforeappend",
- "sig": "function (tree, parent, node)\n{\n\n}",
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
"type": "function",
- "desc": "Fires before a new child is appended to a node in this tree, return false to cancel the append."
+ "desc": "Removes <b>all</b> added captures from the Observable."
},
{
- "name": "beforeinsert",
- "sig": "function (tree, parent, node, refNode)\n{\n\n}",
+ "name": "removeFromGroup",
+ "sig": "(string sGroup)",
"type": "function",
- "desc": "Fires before a new child is inserted in a node in this tree, return false to cancel the insert."
+ "desc": "Remove's this instance from the supplied interaction group"
},
{
- "name": "beforemove",
- "sig": "function (tree, node, oldParent, newParent, index)\n{\n\n}",
+ "name": "removeInvalidHandleClass",
+ "sig": "(string cssClass)",
"type": "function",
- "desc": "Fires before a node is moved to a new location in the tree. Return false to cancel the move."
+ "desc": "Unsets an invalid css class"
},
{
- "name": "beforeremove",
- "sig": "function (tree, parent, node)\n{\n\n}",
+ "name": "removeInvalidHandleId",
+ "sig": "(string id)",
"type": "function",
- "desc": "Fires before a child is removed from a node in this tree, return false to cancel the remove."
+ "desc": "Unsets an invalid handle id"
},
{
- "name": "insert",
- "sig": "function (tree, parent, node, refNode)\n{\n\n}",
+ "name": "removeInvalidHandleType",
+ "sig": "(string tagName)",
"type": "function",
- "desc": "Fires when a new child node is inserted in a node in this tree."
+ "desc": "Unsets an excluded tag name set by addInvalidHandleType"
},
{
- "name": "move",
- "sig": "function (tree, node, oldParent, newParent, index)\n{\n\n}",
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
"type": "function",
- "desc": "Fires when a node is moved to a new location in the tree"
+ "desc": "Removes a listener"
},
{
- "name": "remove",
- "sig": "function (tree, parent, node)\n{\n\n}",
+ "name": "resetConstraints",
+ "sig": "(boolean maintainOffset)",
"type": "function",
- "desc": "Fires when a child node is removed from a node in this tree."
- }
- ],
- "methods": [
+ "desc": "resetConstraints must be called if you manually reposition a dd element."
+ },
{
- "name": "addEvents",
- "sig": "(Object object)",
+ "name": "setDelta",
+ "sig": "(int iDeltaX, int iDeltaY)",
"type": "function",
- "desc": "Used to define events on this Observable"
+ "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": "addListener",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "name": "setDragElId",
+ "sig": "( id)",
"type": "function",
- "desc": "Appends an event handler to this component"
+ "desc": "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag"
},
{
- "name": "capture",
- "sig": "(Observable o, Function fn, Object scope)",
+ "name": "setDragElPos",
+ "sig": "(int iPageX, int iPageY)",
"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."
+ "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": "fireEvent",
- "sig": "(String eventName, Object... args)",
+ "name": "setHandleElId",
+ "sig": "( id)",
"type": "function",
- "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ "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": "getNodeById",
- "sig": "(String id)",
+ "name": "setInitPosition",
+ "sig": "(int diffX, int diffY)",
"type": "function",
- "desc": "Gets a node in this tree by its id."
+ "desc": "Stores the initial placement of the linked element."
},
{
- "name": "getRootNode",
- "sig": "()",
+ "name": "setOuterHandleElId",
+ "sig": "( id)",
"type": "function",
- "desc": "Returns the root node for this tree."
+ "desc": "Allows you to set an element outside of the linked element as a drag\nhandle"
},
{
- "name": "hasListener",
- "sig": "(String eventName)",
+ "name": "setPadding",
+ "sig": "(int iTop, int iRight, int iBot, int iLeft)",
"type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
+ "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": "on",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "name": "setXConstraint",
+ "sig": "(int iLeft, int iRight, int iTickSize)",
"type": "function",
- "desc": "Appends an event handler to this element (shorthand for addListener)"
+ "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": "purgeListeners",
- "sig": "()",
+ "name": "setYConstraint",
+ "sig": "(int iUp, int iDown, int iTickSize)",
"type": "function",
- "desc": "Removes all listeners for this object"
+ "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": "releaseCapture",
- "sig": "(Observable o)",
+ "name": "startDrag",
+ "sig": "(int X, int Y)",
"type": "function",
- "desc": "Removes <b>all</b> added captures from the Observable."
+ "desc": "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met."
},
{
- "name": "removeListener",
+ "name": "un",
"sig": "(String eventName, Function handler, Object scope)",
"type": "function",
- "desc": "Removes a listener"
+ "desc": "Removes a listener (shorthand for removeListener)"
},
{
- "name": "setRootNode",
- "sig": "(Node node)",
+ "name": "unlock",
+ "sig": "()",
"type": "function",
- "desc": "Sets the root node for this tree."
+ "desc": "Unlock this instace"
},
{
- "name": "un",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "unreg",
+ "sig": "()",
"type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
+ "desc": "Remove all drag and drop hooks for this element"
}
]
},
- "Roo.data.XmlReader": {
+ "Roo.dd.DropTarget": {
"props": [
{
- "name": "totalRecords",
+ "name": "overClass",
"type": "String",
- "desc": "The DomQuery path from which to retrieve the total number of records\nin the dataset. This is only needed if the whole dataset is not passed in one go, but is being\npaged from the remote server.",
+ "desc": "The CSS class applied to the drop target element while the drag source is over it (defaults to \"\").",
"memberOf": ""
},
{
- "name": "record",
+ "name": "ddGroup",
"type": "String",
- "desc": "The DomQuery path to the repeated element which contains record information.",
+ "desc": "The drag drop group to handle drop events for",
"memberOf": ""
},
{
- "name": "success",
+ "name": "dropAllowed",
"type": "String",
- "desc": "The DomQuery path to the success attribute used by forms.",
+ "desc": "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
"memberOf": ""
},
{
- "name": "id",
+ "name": "dropNotAllowed",
"type": "String",
- "desc": "The DomQuery path relative from the record element to the element that contains\na record identifier value.",
+ "desc": "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
+ "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",
+ "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": "newRow",
- "sig": "(Object data)",
+ "name": "drop",
+ "sig": "function (source, e, data)\n{\n\n}",
"type": "function",
- "desc": "Create an empty record"
+ "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": "read",
- "sig": "(Object response)",
+ "name": "enter",
+ "sig": "function (source, e, data)\n{\n\n}",
"type": "function",
- "desc": "This method is only used by a DataProxy which has retrieved data from a remote server."
+ "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": "readRecords",
- "sig": "(Object doc)",
+ "name": "out",
+ "sig": "function (source, e, data)\n{\n\n}",
"type": "function",
- "desc": "Create a data block containing Roo.data.Records from an XML document."
- }
- ]
- },
- "Roo.dd": {
- "props": [],
- "events": [],
- "methods": []
- },
- "Roo.dd.DD": {
- "props": [
+ "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": "listeners",
- "type": "Object",
- "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf": "Roo.util.Observable"
+ "name": "over",
+ "sig": "function (source, e, data)\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"
}
],
- "events": [],
"methods": [
{
"name": "addEvents",
"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": "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": "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.DDProxy": {
+ "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": "Roo.dd.DropTarget"
+ },
+ {
+ "name": "ddGroup",
+ "type": "String",
+ "desc": "The drag drop group to handle drop events for",
+ "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": "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": "Roo.dd.DropTarget"
+ },
+ {
+ "name": "success",
+ "type": "boolean",
+ "desc": "set this after drop listener..",
+ "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": "Roo.dd.DropTarget"
+ },
{
"name": "listeners",
"type": "Object",
"memberOf": "Roo.util.Observable"
}
],
- "events": [],
+ "events": [
+ {
+ "name": "drop",
+ "sig": "function (source, e, data)\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"
+ },
+ {
+ "name": "enter",
+ "sig": "function (source, e, data)\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"
+ },
+ {
+ "name": "out",
+ "sig": "function (source, e, data)\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."
+ },
+ {
+ "name": "over",
+ "sig": "function (source, e, data)\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": [
{
"name": "addEvents",
"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": "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": "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": "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": "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": "()",
"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.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"
- }
- ],
+ "Roo.dd.Registry": {
+ "props": [],
"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)",
+ "name": "getHandle",
+ "sig": "(String|HTMLElement id)",
"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."
+ "desc": "Returns the handle registered for a DOM Node by id"
},
{
- "name": "clearConstraints",
- "sig": "()",
+ "name": "getHandleFromEvent",
+ "sig": "(Event e)",
"type": "function",
- "desc": "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time."
+ "desc": "Returns the handle that is registered for the DOM node that is the target of the event"
},
{
- "name": "clearTicks",
- "sig": "()",
+ "name": "getTarget",
+ "sig": "(String|HTMLElement id)",
"type": "function",
- "desc": "Clears any tick interval defined for this instance"
+ "desc": "Returns a custom data object that is registered for a DOM node by id"
},
{
- "name": "endDrag",
+ "name": "getTargetFromEvent",
"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)."
+ "desc": "Returns a custom data object that is registered for the DOM node that is the target of the event"
},
{
- "name": "function toString() {\n [native code]\n}",
- "sig": "()",
+ "name": "register",
+ "sig": "(String|HTMLElement element, Object data)",
"type": "function",
- "desc": "toString method"
+ "desc": "Register a drag drop element"
},
{
- "name": "getDragEl",
- "sig": "()",
+ "name": "unregister",
+ "sig": "(String|HTMLElement element)",
"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": "Unregister a drag drop element"
+ }
+ ]
+ },
+ "Roo.dd.ScrollManager": {
+ "props": [],
+ "events": [],
+ "methods": [
{
- "name": "getEl",
+ "name": "refreshCache",
"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"
+ "desc": "Manually trigger a cache refresh."
},
{
- "name": "initTarget",
- "sig": "( id, String sGroup, object config)",
+ "name": "register",
+ "sig": "(String/HTMLElement/Element/Array el)",
"type": "function",
- "desc": "Initializes Targeting functionality only... the object does not\nget a mousedown handler."
+ "desc": "Registers new overflow element(s) to auto scroll"
},
{
- "name": "isLocked",
- "sig": "()",
+ "name": "unregister",
+ "sig": "(String/HTMLElement/Element/Array el)",
"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": "Unregisters overflow element(s) so they are no longer scrolled"
+ }
+ ]
+ },
+ "Roo.dd.StatusProxy": {
+ "props": [
{
- "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": "dropAllowed",
+ "type": "String",
+ "desc": "The CSS class to apply to the status element when drop is allowed (defaults to \"x-dd-drop-ok\").",
+ "memberOf": ""
},
{
- "name": "isValidHandleChild",
- "sig": "(HTMLElement node)",
- "type": "function",
- "desc": "Checks the tag exclusion list to see if this click should be ignored"
- },
+ "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": "lock",
+ "name": "getEl",
"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)"
+ "desc": "Returns the underlying proxy {@link Roo.Layer}"
},
{
- "name": "onAvailable",
+ "name": "getGhost",
"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"
+ "desc": "Returns the ghost element"
},
{
- "name": "onDragOver",
- "sig": "(Event e, String|DragDrop[] id)",
+ "name": "hide",
+ "sig": "(Boolean clear)",
"type": "function",
- "desc": "Abstract method called when this element is hovering over another\nDragDrop obj"
+ "desc": "Hides the proxy"
},
{
- "name": "onInvalidDrop",
- "sig": "(Event e)",
+ "name": "repair",
+ "sig": "(Array xy, Function callback, Object scope)",
"type": "function",
- "desc": "Abstract method called when this item is dropped on an area with no\ndrop target"
+ "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": "onMouseDown",
- "sig": "(Event e)",
+ "name": "reset",
+ "sig": "(Boolean clearGhost)",
"type": "function",
- "desc": "Event handler that fires when a drag/drop obj gets a mousedown"
+ "desc": "Resets the status indicator to the default dropNotAllowed value"
},
{
- "name": "onMouseUp",
- "sig": "(Event e)",
+ "name": "setStatus",
+ "sig": "(String cssClass)",
"type": "function",
- "desc": "Event handler that fires when a drag/drop obj gets a mouseup"
+ "desc": "Updates the proxy's visual element to indicate the status of whether or not drop is allowed\nover the current target element."
},
{
- "name": "padding",
+ "name": "show",
"sig": "()",
"type": "function",
- "desc": "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object."
+ "desc": "Displays this proxy"
},
{
- "name": "purgeListeners",
+ "name": "stop",
"sig": "()",
"type": "function",
- "desc": "Removes all listeners for this object"
+ "desc": "Stops the repair animation if it's currently running"
},
{
- "name": "releaseCapture",
- "sig": "(Observable o)",
+ "name": "sync",
+ "sig": "()",
"type": "function",
- "desc": "Removes <b>all</b> added captures from the Observable."
+ "desc": "Force the Layer to sync its shadow and shim positions to the element"
},
{
- "name": "removeFromGroup",
- "sig": "(string sGroup)",
+ "name": "update",
+ "sig": "(String html)",
"type": "function",
- "desc": "Remove's this instance from the supplied interaction group"
- },
+ "desc": "Updates the contents of the ghost element"
+ }
+ ]
+ },
+ "Roo.doc": {
+ "props": [],
+ "events": [],
+ "methods": []
+ },
+ "Roo.doc.Book": {
+ "props": [
{
- "name": "removeInvalidHandleClass",
- "sig": "(string cssClass)",
- "type": "function",
- "desc": "Unsets an invalid css class"
+ "name": "title",
+ "type": "String",
+ "desc": "Title of the book",
+ "memberOf": ""
},
{
- "name": "removeInvalidHandleId",
- "sig": "(string id)",
- "type": "function",
- "desc": "Unsets an invalid handle id"
+ "name": "abstract",
+ "type": "String",
+ "desc": "Abstract (or just add para's to the book, and it will get added to the abstract)",
+ "memberOf": ""
},
{
- "name": "removeInvalidHandleType",
- "sig": "(string tagName)",
- "type": "function",
- "desc": "Unsets an excluded tag name set by addInvalidHandleType"
+ "name": "cls",
+ "type": "String",
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "removeListener",
- "sig": "(String eventName, Function handler, Object scope)",
- "type": "function",
- "desc": "Removes a listener"
+ "name": "style",
+ "type": "String",
+ "desc": "any extra css",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "resetConstraints",
- "sig": "(boolean maintainOffset)",
- "type": "function",
- "desc": "resetConstraints must be called if you manually reposition a dd element."
+ "name": "xattr",
+ "type": "Object",
+ "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "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": "can_build_overlaid",
+ "type": "Boolean",
+ "desc": "True if element can be rebuild from a HTML page",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "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": "dataId",
+ "type": "string",
+ "desc": "cutomer id",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "setInitPosition",
- "sig": "(int diffX, int diffY)",
- "type": "function",
- "desc": "Stores the initial placement of the linked element."
+ "name": "name",
+ "type": "string",
+ "desc": "Specifies name attribute",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "setOuterHandleElId",
- "sig": "( id)",
- "type": "function",
- "desc": "Allows you to set an element outside of the linked element as a drag\nhandle"
+ "name": "tooltip",
+ "type": "string",
+ "desc": "Text for the tooltip",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "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": "container_method",
+ "type": "string",
+ "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
},
{
- "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": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
},
{
- "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": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
},
{
- "name": "un",
- "sig": "(String eventName, Function handler, Object scope)",
- "type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
+ "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": "unlock",
- "sig": "()",
- "type": "function",
- "desc": "Unlock this instace"
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
},
- {
- "name": "unreg",
- "sig": "()",
- "type": "function",
- "desc": "Remove all drag and drop hooks for this element"
- }
- ]
- },
- "Roo.dd.DragDrop": {
- "props": [
{
"name": "listeners",
"type": "Object",
"memberOf": "Roo.util.Observable"
}
],
- "events": [],
- "methods": [
+ "events": [
{
- "name": "addEvents",
- "sig": "(Object object)",
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Used to define events on this Observable"
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
},
{
- "name": "addInvalidHandleClass",
- "sig": "(string cssClass)",
+ "name": "beforehide",
+ "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 before the component is hidden. Return false to stop the hide."
},
{
- "name": "addInvalidHandleId",
- "sig": "(string id)",
+ "name": "beforerender",
+ "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 before the component is rendered. Return false to stop the render."
},
{
- "name": "addInvalidHandleType",
- "sig": "(string tagName)",
+ "name": "beforeshow",
+ "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 before the component is shown. Return false to stop the show."
},
{
- "name": "addListener",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "name": "childrenrendered",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Appends an event handler to this component"
+ "desc": "Fires when the children have been rendered.."
},
{
- "name": "addToGroup",
- "sig": "( sGroup)",
+ "name": "destroy",
+ "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 destroyed."
},
{
- "name": "applyConfig",
- "sig": "()",
+ "name": "disable",
+ "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 disabled."
},
{
- "name": "capture",
- "sig": "(Observable o, Function fn, Object scope)",
+ "name": "enable",
+ "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."
+ "desc": "Fires after the component is enabled."
},
{
- "name": "clearConstraints",
- "sig": "()",
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
"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": "Fires after the component is hidden."
},
{
- "name": "clearTicks",
- "sig": "()",
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Clears any tick interval defined for this instance"
+ "desc": "Fires after the component is rendered."
},
{
- "name": "endDrag",
- "sig": "(Event e)",
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fired when we are done dragging the object"
- },
+ "desc": "Fires after the component is shown."
+ }
+ ],
+ "methods": [
{
- "name": "fireEvent",
- "sig": "(String eventName, Object... args)",
+ "name": "addEvents",
+ "sig": "(Object object)",
"type": "function",
- "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ "desc": "Used to define events on this Observable"
},
{
- "name": "function toString() {\n [native code]\n}",
- "sig": "()",
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "toString method"
+ "desc": "Appends an event handler to this component"
},
{
- "name": "getDragEl",
- "sig": "()",
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
"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": "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": "getEl",
+ "name": "destroy",
"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."
+ "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": "isLocked",
+ "name": "disable",
"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": "Disable this component."
},
{
- "name": "isTarget",
+ "name": "enable",
"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"
+ "desc": "Enable this component."
},
{
- "name": "lock",
- "sig": "()",
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
"type": "function",
- "desc": "Lock this instance"
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "on",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "name": "focus",
+ "sig": "(Boolean selectText)",
"type": "function",
- "desc": "Appends an event handler to this element (shorthand for addListener)"
+ "desc": "Try to focus this component."
},
{
- "name": "onAvailable",
+ "name": "getChildContainer",
"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."
+ "desc": "Fetch the element to add children to"
},
{
- "name": "onDragDrop",
- "sig": "(Event e, String|DragDrop[] id)",
+ "name": "getEl",
+ "sig": "()",
"type": "function",
- "desc": "Abstract method called when this item is dropped on another DragDrop\nobj"
+ "desc": "Returns the underlying {@link Roo.Element}."
},
{
- "name": "onDragEnter",
- "sig": "(Event e, String|DragDrop[] id)",
+ "name": "getId",
+ "sig": "()",
"type": "function",
- "desc": "Abstract method called when this element fist begins hovering over\nanother DragDrop obj"
+ "desc": "Returns the id of this component."
},
{
- "name": "onDragOut",
- "sig": "(Event e, String|DragDrop[] id)",
+ "name": "getVisibilityEl",
+ "sig": "()",
"type": "function",
- "desc": "Abstract method called when we are no longer hovering over an element"
+ "desc": "Get the element that will be used to show or hide"
},
{
- "name": "onDragOver",
- "sig": "(Event e, String|DragDrop[] id)",
+ "name": "hasListener",
+ "sig": "(String eventName)",
"type": "function",
- "desc": "Abstract method called when this element is hovering over another\nDragDrop obj"
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "onInvalidDrop",
- "sig": "(Event e)",
+ "name": "hide",
+ "sig": "()",
"type": "function",
- "desc": "Abstract method called when this item is dropped on an area with no\ndrop target"
+ "desc": "Hide a component - adds 'hidden' class"
},
{
- "name": "onMouseDown",
- "sig": "(Event e)",
+ "name": "initEvents",
+ "sig": "()",
"type": "function",
- "desc": "Event handler that fires when a drag/drop obj gets a mousedown"
+ "desc": "Initialize Events for the element"
},
{
- "name": "onMouseUp",
- "sig": "(Event e)",
+ "name": "isVisible",
+ "sig": "()",
"type": "function",
- "desc": "Event handler that fires when a drag/drop obj gets a mouseup"
+ "desc": "Returns true if this component is visible."
},
{
- "name": "padding",
- "sig": "()",
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object."
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
},
{
"name": "purgeListeners",
"desc": "Removes <b>all</b> added captures from the Observable."
},
{
- "name": "removeFromGroup",
- "sig": "(string sGroup)",
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
"type": "function",
- "desc": "Remove's this instance from the supplied interaction group"
+ "desc": "Removes a listener"
},
{
- "name": "removeInvalidHandleClass",
- "sig": "(string cssClass)",
+ "name": "render",
+ "sig": "(String/HTMLElement/Element container)",
"type": "function",
- "desc": "Unsets an invalid css class"
+ "desc": "If this is a lazy rendering component, render it to its container element."
},
{
- "name": "removeInvalidHandleId",
- "sig": "(string id)",
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
"type": "function",
- "desc": "Unsets an invalid handle id"
+ "desc": "Convenience function for setting disabled/enabled by boolean."
},
{
- "name": "removeInvalidHandleType",
- "sig": "(string tagName)",
+ "name": "setVisible",
+ "sig": "(Boolean visible)",
"type": "function",
- "desc": "Unsets an excluded tag name set by addInvalidHandleType"
+ "desc": "Convenience function to hide or show this component by boolean."
},
{
- "name": "removeListener",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "show",
+ "sig": "()",
"type": "function",
- "desc": "Removes a listener"
+ "desc": "Show a component - removes 'hidden' class"
},
{
- "name": "resetConstraints",
- "sig": "(boolean maintainOffset)",
+ "name": "tooltipEl",
+ "sig": "()",
"type": "function",
- "desc": "resetConstraints must be called if you manually reposition a dd element."
+ "desc": "Fetch the element to display the tooltip on."
},
{
- "name": "setDragElId",
- "sig": "( id)",
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
"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": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.doc.Entry": {
+ "props": [
{
- "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": "name",
+ "type": "",
+ "desc": "{String} name of method",
+ "memberOf": ""
},
{
- "name": "setInitPosition",
- "sig": "(int diffX, int diffY)",
- "type": "function",
- "desc": "Stores the initial placement of the linked element."
+ "name": "purpose",
+ "type": "",
+ "desc": "{String} short description of method.",
+ "memberOf": ""
},
{
- "name": "setOuterHandleElId",
- "sig": "( id)",
- "type": "function",
- "desc": "Allows you to set an element outside of the linked element as a drag\nhandle"
+ "name": "cls",
+ "type": "String",
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "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": "style",
+ "type": "String",
+ "desc": "any extra css",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "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": "xattr",
+ "type": "Object",
+ "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "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": "can_build_overlaid",
+ "type": "Boolean",
+ "desc": "True if element can be rebuild from a HTML page",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "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": "dataId",
+ "type": "string",
+ "desc": "cutomer id",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "un",
- "sig": "(String eventName, Function handler, Object scope)",
- "type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
+ "name": "tooltip",
+ "type": "string",
+ "desc": "Text for the tooltip",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "unlock",
- "sig": "()",
- "type": "function",
- "desc": "Unlock this instace"
+ "name": "container_method",
+ "type": "string",
+ "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "unreg",
- "sig": "()",
- "type": "function",
- "desc": "Remove all drag and drop hooks for this element"
- }
- ]
- },
- "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
},
{
- "name": "getCss",
- "sig": "(String id)",
- "type": "function",
- "desc": "Returns the style property for the DOM element (i.e.,\ndocument.getElById(id).style)"
+ "name": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
},
{
- "name": "getDDById",
- "sig": "(String id)",
- "type": "function",
- "desc": "Returns the DragDrop instance for a given id"
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
},
{
- "name": "getElement",
- "sig": "(String id)",
- "type": "function",
- "desc": "Returns the actual DOM element"
+ "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": "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": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
},
{
- "name": "getPosX",
- "sig": "( el)",
+ "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": "Returns the X position of an html element"
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
},
{
- "name": "getPosY",
- "sig": "( el)",
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Returns the Y position of an html element"
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
},
{
- "name": "getRelated",
- "sig": "(DragDrop p_oDD, boolean bTargetsOnly)",
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Returns the drag and drop instances that are in all groups the\npassed in instance belongs to."
+ "desc": "Fires before the component is rendered. Return false to stop the render."
},
{
- "name": "getScrollLeft",
- "sig": "()",
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Gets the scrollLeft"
+ "desc": "Fires before the component is shown. Return false to stop the show."
},
{
- "name": "getScrollTop",
- "sig": "()",
+ "name": "childrenrendered",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Gets the scrollTop"
+ "desc": "Fires when the children have been rendered.."
},
{
- "name": "getStyle",
- "sig": "(HTMLElement el, string styleProp)",
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Returns the specified element style property"
+ "desc": "Fires after the component is destroyed."
},
{
- "name": "handleWasClicked",
- "sig": "( node)",
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
"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."
+ "desc": "Fires after the component is disabled."
},
{
- "name": "isDragDrop",
- "sig": "(String id)",
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Utility function to determine if a given element has been\nregistered as a drag drop item."
+ "desc": "Fires after the component is enabled."
},
{
- "name": "isHandle",
- "sig": "(String id)",
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
"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."
+ "desc": "Fires after the component is hidden."
},
{
- "name": "isLegalTarget",
- "sig": "(DragDrop the, DragDrop the)",
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Returns true if the specified dd target is a legal target for\nthe specifice drag obj"
+ "desc": "Fires after the component is rendered."
},
{
- "name": "isLocked",
- "sig": "()",
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Is drag and drop locked?"
- },
+ "desc": "Fires after the component is shown."
+ }
+ ],
+ "methods": [
{
- "name": "isTypeOfDD",
- "sig": "(Object the)",
+ "name": "addEvents",
+ "sig": "(Object object)",
"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."
+ "desc": "Used to define events on this Observable"
},
{
- "name": "lock",
- "sig": "()",
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "Lock all drag and drop functionality"
+ "desc": "Appends an event handler to this component"
},
{
- "name": "moveToEl",
- "sig": "(HTMLElement moveEl, HTMLElement targetEl)",
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
"type": "function",
- "desc": "Sets the x/y position of an element to the location of the\ntarget element."
+ "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": "numericSort",
+ "name": "destroy",
"sig": "()",
"type": "function",
- "desc": "Numeric array sort 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": "refreshCache",
- "sig": "(Object groups)",
+ "name": "disable",
+ "sig": "()",
"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>"
+ "desc": "Disable this component."
},
{
- "name": "regDragDrop",
- "sig": "(DragDrop oDD, String sGroup)",
+ "name": "enable",
+ "sig": "()",
"type": "function",
- "desc": "Each DragDrop instance must be registered with the DragDropMgr.\nThis is executed in DragDrop.init()"
+ "desc": "Enable this component."
},
{
- "name": "regHandle",
- "sig": "(String sDDId, String sHandleId)",
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
"type": "function",
- "desc": "Each DragDrop handle element must be registered. This is done\nautomatically when executing DragDrop.setHandleElId()"
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "startDrag",
- "sig": "( x, y)",
+ "name": "focus",
+ "sig": "(Boolean selectText)",
"type": "function",
- "desc": "Fired when either the drag pixel threshol or the mousedown hold\ntime threshold has been met."
+ "desc": "Try to focus this component."
},
{
- "name": "stopEvent",
- "sig": "(Event e)",
+ "name": "getChildContainer",
+ "sig": "()",
"type": "function",
- "desc": "Utility to stop event propagation and event default, if these\nfeatures are turned on."
+ "desc": "Fetch the element to add children to"
},
{
- "name": "swapNode",
- "sig": "( n1, n2)",
+ "name": "getEl",
+ "sig": "()",
"type": "function",
- "desc": "Swap two nodes. In IE, we use the native method, for others we\nemulate the IE behavior"
+ "desc": "Returns the underlying {@link Roo.Element}."
},
{
- "name": "unlock",
+ "name": "getId",
"sig": "()",
"type": "function",
- "desc": "Unlock all drag and drop functionality"
+ "desc": "Returns the id of this component."
},
{
- "name": "verifyEl",
- "sig": "(HTMLElement el)",
+ "name": "getVisibilityEl",
+ "sig": "()",
"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": ""
+ "desc": "Get the element that will be used to show or hide"
},
{
- "name": "listeners",
- "type": "Object",
- "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf": "Roo.util.Observable"
- }
- ],
- "events": [],
- "methods": [
- {
- "name": "addEvents",
- "sig": "(Object object)",
+ "name": "hasListener",
+ "sig": "(String eventName)",
"type": "function",
- "desc": "Used to define events on this Observable"
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "addInvalidHandleClass",
- "sig": "(string cssClass)",
+ "name": "hide",
+ "sig": "()",
"type": "function",
- "desc": "Lets you specify a css class of elements that will not initiate a drag"
+ "desc": "Hide a component - adds 'hidden' class"
},
{
- "name": "addInvalidHandleId",
- "sig": "(string id)",
+ "name": "initEvents",
+ "sig": "()",
"type": "function",
- "desc": "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag"
+ "desc": "Initialize Events for the element"
},
{
- "name": "addInvalidHandleType",
- "sig": "(string tagName)",
+ "name": "isVisible",
+ "sig": "()",
"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": "Returns true if this component is visible."
},
{
- "name": "addListener",
+ "name": "on",
"sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "Appends an event handler to this component"
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
},
{
- "name": "addToGroup",
- "sig": "( sGroup)",
+ "name": "purgeListeners",
+ "sig": "()",
"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": "Removes all listeners for this object"
},
{
- "name": "alignElWithMouse",
- "sig": "(HTMLElement el, int iPageX, int iPageY)",
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
"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": "Removes <b>all</b> added captures from the Observable."
},
{
- "name": "applyConfig",
- "sig": "()",
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
"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": "Removes a listener"
},
{
- "name": "autoOffset",
- "sig": "(int iPageX, int iPageY)",
+ "name": "render",
+ "sig": "(String/HTMLElement/Element container)",
"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": "If this is a lazy rendering component, render it to its container element."
},
{
- "name": "beforeDragDrop",
- "sig": "(Roo.dd.DragDrop target, Event e, String id)",
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
"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": "Convenience function for setting disabled/enabled by boolean."
},
{
- "name": "beforeDragEnter",
- "sig": "(Roo.dd.DragDrop target, Event e, String id)",
+ "name": "setVisible",
+ "sig": "(Boolean visible)",
"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": "Convenience function to hide or show this component by boolean."
},
{
- "name": "beforeDragOut",
- "sig": "(Roo.dd.DragDrop target, Event e, String id)",
+ "name": "show",
+ "sig": "()",
"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": "Show a component - removes 'hidden' class"
},
{
- "name": "beforeDragOver",
- "sig": "(Roo.dd.DragDrop target, Event e, String id)",
+ "name": "tooltipEl",
+ "sig": "()",
"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": "Fetch the element to display the tooltip on."
},
{
- "name": "beforeInvalidDrop",
- "sig": "(Roo.dd.DragDrop target, Event e, String id)",
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
"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": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.doc.Example": {
+ "props": [
{
- "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": "title",
+ "type": "String",
+ "desc": "short title describing example",
+ "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": "lang",
+ "type": "String",
+ "desc": "code language.",
+ "memberOf": "",
+ "optvals": [
+ "php",
+ "txt",
+ "sql"
+ ]
},
{
- "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": "code",
+ "type": "String",
+ "desc": "example code",
+ "memberOf": ""
},
{
- "name": "clearTicks",
- "sig": "()",
- "type": "function",
- "desc": "Clears any tick interval defined for this instance"
+ "name": "output",
+ "type": "String",
+ "desc": "The expected output from the code",
+ "memberOf": ""
},
{
- "name": "createFrame",
- "sig": "()",
- "type": "function",
- "desc": "Creates the proxy element if it does not yet exist"
+ "name": "outputlang",
+ "type": "String",
+ "desc": "php|txt|sql) output language",
+ "memberOf": ""
},
{
- "name": "endDrag",
- "sig": "(Event e)",
- "type": "function",
- "desc": "Fired when we are done dragging the object"
+ "name": "cls",
+ "type": "String",
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "fireEvent",
- "sig": "(String eventName, Object... args)",
- "type": "function",
- "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ "name": "style",
+ "type": "String",
+ "desc": "any extra css",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "function toString() {\n [native code]\n}",
- "sig": "()",
- "type": "function",
- "desc": "toString method"
+ "name": "xattr",
+ "type": "Object",
+ "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "getDragData",
- "sig": "()",
- "type": "function",
- "desc": "Returns the data object associated with this drag source"
+ "name": "can_build_overlaid",
+ "type": "Boolean",
+ "desc": "True if element can be rebuild from a HTML page",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "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": "dataId",
+ "type": "string",
+ "desc": "cutomer id",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "getEl",
- "sig": "()",
- "type": "function",
- "desc": "Returns a reference to the linked element"
+ "name": "name",
+ "type": "string",
+ "desc": "Specifies name attribute",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "getProxy",
- "sig": "()",
- "type": "function",
- "desc": "Returns the drag source's underlying {@link Roo.dd.StatusProxy}"
+ "name": "tooltip",
+ "type": "string",
+ "desc": "Text for the tooltip",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "hasListener",
- "sig": "(String eventName)",
- "type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
+ "name": "container_method",
+ "type": "string",
+ "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "hideProxy",
- "sig": "()",
- "type": "function",
- "desc": "Hides the drag source's {@link Roo.dd.StatusProxy}"
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
},
{
- "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": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
},
{
- "name": "initFrame",
- "sig": "()",
- "type": "function",
- "desc": "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses"
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
},
{
- "name": "initTarget",
- "sig": "( id, String sGroup, object config)",
- "type": "function",
- "desc": "Initializes Targeting functionality only... the object does not\nget a mousedown handler."
+ "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": "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": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
},
{
- "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": "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": "isValidHandleChild",
- "sig": "(HTMLElement node)",
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Checks the tag exclusion list to see if this click should be ignored"
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
},
{
- "name": "lock",
- "sig": "()",
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Lock this instance"
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
},
{
- "name": "on",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Appends an event handler to this element (shorthand for addListener)"
+ "desc": "Fires before the component is rendered. Return false to stop the render."
},
{
- "name": "onAvailable",
- "sig": "()",
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Override the onAvailable method to do what is needed after the initial\nposition was determined."
+ "desc": "Fires before the component is shown. Return false to stop the show."
},
{
- "name": "onBeforeDrag",
- "sig": "(Object data, Event e)",
+ "name": "childrenrendered",
+ "sig": "function (_self)\n{\n\n}",
"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."
+ "desc": "Fires when the children have been rendered.."
},
{
- "name": "onDrag",
- "sig": "(Event e)",
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Abstract method called during the onMouseMove event while dragging an\nobject."
+ "desc": "Fires after the component is destroyed."
},
{
- "name": "onDragDrop",
- "sig": "(Event e, String|DragDrop[] id)",
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Abstract method called when this item is dropped on another DragDrop\nobj"
+ "desc": "Fires after the component is disabled."
},
{
- "name": "onDragEnter",
- "sig": "(Event e, String|DragDrop[] id)",
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Abstract method called when this element fist begins hovering over\nanother DragDrop obj"
+ "desc": "Fires after the component is enabled."
},
{
- "name": "onDragOut",
- "sig": "(Event e, String|DragDrop[] id)",
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Abstract method called when we are no longer hovering over an element"
+ "desc": "Fires after the component is hidden."
},
{
- "name": "onDragOver",
- "sig": "(Event e, String|DragDrop[] id)",
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Abstract method called when this element is hovering over another\nDragDrop obj"
+ "desc": "Fires after the component is rendered."
},
{
- "name": "onInvalidDrop",
- "sig": "(Event e)",
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Abstract method called when this item is dropped on an area with no\ndrop target"
- },
+ "desc": "Fires after the component is shown."
+ }
+ ],
+ "methods": [
{
- "name": "onMouseDown",
- "sig": "(Event e)",
+ "name": "addEvents",
+ "sig": "(Object object)",
"type": "function",
- "desc": "Event handler that fires when a drag/drop obj gets a mousedown"
+ "desc": "Used to define events on this Observable"
},
{
- "name": "onMouseUp",
- "sig": "(Event e)",
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "Event handler that fires when a drag/drop obj gets a mouseup"
+ "desc": "Appends an event handler to this component"
},
{
- "name": "onStartDrag",
- "sig": "(Number x, Number y)",
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
"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."
+ "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": "padding",
+ "name": "destroy",
"sig": "()",
"type": "function",
- "desc": "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object."
+ "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": "purgeListeners",
+ "name": "disable",
"sig": "()",
"type": "function",
- "desc": "Removes all listeners for this object"
+ "desc": "Disable this component."
},
{
- "name": "releaseCapture",
- "sig": "(Observable o)",
+ "name": "enable",
+ "sig": "()",
"type": "function",
- "desc": "Removes <b>all</b> added captures from the Observable."
+ "desc": "Enable this component."
},
{
- "name": "removeFromGroup",
- "sig": "(string sGroup)",
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
"type": "function",
- "desc": "Remove's this instance from the supplied interaction group"
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "removeInvalidHandleClass",
- "sig": "(string cssClass)",
+ "name": "focus",
+ "sig": "(Boolean selectText)",
"type": "function",
- "desc": "Unsets an invalid css class"
+ "desc": "Try to focus this component."
},
{
- "name": "removeInvalidHandleId",
- "sig": "(string id)",
+ "name": "getChildContainer",
+ "sig": "()",
"type": "function",
- "desc": "Unsets an invalid handle id"
+ "desc": "Fetch the element to add children to"
},
{
- "name": "removeInvalidHandleType",
- "sig": "(string tagName)",
+ "name": "getEl",
+ "sig": "()",
"type": "function",
- "desc": "Unsets an excluded tag name set by addInvalidHandleType"
+ "desc": "Returns the underlying {@link Roo.Element}."
},
{
- "name": "removeListener",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "getId",
+ "sig": "()",
"type": "function",
- "desc": "Removes a listener"
+ "desc": "Returns the id of this component."
},
{
- "name": "resetConstraints",
- "sig": "(boolean maintainOffset)",
+ "name": "getVisibilityEl",
+ "sig": "()",
"type": "function",
- "desc": "resetConstraints must be called if you manually reposition a dd element."
+ "desc": "Get the element that will be used to show or hide"
},
{
- "name": "setDelta",
- "sig": "(int iDeltaX, int iDeltaY)",
+ "name": "hasListener",
+ "sig": "(String eventName)",
"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)"
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "setDragElId",
- "sig": "( id)",
+ "name": "hide",
+ "sig": "()",
"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": "Hide a component - adds 'hidden' class"
},
{
- "name": "setDragElPos",
- "sig": "(int iPageX, int iPageY)",
+ "name": "initEvents",
+ "sig": "()",
"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."
+ "desc": "Initialize Events for the element"
},
{
- "name": "setHandleElId",
- "sig": "( id)",
+ "name": "isVisible",
+ "sig": "()",
"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": "Returns true if this component is visible."
},
{
- "name": "setInitPosition",
- "sig": "(int diffX, int diffY)",
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "Stores the initial placement of the linked element."
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
},
{
- "name": "setOuterHandleElId",
- "sig": "( id)",
+ "name": "purgeListeners",
+ "sig": "()",
"type": "function",
- "desc": "Allows you to set an element outside of the linked element as a drag\nhandle"
+ "desc": "Removes all listeners for this object"
},
{
- "name": "setPadding",
- "sig": "(int iTop, int iRight, int iBot, int iLeft)",
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
"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": "Removes <b>all</b> added captures from the Observable."
},
{
- "name": "setXConstraint",
- "sig": "(int iLeft, int iRight, int iTickSize)",
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
"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": "Removes a listener"
},
{
- "name": "setYConstraint",
- "sig": "(int iUp, int iDown, int iTickSize)",
+ "name": "render",
+ "sig": "(String/HTMLElement/Element container)",
"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": "If this is a lazy rendering component, render it to its container element."
},
{
- "name": "startDrag",
- "sig": "(int X, int Y)",
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
"type": "function",
- "desc": "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met."
+ "desc": "Convenience function for setting disabled/enabled by boolean."
},
{
- "name": "un",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "setVisible",
+ "sig": "(Boolean visible)",
"type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
+ "desc": "Convenience function to hide or show this component by boolean."
},
{
- "name": "unlock",
+ "name": "show",
"sig": "()",
"type": "function",
- "desc": "Unlock this instace"
+ "desc": "Show a component - removes 'hidden' class"
},
{
- "name": "unreg",
+ "name": "tooltipEl",
"sig": "()",
"type": "function",
- "desc": "Remove all drag and drop hooks for this element"
+ "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.dd.DragZone": {
+ "Roo.doc.NavCategory": {
"props": [
{
- "name": "containerScroll",
- "type": "Boolean",
- "desc": "True to register this container with the Scrollmanager\nfor auto scrolling during drag operations.",
+ "name": "title",
+ "type": "string",
+ "desc": "",
"memberOf": ""
},
{
- "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)",
+ "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": "dropAllowed",
+ "name": "cls",
"type": "String",
- "desc": "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
- "memberOf": "Roo.dd.DragSource"
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "dropNotAllowed",
+ "name": "style",
"type": "String",
- "desc": "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
- "memberOf": "Roo.dd.DragSource"
+ "desc": "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "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",
"memberOf": "Roo.util.Observable"
}
],
- "events": [],
- "methods": [
+ "events": [
{
- "name": "addEvents",
- "sig": "(Object object)",
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Used to define events on this Observable"
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
},
{
- "name": "addInvalidHandleClass",
- "sig": "(string cssClass)",
+ "name": "beforehide",
+ "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 before the component is hidden. Return false to stop the hide."
},
{
- "name": "addInvalidHandleId",
- "sig": "(string id)",
+ "name": "beforerender",
+ "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 before the component is rendered. Return false to stop the render."
},
{
- "name": "addInvalidHandleType",
- "sig": "(string tagName)",
+ "name": "beforeshow",
+ "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 before the component is shown. Return false to stop the show."
},
{
- "name": "addListener",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "name": "childrenrendered",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Appends an event handler to this component"
+ "desc": "Fires when the children have been rendered.."
},
{
- "name": "addToGroup",
- "sig": "( sGroup)",
+ "name": "destroy",
+ "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 destroyed."
},
{
- "name": "afterRepair",
- "sig": "()",
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Called after a repair of an invalid drop. By default, highlights this.dragData.ddel"
+ "desc": "Fires after the component is disabled."
},
{
- "name": "alignElWithMouse",
- "sig": "(HTMLElement el, int iPageX, int iPageY)",
+ "name": "enable",
+ "sig": "function (_self)\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": "Fires after the component is enabled."
},
{
- "name": "applyConfig",
- "sig": "()",
+ "name": "hide",
+ "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 hidden."
},
{
- "name": "autoOffset",
- "sig": "(int iPageX, int iPageY)",
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
"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": "Fires after the component is rendered."
},
{
- "name": "beforeDragDrop",
- "sig": "(Roo.dd.DragDrop target, Event e, String id)",
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
"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": "Fires after the component is shown."
+ }
+ ],
+ "methods": [
+ {
+ "name": "addEvents",
+ "sig": "(Object object)",
+ "type": "function",
+ "desc": "Used to define events on this Observable"
},
{
- "name": "beforeDragEnter",
- "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\nbefore the dragged item enters the drop target and optionally cancel the onDragEnter."
+ "desc": "Appends an event handler to this component"
},
{
- "name": "beforeDragOut",
- "sig": "(Roo.dd.DragDrop target, Event e, String id)",
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
"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": "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": "beforeDragOver",
- "sig": "(Roo.dd.DragDrop target, Event e, String id)",
+ "name": "destroy",
+ "sig": "()",
"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": "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": "beforeInvalidDrop",
- "sig": "(Roo.dd.DragDrop target, Event e, String id)",
+ "name": "disable",
+ "sig": "()",
"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": "Disable this component."
},
{
- "name": "cachePosition",
- "sig": "( iPageX, iPageY)",
+ "name": "enable",
+ "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": "Enable this component."
},
{
- "name": "capture",
- "sig": "(Observable o, Function fn, Object scope)",
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
"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."
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "clearConstraints",
+ "name": "focus",
+ "sig": "(Boolean selectText)",
+ "type": "function",
+ "desc": "Try to focus this component."
+ },
+ {
+ "name": "getChildContainer",
"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": "Fetch the element to add children to"
},
{
- "name": "clearTicks",
+ "name": "getEl",
"sig": "()",
"type": "function",
- "desc": "Clears any tick interval defined for this instance"
+ "desc": "Returns the underlying {@link Roo.Element}."
},
{
- "name": "createFrame",
+ "name": "getId",
"sig": "()",
"type": "function",
- "desc": "Creates the proxy element if it does not yet exist"
+ "desc": "Returns the id of this component."
},
{
- "name": "endDrag",
- "sig": "(Event e)",
+ "name": "getVisibilityEl",
+ "sig": "()",
"type": "function",
- "desc": "Fired when we are done dragging the object"
+ "desc": "Get the element that will be used to show or hide"
},
{
- "name": "fireEvent",
- "sig": "(String eventName, Object... args)",
+ "name": "hasListener",
+ "sig": "(String eventName)",
"type": "function",
- "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "function toString() {\n [native code]\n}",
+ "name": "hide",
"sig": "()",
"type": "function",
- "desc": "toString method"
+ "desc": "Hide a component - adds 'hidden' class"
},
{
- "name": "getDragData",
- "sig": "(EventObject e)",
+ "name": "initEvents",
+ "sig": "()",
"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."
+ "desc": "Initialize Events for the element"
},
{
- "name": "getDragEl",
+ "name": "isVisible",
"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": "Returns true if this component is visible."
},
{
- "name": "getEl",
- "sig": "()",
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "Returns a reference to the linked element"
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
},
{
- "name": "getProxy",
+ "name": "purgeListeners",
"sig": "()",
"type": "function",
- "desc": "Returns the drag source's underlying {@link Roo.dd.StatusProxy}"
+ "desc": "Removes all listeners for this object"
},
{
- "name": "getRepairXY",
- "sig": "(EventObject e)",
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
"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"
+ "desc": "Removes <b>all</b> added captures from the Observable."
},
{
- "name": "hasListener",
- "sig": "(String eventName)",
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
"type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
+ "desc": "Removes a listener"
},
{
- "name": "hideProxy",
- "sig": "()",
+ "name": "render",
+ "sig": "(String/HTMLElement/Element container)",
"type": "function",
- "desc": "Hides the drag source's {@link Roo.dd.StatusProxy}"
+ "desc": "If this is a lazy rendering component, render it to its container element."
},
{
- "name": "init",
- "sig": "( id, String sGroup, object config)",
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
"type": "function",
- "desc": "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass"
+ "desc": "Convenience function for setting disabled/enabled by boolean."
},
{
- "name": "initFrame",
- "sig": "()",
+ "name": "setVisible",
+ "sig": "(Boolean visible)",
"type": "function",
- "desc": "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses"
+ "desc": "Convenience function to hide or show this component by boolean."
},
{
- "name": "initTarget",
- "sig": "( id, String sGroup, object config)",
+ "name": "show",
+ "sig": "()",
"type": "function",
- "desc": "Initializes Targeting functionality only... the object does not\nget a mousedown handler."
+ "desc": "Show a component - removes 'hidden' class"
},
{
- "name": "isLocked",
+ "name": "tooltipEl",
"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": "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": "html",
+ "type": "String",
+ "desc": "",
+ "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "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": "isTarget",
- "sig": "()",
- "type": "function",
- "desc": "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false."
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
},
{
- "name": "isValidHandleChild",
- "sig": "(HTMLElement node)",
+ "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": "Checks the tag exclusion list to see if this click should be ignored"
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
},
{
- "name": "lock",
- "sig": "()",
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Lock this instance"
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
},
{
- "name": "on",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Appends an event handler to this element (shorthand for addListener)"
+ "desc": "Fires before the component is rendered. Return false to stop the render."
},
{
- "name": "onAvailable",
- "sig": "()",
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Override the onAvailable method to do what is needed after the initial\nposition was determined."
+ "desc": "Fires before the component is shown. Return false to stop the show."
},
{
- "name": "onBeforeDrag",
- "sig": "(Object data, Event e)",
+ "name": "childrenrendered",
+ "sig": "function (_self)\n{\n\n}",
"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."
+ "desc": "Fires when the children have been rendered.."
},
{
- "name": "onDrag",
- "sig": "(Event e)",
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Abstract method called during the onMouseMove event while dragging an\nobject."
+ "desc": "Fires after the component is destroyed."
},
{
- "name": "onDragDrop",
- "sig": "(Event e, String|DragDrop[] id)",
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Abstract method called when this item is dropped on another DragDrop\nobj"
+ "desc": "Fires after the component is disabled."
},
{
- "name": "onDragEnter",
- "sig": "(Event e, String|DragDrop[] id)",
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Abstract method called when this element fist begins hovering over\nanother DragDrop obj"
+ "desc": "Fires after the component is enabled."
},
{
- "name": "onDragOut",
- "sig": "(Event e, String|DragDrop[] id)",
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Abstract method called when we are no longer hovering over an element"
+ "desc": "Fires after the component is hidden."
},
{
- "name": "onDragOver",
- "sig": "(Event e, String|DragDrop[] id)",
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Abstract method called when this element is hovering over another\nDragDrop obj"
+ "desc": "Fires after the component is rendered."
},
{
- "name": "onInitDrag",
- "sig": "(Number x, Number y)",
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Called once drag threshold has been reached to initialize the proxy element. By default, it clones the\nthis.dragData.ddel"
- },
+ "desc": "Fires after the component is shown."
+ }
+ ],
+ "methods": [
{
- "name": "onInvalidDrop",
- "sig": "(Event e)",
+ "name": "addEvents",
+ "sig": "(Object object)",
"type": "function",
- "desc": "Abstract method called when this item is dropped on an area with no\ndrop target"
+ "desc": "Used to define events on this Observable"
},
{
- "name": "onMouseDown",
- "sig": "(Event e)",
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "Event handler that fires when a drag/drop obj gets a mousedown"
+ "desc": "Appends an event handler to this component"
},
{
- "name": "onMouseUp",
- "sig": "(Event e)",
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
"type": "function",
- "desc": "Event handler that fires when a drag/drop obj gets a mouseup"
+ "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": "onStartDrag",
- "sig": "(Number x, Number y)",
+ "name": "destroy",
+ "sig": "()",
"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."
+ "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": "padding",
+ "name": "disable",
"sig": "()",
"type": "function",
- "desc": "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object."
+ "desc": "Disable this component."
},
{
- "name": "purgeListeners",
+ "name": "enable",
"sig": "()",
"type": "function",
- "desc": "Removes all listeners for this object"
+ "desc": "Enable this component."
},
{
- "name": "releaseCapture",
- "sig": "(Observable o)",
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
"type": "function",
- "desc": "Removes <b>all</b> added captures from the Observable."
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "removeFromGroup",
- "sig": "(string sGroup)",
+ "name": "focus",
+ "sig": "(Boolean selectText)",
"type": "function",
- "desc": "Remove's this instance from the supplied interaction group"
+ "desc": "Try to focus this component."
},
{
- "name": "removeInvalidHandleClass",
- "sig": "(string cssClass)",
+ "name": "getChildContainer",
+ "sig": "()",
"type": "function",
- "desc": "Unsets an invalid css class"
+ "desc": "Fetch the element to add children to"
},
{
- "name": "removeInvalidHandleId",
- "sig": "(string id)",
+ "name": "getEl",
+ "sig": "()",
"type": "function",
- "desc": "Unsets an invalid handle id"
+ "desc": "Returns the underlying {@link Roo.Element}."
},
{
- "name": "removeInvalidHandleType",
- "sig": "(string tagName)",
+ "name": "getId",
+ "sig": "()",
"type": "function",
- "desc": "Unsets an excluded tag name set by addInvalidHandleType"
+ "desc": "Returns the id of this component."
},
{
- "name": "removeListener",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "getVisibilityEl",
+ "sig": "()",
"type": "function",
- "desc": "Removes a listener"
+ "desc": "Get the element that will be used to show or hide"
},
{
- "name": "resetConstraints",
- "sig": "(boolean maintainOffset)",
+ "name": "hasListener",
+ "sig": "(String eventName)",
"type": "function",
- "desc": "resetConstraints must be called if you manually reposition a dd element."
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "setDelta",
- "sig": "(int iDeltaX, int iDeltaY)",
+ "name": "hide",
+ "sig": "()",
"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)"
+ "desc": "Hide a component - adds 'hidden' class"
},
{
- "name": "setDragElId",
- "sig": "( id)",
+ "name": "initEvents",
+ "sig": "()",
"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": "Initialize Events for the element"
},
{
- "name": "setDragElPos",
- "sig": "(int iPageX, int iPageY)",
+ "name": "isVisible",
+ "sig": "()",
"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."
+ "desc": "Returns true if this component is visible."
},
{
- "name": "setHandleElId",
- "sig": "( id)",
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"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": "Appends an event handler to this element (shorthand for addListener)"
},
{
- "name": "setInitPosition",
- "sig": "(int diffX, int diffY)",
+ "name": "purgeListeners",
+ "sig": "()",
"type": "function",
- "desc": "Stores the initial placement of the linked element."
+ "desc": "Removes all listeners for this object"
},
{
- "name": "setOuterHandleElId",
- "sig": "( id)",
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
"type": "function",
- "desc": "Allows you to set an element outside of the linked element as a drag\nhandle"
+ "desc": "Removes <b>all</b> added captures from the Observable."
},
{
- "name": "setPadding",
- "sig": "(int iTop, int iRight, int iBot, int iLeft)",
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
"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": "Removes a listener"
},
{
- "name": "setXConstraint",
- "sig": "(int iLeft, int iRight, int iTickSize)",
+ "name": "render",
+ "sig": "(String/HTMLElement/Element container)",
"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": "If this is a lazy rendering component, render it to its container element."
},
{
- "name": "setYConstraint",
- "sig": "(int iUp, int iDown, int iTickSize)",
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
"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": "Convenience function for setting disabled/enabled by boolean."
},
{
- "name": "startDrag",
- "sig": "(int X, int Y)",
+ "name": "setVisible",
+ "sig": "(Boolean visible)",
"type": "function",
- "desc": "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met."
+ "desc": "Convenience function to hide or show this component by boolean."
},
{
- "name": "un",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "show",
+ "sig": "()",
"type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
+ "desc": "Show a component - removes 'hidden' class"
},
{
- "name": "unlock",
+ "name": "tooltipEl",
"sig": "()",
"type": "function",
- "desc": "Unlock this instace"
+ "desc": "Fetch the element to display the tooltip on."
},
{
- "name": "unreg",
- "sig": "()",
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
"type": "function",
- "desc": "Remove all drag and drop hooks for this element"
+ "desc": "Removes a listener (shorthand for removeListener)"
}
]
},
- "Roo.dd.DropTarget": {
+ "Roo.doc.Param": {
"props": [
{
- "name": "overClass",
- "type": "String",
- "desc": "The CSS class applied to the drop target element while the drag source is over it (defaults to \"\").",
+ "name": "is_optional",
+ "type": "bool",
+ "desc": "is the argument optional",
"memberOf": ""
},
{
- "name": "ddGroup",
+ "name": "type",
"type": "String",
- "desc": "The drag drop group to handle drop events for",
+ "desc": "argument type",
"memberOf": ""
},
{
- "name": "dropAllowed",
+ "name": "name",
"type": "String",
- "desc": "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
+ "desc": "name of the parameter",
"memberOf": ""
},
{
- "name": "dropNotAllowed",
+ "name": "desc",
"type": "String",
- "desc": "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
+ "desc": "short description",
"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..",
+ "name": "defaultvalue",
+ "type": "String",
+ "desc": "default value",
"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": "drop",
- "sig": "function (source, e, data)\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"
+ "name": "cls",
+ "type": "String",
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "enter",
- "sig": "function (source, e, data)\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"
+ "name": "style",
+ "type": "String",
+ "desc": "any extra css",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "out",
- "sig": "function (source, e, data)\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."
+ "name": "xattr",
+ "type": "Object",
+ "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "over",
- "sig": "function (source, e, data)\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": [
- {
- "name": "addEvents",
- "sig": "(Object object)",
- "type": "function",
- "desc": "Used to define events on this Observable"
+ "name": "can_build_overlaid",
+ "type": "Boolean",
+ "desc": "True if element can be rebuild from a HTML page",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "addInvalidHandleClass",
- "sig": "(string cssClass)",
- "type": "function",
- "desc": "Lets you specify a css class of elements that will not initiate a drag"
+ "name": "dataId",
+ "type": "string",
+ "desc": "cutomer id",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "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": "tooltip",
+ "type": "string",
+ "desc": "Text for the tooltip",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "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": "container_method",
+ "type": "string",
+ "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "addListener",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
- "type": "function",
- "desc": "Appends an event handler to this component"
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
},
{
- "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": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
},
{
- "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": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.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": "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": "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": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
},
{
- "name": "clearTicks",
- "sig": "()",
- "type": "function",
- "desc": "Clears any tick interval defined for this instance"
- },
+ "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": "endDrag",
- "sig": "(Event e)",
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fired when we are done dragging the object"
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
},
{
- "name": "fireEvent",
- "sig": "(String eventName, Object... args)",
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
},
{
- "name": "function toString() {\n [native code]\n}",
- "sig": "()",
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "toString method"
+ "desc": "Fires before the component is rendered. Return false to stop the render."
},
{
- "name": "getDragEl",
- "sig": "()",
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
"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": "Fires before the component is shown. Return false to stop the show."
},
{
- "name": "getEl",
- "sig": "()",
+ "name": "childrenrendered",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Returns a reference to the linked element"
+ "desc": "Fires when the children have been rendered.."
},
{
- "name": "hasListener",
- "sig": "(String eventName)",
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
+ "desc": "Fires after the component is destroyed."
},
{
- "name": "init",
- "sig": "( id, String sGroup, object config)",
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass"
+ "desc": "Fires after the component is disabled."
},
{
- "name": "initTarget",
- "sig": "( id, String sGroup, object config)",
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Initializes Targeting functionality only... the object does not\nget a mousedown handler."
+ "desc": "Fires after the component is enabled."
},
{
- "name": "isLocked",
- "sig": "()",
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
"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": "Fires after the component is hidden."
},
{
- "name": "isTarget",
- "sig": "()",
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false."
+ "desc": "Fires after the component is rendered."
},
{
- "name": "isValidHandleChild",
- "sig": "(HTMLElement node)",
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Checks the tag exclusion list to see if this click should be ignored"
- },
+ "desc": "Fires after the component is shown."
+ }
+ ],
+ "methods": [
{
- "name": "lock",
- "sig": "()",
+ "name": "addEvents",
+ "sig": "(Object object)",
"type": "function",
- "desc": "Lock this instance"
+ "desc": "Used to define events on this Observable"
},
{
- "name": "on",
+ "name": "addListener",
"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"
+ "desc": "Appends an event handler to this component"
},
{
- "name": "onInvalidDrop",
- "sig": "(Event e)",
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
"type": "function",
- "desc": "Abstract method called when this item is dropped on an area with no\ndrop target"
+ "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": "onMouseDown",
- "sig": "(Event e)",
+ "name": "destroy",
+ "sig": "()",
"type": "function",
- "desc": "Event handler that fires when a drag/drop obj gets a mousedown"
+ "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": "onMouseUp",
- "sig": "(Event e)",
+ "name": "disable",
+ "sig": "()",
"type": "function",
- "desc": "Event handler that fires when a drag/drop obj gets a mouseup"
+ "desc": "Disable this component."
},
{
- "name": "padding",
+ "name": "enable",
"sig": "()",
"type": "function",
- "desc": "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object."
+ "desc": "Enable this component."
},
{
- "name": "purgeListeners",
- "sig": "()",
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
"type": "function",
- "desc": "Removes all listeners for this object"
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "releaseCapture",
- "sig": "(Observable o)",
+ "name": "focus",
+ "sig": "(Boolean selectText)",
"type": "function",
- "desc": "Removes <b>all</b> added captures from the Observable."
+ "desc": "Try to focus this component."
},
{
- "name": "removeFromGroup",
- "sig": "(string sGroup)",
+ "name": "getChildContainer",
+ "sig": "()",
"type": "function",
- "desc": "Remove's this instance from the supplied interaction group"
+ "desc": "Fetch the element to add children to"
},
{
- "name": "removeInvalidHandleClass",
- "sig": "(string cssClass)",
+ "name": "getEl",
+ "sig": "()",
"type": "function",
- "desc": "Unsets an invalid css class"
+ "desc": "Returns the underlying {@link Roo.Element}."
},
{
- "name": "removeInvalidHandleId",
- "sig": "(string id)",
+ "name": "getId",
+ "sig": "()",
"type": "function",
- "desc": "Unsets an invalid handle id"
+ "desc": "Returns the id of this component."
},
{
- "name": "removeInvalidHandleType",
- "sig": "(string tagName)",
+ "name": "getVisibilityEl",
+ "sig": "()",
"type": "function",
- "desc": "Unsets an excluded tag name set by addInvalidHandleType"
+ "desc": "Get the element that will be used to show or hide"
},
{
- "name": "removeListener",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "hasListener",
+ "sig": "(String eventName)",
"type": "function",
- "desc": "Removes a listener"
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "resetConstraints",
- "sig": "(boolean maintainOffset)",
+ "name": "hide",
+ "sig": "()",
"type": "function",
- "desc": "resetConstraints must be called if you manually reposition a dd element."
+ "desc": "Hide a component - adds 'hidden' class"
},
{
- "name": "setDragElId",
- "sig": "( id)",
+ "name": "initEvents",
+ "sig": "()",
"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": "Initialize Events for the element"
},
{
- "name": "setHandleElId",
- "sig": "( id)",
+ "name": "isVisible",
+ "sig": "()",
"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": "Returns true if this component is visible."
},
{
- "name": "setInitPosition",
- "sig": "(int diffX, int diffY)",
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "Stores the initial placement of the linked element."
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
},
{
- "name": "setOuterHandleElId",
- "sig": "( id)",
+ "name": "purgeListeners",
+ "sig": "()",
"type": "function",
- "desc": "Allows you to set an element outside of the linked element as a drag\nhandle"
+ "desc": "Removes all listeners for this object"
},
{
- "name": "setPadding",
- "sig": "(int iTop, int iRight, int iBot, int iLeft)",
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
"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": "Removes <b>all</b> added captures from the Observable."
},
{
- "name": "setXConstraint",
- "sig": "(int iLeft, int iRight, int iTickSize)",
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
"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": "Removes a listener"
},
{
- "name": "setYConstraint",
- "sig": "(int iUp, int iDown, int iTickSize)",
+ "name": "render",
+ "sig": "(String/HTMLElement/Element container)",
"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": "If this is a lazy rendering component, render it to its container element."
},
{
- "name": "startDrag",
- "sig": "(int X, int Y)",
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
"type": "function",
- "desc": "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met."
+ "desc": "Convenience function for setting disabled/enabled by boolean."
},
{
- "name": "un",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "setVisible",
+ "sig": "(Boolean visible)",
"type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
+ "desc": "Convenience function to hide or show this component by boolean."
},
{
- "name": "unlock",
+ "name": "show",
"sig": "()",
"type": "function",
- "desc": "Unlock this instace"
+ "desc": "Show a component - removes 'hidden' class"
},
{
- "name": "unreg",
+ "name": "tooltipEl",
"sig": "()",
"type": "function",
- "desc": "Remove all drag and drop hooks for this element"
+ "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.dd.DropZone": {
+ "Roo.doc.Section": {
"props": [
{
- "name": "overClass",
+ "name": "stype",
"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": "section type.",
+ "memberOf": "",
+ "optvals": [
+ "desc",
+ "parameter",
+ "return",
+ "note",
+ "example"
+ ]
},
{
- "name": "ddGroup",
+ "name": "cls",
"type": "String",
- "desc": "The drag drop group to handle drop events for",
- "memberOf": "Roo.dd.DropTarget"
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "dropAllowed",
+ "name": "style",
"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": "any extra css",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "dropNotAllowed",
+ "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "name": "disableClass",
"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": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
},
{
- "name": "success",
- "type": "boolean",
- "desc": "set this after drop listener..",
- "memberOf": "Roo.dd.DropTarget"
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.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": "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",
- "sig": "(String eventName)",
+ "name": "getVisibilityEl",
+ "sig": "()",
"type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
+ "desc": "Get the element that will be used to show or hide"
},
{
- "name": "init",
- "sig": "( id, String sGroup, object config)",
+ "name": "hasListener",
+ "sig": "(String eventName)",
"type": "function",
- "desc": "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass"
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "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."
+ "desc": "Show a component - removes 'hidden' class"
},
{
- "name": "onContainerDrop",
- "sig": "(Roo.dd.DragSource source, Event e, Object data)",
+ "name": "tooltipEl",
+ "sig": "()",
"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": "Fetch the element to display the tooltip on."
},
{
- "name": "onContainerOver",
- "sig": "(Roo.dd.DragSource source, Event e, Object data)",
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
"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": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.doc.Synopsis": {
+ "props": [
+ {
+ "name": "returntype",
+ "type": "String",
+ "desc": "return value",
+ "memberOf": ""
},
{
- "name": "onDrag",
- "sig": "(Event e)",
- "type": "function",
- "desc": "Abstract method called during the onMouseMove event while dragging an\nobject."
+ "name": "returndesc",
+ "type": "String",
+ "desc": "description of return value. (used in the return section if set..)",
+ "memberOf": ""
},
{
- "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": "String",
+ "desc": "title really..",
+ "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": "stype",
+ "type": "String",
+ "desc": "",
+ "memberOf": "",
+ "optvals": [
+ "function",
+ "constant"
+ ]
},
{
- "name": "onDragOut",
- "sig": "(Event e, String|DragDrop[] id)",
- "type": "function",
- "desc": "Abstract method called when we are no longer hovering over an element"
+ "name": "memberof",
+ "type": "String",
+ "desc": "class name",
+ "memberOf": ""
},
{
- "name": "onDragOver",
- "sig": "(Event e, String|DragDrop[] id)",
- "type": "function",
- "desc": "Abstract method called when this element is hovering over another\nDragDrop obj"
+ "name": "is_static",
+ "type": "bool",
+ "desc": "is a static member",
+ "memberOf": ""
},
{
- "name": "onInvalidDrop",
- "sig": "(Event e)",
- "type": "function",
- "desc": "Abstract method called when this item is dropped on an area with no\ndrop target"
+ "name": "is_constructor",
+ "type": "bool",
+ "desc": "is a static member",
+ "memberOf": ""
},
{
- "name": "onMouseDown",
- "sig": "(Event e)",
- "type": "function",
- "desc": "Event handler that fires when a drag/drop obj gets a mousedown"
+ "name": "cls",
+ "type": "String",
+ "desc": "css class",
+ "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": "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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "name": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.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": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.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": "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": "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": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
},
{
- "name": "onNodeOver",
- "sig": "(Object nodeData, Roo.dd.DragSource source, Event e, Object data)",
+ "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": "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."
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
},
{
- "name": "padding",
- "sig": "()",
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object."
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
},
{
- "name": "purgeListeners",
- "sig": "()",
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Removes all listeners for this object"
+ "desc": "Fires before the component is rendered. Return false to stop the render."
},
{
- "name": "releaseCapture",
- "sig": "(Observable o)",
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Removes <b>all</b> added captures from the Observable."
+ "desc": "Fires before the component is shown. Return false to stop the show."
},
{
- "name": "removeFromGroup",
- "sig": "(string sGroup)",
+ "name": "childrenrendered",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Remove's this instance from the supplied interaction group"
+ "desc": "Fires when the children have been rendered.."
},
{
- "name": "removeInvalidHandleClass",
- "sig": "(string cssClass)",
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Unsets an invalid css class"
+ "desc": "Fires after the component is destroyed."
},
{
- "name": "removeInvalidHandleId",
- "sig": "(string id)",
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Unsets an invalid handle id"
+ "desc": "Fires after the component is disabled."
},
{
- "name": "removeInvalidHandleType",
- "sig": "(string tagName)",
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Unsets an excluded tag name set by addInvalidHandleType"
+ "desc": "Fires after the component is enabled."
},
{
- "name": "removeListener",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Removes a listener"
+ "desc": "Fires after the component is hidden."
},
{
- "name": "resetConstraints",
- "sig": "(boolean maintainOffset)",
+ "name": "render",
+ "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 rendered."
},
{
- "name": "setDragElId",
- "sig": "( id)",
+ "name": "show",
+ "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 shown."
+ }
+ ],
+ "methods": [
{
- "name": "setHandleElId",
- "sig": "( id)",
+ "name": "addEvents",
+ "sig": "(Object object)",
"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": "Used to define events on this Observable"
},
{
- "name": "setInitPosition",
- "sig": "(int diffX, int diffY)",
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "Stores the initial placement of the linked element."
+ "desc": "Appends an event handler to this component"
},
{
- "name": "setOuterHandleElId",
- "sig": "( id)",
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
"type": "function",
- "desc": "Allows you to set an element outside of the linked element as a drag\nhandle"
+ "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": "setPadding",
- "sig": "(int iTop, int iRight, int iBot, int iLeft)",
+ "name": "destroy",
+ "sig": "()",
"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": "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": "setXConstraint",
- "sig": "(int iLeft, int iRight, int iTickSize)",
+ "name": "disable",
+ "sig": "()",
"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": "Disable this component."
},
{
- "name": "setYConstraint",
- "sig": "(int iUp, int iDown, int iTickSize)",
+ "name": "enable",
+ "sig": "()",
"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": "Enable this component."
},
{
- "name": "startDrag",
- "sig": "(int X, int Y)",
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
"type": "function",
- "desc": "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met."
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "un",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "focus",
+ "sig": "(Boolean selectText)",
"type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
+ "desc": "Try to focus this component."
},
{
- "name": "unlock",
+ "name": "getChildContainer",
"sig": "()",
"type": "function",
- "desc": "Unlock this instace"
+ "desc": "Fetch the element to add children to"
},
{
- "name": "unreg",
+ "name": "getEl",
"sig": "()",
"type": "function",
- "desc": "Remove all drag and drop hooks for this element"
- }
- ]
- },
- "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"
+ "desc": "Returns the underlying {@link Roo.Element}."
},
{
- "name": "getHandleFromEvent",
- "sig": "(Event e)",
+ "name": "getId",
+ "sig": "()",
"type": "function",
- "desc": "Returns the handle that is registered for the DOM node that is the target of the event"
+ "desc": "Returns the id of this component."
},
{
- "name": "getTarget",
- "sig": "(String|HTMLElement id)",
+ "name": "getVisibilityEl",
+ "sig": "()",
"type": "function",
- "desc": "Returns a custom data object that is registered for a DOM node by id"
+ "desc": "Get the element that will be used to show or hide"
},
{
- "name": "getTargetFromEvent",
- "sig": "(Event e)",
+ "name": "hasListener",
+ "sig": "(String eventName)",
"type": "function",
- "desc": "Returns a custom data object that is registered for the DOM node that is the target of the event"
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "register",
- "sig": "(String|HTMLElement element, Object data)",
+ "name": "hide",
+ "sig": "()",
"type": "function",
- "desc": "Register a drag drop element"
+ "desc": "Hide a component - adds 'hidden' class"
},
{
- "name": "unregister",
- "sig": "(String|HTMLElement element)",
- "type": "function",
- "desc": "Unregister a drag drop element"
- }
- ]
- },
- "Roo.dd.ScrollManager": {
- "props": [],
- "events": [],
- "methods": [
- {
- "name": "refreshCache",
+ "name": "initEvents",
"sig": "()",
"type": "function",
- "desc": "Manually trigger a cache refresh."
+ "desc": "Initialize Events for the element"
},
{
- "name": "register",
- "sig": "(String/HTMLElement/Element/Array el)",
+ "name": "isVisible",
+ "sig": "()",
"type": "function",
- "desc": "Registers new overflow element(s) to auto scroll"
+ "desc": "Returns true if this component is visible."
},
{
- "name": "unregister",
- "sig": "(String/HTMLElement/Element/Array el)",
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"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": "Appends an event handler to this element (shorthand for addListener)"
},
{
- "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",
+ "name": "purgeListeners",
"sig": "()",
"type": "function",
- "desc": "Returns the underlying proxy {@link Roo.Layer}"
+ "desc": "Removes all listeners for this object"
},
{
- "name": "getGhost",
- "sig": "()",
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
"type": "function",
- "desc": "Returns the ghost element"
+ "desc": "Removes <b>all</b> added captures from the Observable."
},
{
- "name": "hide",
- "sig": "(Boolean clear)",
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
"type": "function",
- "desc": "Hides the proxy"
+ "desc": "Removes a listener"
},
{
- "name": "repair",
- "sig": "(Array xy, Function callback, Object scope)",
+ "name": "render",
+ "sig": "(String/HTMLElement/Element container)",
"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": "If this is a lazy rendering component, render it to its container element."
},
{
- "name": "reset",
- "sig": "(Boolean clearGhost)",
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
"type": "function",
- "desc": "Resets the status indicator to the default dropNotAllowed value"
+ "desc": "Convenience function for setting disabled/enabled by boolean."
},
{
- "name": "setStatus",
- "sig": "(String cssClass)",
+ "name": "setVisible",
+ "sig": "(Boolean visible)",
"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 to hide or show this component by boolean."
},
{
"name": "show",
"sig": "()",
"type": "function",
- "desc": "Displays this proxy"
- },
- {
- "name": "stop",
- "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)"
}
]
},
"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": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if any fields in this form have changed since their original load. (New version)"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if any fields in this form have changed since their original load."
+ "desc": "DEPRICATED Returns true if any fields in this form have changed since their original load."
},
{
"name": "isValid",
"type": "function",
"desc": "Resets this form."
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "Resets all hasChanged to 'false' -\nThe old 'isDirty' used 'original value..' however this breaks reset() and a few other things.\nSo hasChanged storage is only to be used for this purpose"
+ },
{
"name": "setValues",
"sig": "(Array/Object values)",
"type": "function",
"desc": "Returns the checked state of the checkbox."
},
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isValid",
"type": "function",
"desc": "Resets the current field value to the originally loaded value and clears any validation messages"
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
"type": "function",
"desc": "Returns the currently selected field value or empty string if no value is set."
},
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isExpanded",
"type": "function",
"desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
{
"name": "select",
"sig": "(Number index, Boolean scrollIntoView)",
"type": "function",
"desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
},
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isValid",
"type": "function",
"desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
{
"name": "selectText",
"sig": "(Number start, Number end)",
"type": "function",
"desc": "Returns the currently selected field value or empty string if no value is set."
},
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isExpanded",
"type": "function",
"desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
{
"name": "select",
"sig": "(Number index, Boolean scrollIntoView)",
"type": "function",
"desc": "Returns the current date value of the date field."
},
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isValid",
"type": "function",
"desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
{
"name": "selectText",
"sig": "(Number start, Number end)",
"type": "function",
"desc": "Returns the checked state of the checkbox."
},
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isValid",
"type": "function",
"desc": "Resets the current field value to the originally loaded value and clears any validation messages"
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
},
"Roo.form.DisplayField": {
"props": [
+ {
+ "name": "closable",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
{
"name": "focusClass",
"type": "String",
"type": "function",
"desc": "Fires just before the field blurs if the field value has changed."
},
+ {
+ "name": "close",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the click the close btn"
+ },
{
"name": "destroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
},
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isValid",
"type": "function",
"desc": "Resets the current field value to the originally loaded value and clears any validation messages"
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
"type": "function",
"desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
},
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isValid",
"type": "function",
"desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
{
"name": "selectText",
"sig": "(Number start, Number end)",
"type": "function",
"desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
},
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isValid",
"type": "function",
"desc": "Resets the current field value to the originally loaded value and clears any validation messages"
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
"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": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if any fields in this form have changed since their original load. (New version)"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if any fields in this form have changed since their original load."
+ "desc": "DEPRICATED Returns true if any fields in this form have changed since their original load."
},
{
"name": "isValid",
"type": "function",
"desc": "Resets this form."
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "Resets all hasChanged to 'false' -\nThe old 'isDirty' used 'original value..' however this breaks reset() and a few other things.\nSo hasChanged storage is only to be used for this purpose"
+ },
{
"name": "setValues",
"sig": "(Array/Object values)",
"type": "function",
"desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
},
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isValid",
"type": "function",
"desc": "Resets the current field value to the originally loaded value and clears any validation messages"
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
"type": "function",
"desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
},
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isValid",
"type": "function",
"desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
{
"name": "selectText",
"sig": "(Number start, Number end)",
"type": "function",
"desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
},
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isValid",
"type": "function",
"desc": "Resets the current field value to the originally loaded value and clears any validation messages"
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
"type": "function",
"desc": "Returns the current date value of the date field."
},
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isValid",
"type": "function",
"desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
{
"name": "selectText",
"sig": "(Number start, Number end)",
"type": "function",
"desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
},
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isValid",
"type": "function",
"desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
{
"name": "selectText",
"sig": "(Number start, Number end)",
"type": "function",
"desc": "Returns the checked state of the checkbox."
},
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isValid",
"type": "function",
"desc": "Resets the current field value to the originally loaded value and clears any validation messages"
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
"type": "function",
"desc": "Returns the currently selected field value or empty string if no value is set."
},
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isExpanded",
"type": "function",
"desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
{
"name": "select",
"sig": "(Number index, Boolean scrollIntoView)",
"type": "function",
"desc": ""
},
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isValid",
"type": "function",
"desc": "Resets the current field value to the originally loaded value and clears any validation messages"
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
"type": "function",
"desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
},
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isValid",
"type": "function",
"desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
{
"name": "selectText",
"sig": "(Number start, Number end)",
"type": "function",
"desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
},
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isValid",
"type": "function",
"desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
{
"name": "selectText",
"sig": "(Number start, Number end)",
"type": "function",
"desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
},
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isValid",
"type": "function",
"desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
{
"name": "selectText",
"sig": "(Number start, Number end)",
{
"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": ""
},
{
"desc": "(Optional)",
"memberOf": ""
},
+ {
+ "name": "xs",
+ "type": "Number",
+ "desc": "(Optional)",
+ "memberOf": ""
+ },
+ {
+ "name": "sm",
+ "type": "Number",
+ "desc": "(Optional)",
+ "memberOf": ""
+ },
+ {
+ "name": "md",
+ "type": "Number",
+ "desc": "(Optional)",
+ "memberOf": ""
+ },
+ {
+ "name": "lg",
+ "type": "Number",
+ "desc": "(Optional)",
+ "memberOf": ""
+ },
{
"name": "listeners",
"type": "Object",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
+ {
+ "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.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": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "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": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf": "Roo.bootstrap.Component"
},
+ {
+ "name": "visibilityEl",
+ "type": "string|object",
+ "desc": "What element to use for visibility (@see getVisibilityEl())",
+ "memberOf": "Roo.bootstrap.Component",
+ "optvals": [
+ "el",
+ "parent"
+ ]
+ },
{
"name": "disableClass",
"type": "String",
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getVisibilityEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Get the element that will be used to show or hide"
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
},
{
"name": "number",
- "sig": "(Number/String value, Number decimals)",
+ "sig": "(Number/String value, Number decimals, String delimiter)",
"type": "function",
"desc": "Format a number\neventually this should probably emulate php's number_format"
},
"sig": "(String value, String other)",
"type": "function",
"desc": "Utility function that allows you to easily switch a string between two alternating values. The passed value\nis compared to the current string, and if they are equal, the other value that was passed in is returned. If\nthey are already different, the first value passed in is returned. Note that this method returns the new value\nbut does not change the current string.\n<pre><code>\n// alternate sort directions\nsort = sort.toggle('ASC', 'DESC');\n\n// instead of conditional logic:\nsort = (sort == 'ASC' ? 'DESC' : 'ASC');\n</code></pre>"
- }
- ]
- },
- "_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",
+ "name": "unicodeClean",
"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)"
+ "desc": "Remove invalid unicode characters from a string"
}
]
},
projects / roojs1 / blobdiff