"desc" : "container The id or element that will contain the toolbar",
"memberOf" : ""
},
- {
- "name" : "dataSource",
- "type" : "Roo.data.Store",
- "desc" : "The underlying data store providing the paged data",
- "memberOf" : ""
- },
{
"name" : "displayInfo",
"type" : "Boolean",
"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" : "menu",
+ "type" : "Roo.bootstrap.menu.Menu",
+ "desc" : "a Menu",
+ "memberOf" : ""
+ },
{
"name" : "name",
"type" : "string",
"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" : "menu",
+ "type" : "Roo.bootstrap.menu.Menu",
+ "desc" : "a Menu",
+ "memberOf" : "Roo.bootstrap.Button"
+ },
{
"name" : "multiple",
"type" : "Boolean",
"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" : "menu",
+ "type" : "Roo.bootstrap.menu.Menu",
+ "desc" : "a Menu",
+ "memberOf" : "Roo.bootstrap.Button"
+ },
{
"name" : "name",
"type" : "string",
},
"Roo.bootstrap.CheckBox" : {
"props" : [
- {
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "accept",
"type" : "String",
"desc" : "- input group add on after",
"memberOf" : "Roo.bootstrap.Input"
},
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "align",
"type" : "String",
"desc" : "inline the element (default false)",
"memberOf" : ""
},
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "inputValue",
"type" : "String",
},
"Roo.bootstrap.ComboBox" : {
"props" : [
- {
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "accept",
"type" : "String",
"desc" : "- input group add on after",
"memberOf" : "Roo.bootstrap.Input"
},
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "align",
"type" : "String",
"desc" : "t) default left",
"memberOf" : "Roo.bootstrap.Input"
},
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "invalidClass",
"type" : "String",
},
"Roo.bootstrap.DateField" : {
"props" : [
- {
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "accept",
"type" : "String",
"desc" : "- input group add on after",
"memberOf" : "Roo.bootstrap.Input"
},
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "align",
"type" : "String",
"desc" : "t) default left",
"memberOf" : "Roo.bootstrap.Input"
},
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "invalidClass",
"type" : "String",
},
"Roo.bootstrap.HtmlEditor" : {
"props" : [
- {
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "accept",
"type" : "String",
"desc" : "- input group add on after",
"memberOf" : "Roo.bootstrap.Input"
},
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "align",
"type" : "String",
},
"Roo.bootstrap.Input" : {
"props" : [
- {
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : ""
- },
{
"name" : "accept",
"type" : "String",
"desc" : "- input group add on after",
"memberOf" : ""
},
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : ""
+ },
{
"name" : "align",
"type" : "String",
"desc" : "t) default left",
"memberOf" : ""
},
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : ""
+ },
{
"name" : "invalidClass",
"type" : "String",
},
"Roo.bootstrap.Markdown" : {
"props" : [
- {
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "accept",
"type" : "String",
"desc" : "- input group add on after",
"memberOf" : "Roo.bootstrap.Input"
},
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "align",
"type" : "String",
"desc" : "t) default left",
"memberOf" : "Roo.bootstrap.Input"
},
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "invalidClass",
"type" : "String",
}
]
},
- "Roo.bootstrap.Menu" : {
+ "Roo.bootstrap.MessageBar" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "align",
- "type" : "String",
- "desc" : "default tl-bl? == below - how the menu should be aligned.",
- "memberOf" : ""
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "beforeClass",
+ "type" : "String",
+ "desc" : "insert the bar before the given class",
+ "memberOf" : ""
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "closable",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : ""
+ },
{
"name" : "cls",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "hidden",
- "type" : "bool",
- "desc" : "if the menu should be hidden when rendered.",
+ "name" : "fixed",
+ "type" : "Boolean",
+ "desc" : "e) default false, fix the bar at the top",
"memberOf" : ""
},
{
"memberOf" : "Roo.Component"
},
{
- "name" : "hideTrigger",
- "type" : "bool",
- "desc" : "e) default false - hide the carret for trigger.",
- "memberOf" : ""
- },
- {
- "name" : "isLink",
- "type" : "bool",
- "desc" : "e) the menu has link disable auto expand and collaspe (default false)",
+ "name" : "html",
+ "type" : "String",
+ "desc" : "contents of the MessageBar",
"memberOf" : ""
},
{
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "registerMenu",
- "type" : "Boolean",
- "desc" : "True (default) - means that clicking on screen etc. hides it.",
- "memberOf" : ""
- },
- {
- "name" : "stopEvent",
- "type" : "bool",
- "desc" : "e) Stop event after trigger press (default true)",
- "memberOf" : ""
- },
{
"name" : "style",
"type" : "String",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "type",
- "type" : "String",
- "desc" : "u) type of menu",
- "memberOf" : ""
- },
{
"name" : "visibilityEl",
"type" : "string|object",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "r) default info",
+ "memberOf" : ""
+ },
{
"name" : "xattr",
"type" : "Object",
{
"name" : "beforehide",
"type" : "function",
- "desc" : "Fires before this menu is hidden (return false to block)",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.Menu",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
{
"name" : "beforeshow",
"type" : "function",
- "desc" : "Fires before this menu is displayed (return false to block)",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.Menu",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)",
- "sig" : "function (_self, menuItem, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "menuItem",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was clicked",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
{
"name" : "hide",
"type" : "function",
- "desc" : "Fires after this menu is hidden",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "itemclick",
- "type" : "function",
- "desc" : "Fires when a menu item contained in this menu is clicked",
- "sig" : "function (baseItem, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "baseItem",
- "type" : "Roo.menu.BaseItem",
- "desc" : "The BaseItem that was clicked",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "mouseout",
- "type" : "function",
- "desc" : "Fires when the mouse exits this menu",
- "sig" : "function (_self, e, menuItem)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "menuItem",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was clicked",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "mouseover",
- "type" : "function",
- "desc" : "Fires when the mouse is hovering over this menu",
- "sig" : "function (_self, e, menuItem)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "menuItem",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was clicked",
- "isOptional" : false
}
],
"returns" : []
{
"name" : "show",
"type" : "function",
- "desc" : "Fires after this menu is displayed",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.Menu",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
{
"name" : "hide",
"type" : "function",
- "desc" : "Hides this menu and optionally all parent menus",
- "sig" : "(deep)",
+ "desc" : "Hide a component - adds 'hidden' class",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "deep",
- "type" : "Boolean",
- "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
{
"name" : "show",
"type" : "function",
- "desc" : "Displays this menu relative to another element",
- "sig" : "(element, position, parentMenu)",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
+ }
+ ]
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ]
+ },
+ "Roo.bootstrap.MessageBox" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "alert",
+ "type" : "function",
+ "desc" : "Displays a standard read-only message box with an OK button (comparable to the basic JavaScript Window.alert).\nIf a callback function is passed it will be called after the user clicks the button, and the\nid of the button that was clicked will be passed as the only parameter to the callback\n(could also be the top-right close button).",
+ "sig" : "(title, msg, fn, scope)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "element",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The element to align to",
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title bar text",
"isOptional" : false
},
{
- "name" : "position",
+ "name" : "msg",
"type" : "String",
- "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)",
+ "desc" : "The message box body text",
"isOptional" : false
},
{
- "name" : "parentMenu",
- "type" : "Roo.menu.Menu",
- "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "(optional) The callback function invoked after the message box is closed",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the callback function",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
},
{
- "name" : "showAt",
+ "name" : "confirm",
"type" : "function",
- "desc" : "Displays this menu at a specific xy position",
- "sig" : "(xyPosition, parentMenu)",
+ "desc" : "Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's Window.confirm).\nIf a callback function is passed it will be called after the user clicks either button, and the id of the\nbutton that was clicked will be passed as the only parameter to the callback (could also be the top-right close button).",
+ "sig" : "(title, msg, fn, scope)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "xyPosition",
- "type" : "Array",
- "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)",
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title bar text",
"isOptional" : false
},
{
- "name" : "parentMenu",
- "type" : "Roo.menu.Menu",
- "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The message box body text",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "(optional) The callback function invoked after the message box is closed",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the callback function",
"isOptional" : false
}
],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
+ },
+ {
+ "name" : "getDialog",
+ "type" : "function",
+ "desc" : "Returns a reference to the underlying {@link Roo.BasicDialog} element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.BasicDialog",
+ "desc" : "The BasicDialog element"
+ }
+ ]
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Hides the message box if it is displayed",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "tooltipEl",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
+ "desc" : "Returns true if the message box is currently displayed",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Boolean",
+ "desc" : "True if the message box is visible, else false"
}
]
},
{
- "name" : "un",
+ "name" : "progress",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Displays a message box with a progress bar. This message box has no buttons and is not closeable by\nthe user. You are responsible for updating the progress bar as needed via {@link Roo.MessageBox#updateProgress}\nand closing the message box when the process is complete.",
+ "sig" : "(title, msg)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "title",
"type" : "String",
- "desc" : "The type of event to listen for",
+ "desc" : "The title bar text",
"isOptional" : false
},
{
- "name" : "handler",
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The message box body text",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
+ },
+ {
+ "name" : "prompt",
+ "type" : "function",
+ "desc" : "Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to\nJavaScript's Window.prompt). The prompt can be a single-line or multi-line textbox. If a callback function\nis passed it will be called after the user clicks either button, and the id of the button that was clicked\n(could also be the top-right close button) and the text that was entered will be passed as the two\nparameters to the callback.",
+ "sig" : "(title, msg, fn, scope, multiline)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title bar text",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The message box body text",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
"type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "(optional) The callback function invoked after the message box is closed",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "(optional) The scope of the callback function",
+ "isOptional" : false
+ },
+ {
+ "name" : "multiline",
+ "type" : "Boolean/Number",
+ "desc" : "(optional) True to create a multiline textbox using the defaultTextHeight\nproperty, or the height in pixels to create the textbox (defaults to false / single-line)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Displays a new message box, or reinitializes an existing message box, based on the config options\npassed in. All functions (e.g. prompt, alert, etc) on MessageBox call this function internally.\nThe following config object properties are supported:\n<pre>\nProperty Type Description\n---------- --------------- ------------------------------------------------------------------------------------\nanimEl String/Element An id or Element from which the message box should animate as it opens and\n closes (defaults to undefined)\nbuttons Object/Boolean A button config object (e.g., Roo.MessageBox.OKCANCEL or {ok:'Foo',\n cancel:'Bar'}), or false to not show any buttons (defaults to false)\nclosable Boolean False to hide the top-right close button (defaults to true). Note that\n progress and wait dialogs will ignore this property and always hide the\n close button as they can only be closed programmatically.\ncls String A custom CSS class to apply to the message box element\ndefaultTextHeight Number The default height in pixels of the message box's multiline textarea if\n displayed (defaults to 75)\nfn Function A callback function to execute after closing the dialog. The arguments to the\n function will be btn (the name of the button that was clicked, if applicable,\n e.g. \"ok\"), and text (the value of the active text field, if applicable).\n Progress and wait dialogs will ignore this option since they do not respond to\n user actions and can only be closed programmatically, so any required function\n should be called by the same code after it closes the dialog.\nicon String A CSS class that provides a background image to be used as an icon for\n the dialog (e.g., Roo.MessageBox.WARNING or 'custom-class', defaults to '')\nmaxWidth Number The maximum width in pixels of the message box (defaults to 600)\nminWidth Number The minimum width in pixels of the message box (defaults to 100)\nmodal Boolean False to allow user interaction with the page while the message box is\n displayed (defaults to true)\nmsg String A string that will replace the existing message box body text (defaults\n to the XHTML-compliant non-breaking space character ' ')\nmultiline Boolean True to prompt the user to enter multi-line text (defaults to false)\nprogress Boolean True to display a progress bar (defaults to false)\nprogressText String The text to display inside the progress bar if progress = true (defaults to '')\nprompt Boolean True to prompt the user to enter single-line text (defaults to false)\nproxyDrag Boolean True to display a lightweight proxy while dragging (defaults to false)\ntitle String The title text\nvalue String The string value to set into the active textbox element if displayed\nwait Boolean True to display a progress bar (defaults to false)\nwidth Number The width of the dialog in pixels\n</pre>\n\nExample usage:\n<pre><code>\nRoo.Msg.show({\n title: 'Address',\n msg: 'Please enter your address:',\n width: 300,\n buttons: Roo.MessageBox.OKCANCEL,\n multiline: true,\n fn: saveAddress,\n animEl: 'addAddressBtn'\n});\n</code></pre>",
+ "sig" : "(config)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
+ },
+ {
+ "name" : "updateProgress",
+ "type" : "function",
+ "desc" : "Updates a progress-style message box's text and progress bar. Only relevant on message boxes\ninitiated via {@link Roo.MessageBox#progress} or by calling {@link Roo.MessageBox#show} with progress: true.",
+ "sig" : "(value, text)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Number",
+ "desc" : "Any number between 0 and 1 (e.g., .5)",
+ "isOptional" : false
+ },
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "(optional) If defined, the message box's body text is replaced with the specified string (defaults to undefined)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
+ },
+ {
+ "name" : "updateText",
+ "type" : "function",
+ "desc" : "Updates the message box body text",
+ "sig" : "(text)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "(optional) Replaces the message box element's innerHTML with the specified string (defaults to\nthe XHTML-compliant non-breaking space character '&#160;')",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
+ },
+ {
+ "name" : "wait",
+ "type" : "function",
+ "desc" : "Displays a message box with an infinitely auto-updating progress bar. This can be used to block user\ninteraction while waiting for a long-running process to complete that does not have defined intervals.\nYou are responsible for closing the message box when the process is complete.",
+ "sig" : "(msg, title)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The message box body text",
+ "isOptional" : false
+ },
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "(optional) The title bar text",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
}
]
},
- "Roo.bootstrap.MenuItem" : {
+ "Roo.bootstrap.Modal" : {
"props" : [
{
"name" : "actionMode",
"memberOf" : "Roo.Component"
},
{
- "name" : "active",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "used on sidebars to highlight active itesm",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "allow_close",
+ "type" : "Boolean",
+ "desc" : "default true",
"memberOf" : ""
},
{
- "name" : "allowDomMove",
+ "name" : "animate",
"type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "desc" : "default true",
+ "memberOf" : ""
+ },
+ {
+ "name" : "bodyOverflow",
+ "type" : "Boolean",
+ "desc" : "should the body element have overflow auto added default false",
+ "memberOf" : ""
+ },
+ {
+ "name" : "buttonPosition",
+ "type" : "String",
+ "desc" : "r) default right (DEPRICATED) - use mr-auto on buttons to put them on the left",
+ "memberOf" : ""
+ },
+ {
+ "name" : "buttons[]",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "Array of buttons or standard button set..",
+ "memberOf" : ""
},
{
"name" : "can_build_overlaid",
"memberOf" : "Roo.Component"
},
{
- "name" : "fa",
- "type" : "String",
- "desc" : "favicon to show on left of menu item.",
+ "name" : "editableTitle",
+ "type" : "Boolean",
+ "desc" : "can the title be edited",
"memberOf" : ""
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "name" : "fitwindow",
+ "type" : "Boolean",
+ "desc" : "default false",
+ "memberOf" : ""
},
{
- "name" : "href",
- "type" : "String",
- "desc" : "the link",
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "fixed height - usefull for chrome extension only really.",
"memberOf" : ""
},
{
- "name" : "html",
+ "name" : "hideMode",
"type" : "String",
- "desc" : "the menu label",
- "memberOf" : ""
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "isContainer",
- "type" : "Boolean",
- "desc" : "is it a container - just returns a drop down item..",
+ "name" : "html",
+ "type" : "String",
+ "desc" : "- the body of the dialog (for simple ones) - you can also use template..",
"memberOf" : ""
},
{
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "menu",
- "type" : "Roo.bootsrap.Menu",
- "desc" : "the child menu.",
+ "name" : "max_width",
+ "type" : "Number",
+ "desc" : "set the max width of modal",
"memberOf" : ""
},
{
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "preventDefault",
+ "name" : "size",
+ "type" : "String",
+ "desc" : "l) default empty",
+ "memberOf" : ""
+ },
+ {
+ "name" : "specificTitle",
"type" : "Boolean",
- "desc" : "do not trigger A href on clicks (default false).",
+ "desc" : "default false",
"memberOf" : ""
},
{
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "Title of dialog",
+ "memberOf" : ""
+ },
+ {
+ "name" : "tmpl",
+ "type" : "Roo.Template",
+ "desc" : "- a template with variables. to use it, add a handler in show:method adn",
+ "memberOf" : ""
+ },
{
"name" : "tooltip",
"type" : "string",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "fixed width - usefull for chrome extension only really.",
+ "memberOf" : ""
+ },
{
"name" : "xattr",
"type" : "Object",
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "btnclick",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "The raw btnclick event for the button",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "click",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.MenuItem",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "resize",
+ "type" : "function",
+ "desc" : "Fire when dialog resize",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Modal",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "titlechanged",
+ "type" : "function",
+ "desc" : "Fire when the editable title has been changed",
+ "sig" : "function (_self, value)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Modal",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
],
"returns" : []
},
+ {
+ "name" : "applyBody",
+ "type" : "function",
+ "desc" : "Set the body of the Dialog using the template",
+ "sig" : "(data)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "data",
+ "type" : "Obj",
+ "desc" : "- apply this data to the template and replace the body contents.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setBody",
+ "type" : "function",
+ "desc" : "Set the body of the Dialog",
+ "sig" : "(str)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "str",
+ "type" : "String",
+ "desc" : "new Title",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setTitle",
+ "type" : "function",
+ "desc" : "Set the title of the Dialog",
+ "sig" : "(str)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "str",
+ "type" : "String",
+ "desc" : "new Title",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
}
]
},
- "Roo.bootstrap.MenuMgr" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ "Roo.bootstrap.MoneyField" : {
+ "props" : [
{
- "name" : "get",
- "type" : "function",
- "desc" : "Returns a {@link Roo.menu.Menu} object",
- "sig" : "(menu)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "menu",
- "type" : "String/Object",
- "desc" : "The string menu id, an existing menu object reference, or a Menu config that will\nbe used to generate and return a new Menu instance.",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input"
},
- {
- "name" : "hideAll",
- "type" : "function",
- "desc" : "Hides all menus that are currently visible",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- }
- ]
- },
- "Roo.bootstrap.MenuSeparator" : {
- "props" : [
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default left",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "allQuery",
+ "type" : "String",
+ "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "allowDecimals",
+ "type" : "Boolean",
+ "desc" : "False to disallow decimal values (defaults to true)",
+ "memberOf" : ""
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "allowNegative",
+ "type" : "Boolean",
+ "desc" : "False to prevent entering a negative sign (defaults to true)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "allowZero",
+ "type" : "Boolean",
+ "desc" : "False to blank out if the user enters '0' (defaults to true)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "alwaysQuery",
+ "type" : "Boolean",
+ "desc" : "Disable caching of results, and always send query",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean",
+ "desc" : "default true",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "append",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "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" : "autoFocus",
+ "type" : "Boolean",
+ "desc" : "e) auto focus the first item, default true",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "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" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "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" : "blockFocus",
+ "type" : "Boolean",
+ "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "btnPosition",
+ "type" : "String",
+ "desc" : "set the position of the trigger button (left | right) default right",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "caret",
+ "type" : "String",
+ "desc" : "r) BS3 only - carat fa name",
+ "memberOf" : "Roo.bootstrap.TriggerField"
+ },
+ {
+ "name" : "castInt",
+ "type" : "Boolean",
+ "desc" : "e) cast int if true (defalut true)",
+ "memberOf" : ""
+ },
{
"name" : "cls",
"type" : "String",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "decimalPrecision",
+ "type" : "Number",
+ "desc" : "The maximum precision to display after the decimal separator (defaults to 2)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "decimalSeparator",
+ "type" : "String",
+ "desc" : "Character(s) to allow as the decimal separator (defaults to '.')",
+ "memberOf" : ""
+ },
+ {
+ "name" : "defaults",
+ "type" : "String",
+ "desc" : "currency of the MoneyField\nvalue should be in lkey",
+ "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" : "disableClear",
+ "type" : "Boolean",
+ "desc" : "Disable showing of clear button.",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "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" : "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" : "emptyResultText",
+ "type" : "Boolean",
+ "desc" : "only for touch device",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "emptyTitle",
+ "type" : "String",
+ "desc" : "default ''",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "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" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "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" : "grow",
+ "type" : "Boolean",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "growMax",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "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" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "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" : "Roo.bootstrap.ComboBox"
+ },
{
"name" : "hideMode",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "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" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - uses BS4 is-valid now",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "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" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "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" : "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" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "listAlign",
+ "type" : "String",
+ "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "listClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "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" : "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" : "loadingText",
+ "type" : "String",
+ "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "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" : "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" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "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" : "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" : "maxValue",
+ "type" : "Number",
+ "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "max_length",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "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" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "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" : "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" : "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" : "minValue",
+ "type" : "Number",
+ "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "mobileTouchView",
+ "type" : "Boolean",
+ "desc" : "e) show mobile touch view when using a mobile default true",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "mobile_restrict_height",
+ "type" : "Boolean",
+ "desc" : "e) restrict height for touch view",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "modalTitle",
+ "type" : "String",
+ "desc" : "The title of the dialog that pops up on mobile views.",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "mode",
+ "type" : "String",
+ "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "multiple",
+ "type" : "Boolean",
+ "desc" : "e) ComboBobArray, default false",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
{
"name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "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" : "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" : "placeholder",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "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" : "queryParam",
+ "type" : "String",
+ "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "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" : "removable",
+ "type" : "Boolean",
+ "desc" : "e) special filter default false",
+ "memberOf" : "Roo.bootstrap.TriggerField"
+ },
+ {
+ "name" : "resizable",
+ "type" : "Boolean",
+ "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "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" : "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" : "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" : "showToggleBtn",
+ "type" : "Boolean",
+ "desc" : "show toggle button or not (true|false) default true",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "specialFilter",
+ "type" : "Boolean",
+ "desc" : "e) special filter default false",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "Store to lookup currency??",
+ "memberOf" : ""
},
{
"name" : "style",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "thousandsDelimiter",
+ "type" : "String",
+ "desc" : "Symbol of thousandsDelimiter",
+ "memberOf" : ""
+ },
+ {
+ "name" : "tickable",
+ "type" : "Boolean",
+ "desc" : "ComboBox with tickable selections (true|false), default false",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "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" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "tpl",
+ "type" : "String/Roo.Template",
+ "desc" : "The template to use to render the output default is '<a class=\"dropdown-item\" href=\"#\">{' + this.displayField + '}</a>'",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "triggerAction",
+ "type" : "String",
+ "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "triggerClass",
+ "type" : "String",
+ "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
+ "memberOf" : "Roo.bootstrap.TriggerField"
+ },
+ {
+ "name" : "triggerList",
+ "type" : "Boolean",
+ "desc" : "trigger show the list or not (true|false) default true",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "triggerText",
+ "type" : "String",
+ "desc" : "multiple combobox trigger button text default 'Select'",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "typeAhead",
+ "type" : "Boolean",
+ "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "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" : "useNativeIOS",
+ "type" : "Boolean",
+ "desc" : "e) render it as classic select for ios, not support dynamic load data (default false)",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - uses BS4 is-valid now",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "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" : "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" : "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" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "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" : "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" : "visibilityEl",
"type" : "string|object",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "fixed with? experimental",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
{
- "name" : "beforedestroy",
+ "name" : "add",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.ComboBox",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "combo",
+ "type" : "Roo.bootstrap.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforehide",
+ "name" : "afterremove",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when the remove value from the combobox array",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.ComboBox",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "combo",
+ "type" : "Roo.bootstrap.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "beforequery",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
+ "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.ComboBox",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
- "desc" : "",
+ "name" : "combo",
+ "type" : "Roo.bootstrap.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "query",
+ "type" : "String",
+ "desc" : "The query",
+ "isOptional" : false
+ },
+ {
+ "name" : "forceAll",
+ "type" : "Boolean",
+ "desc" : "true to force \"all\" query",
+ "isOptional" : false
+ },
+ {
+ "name" : "cancel",
+ "type" : "Boolean",
+ "desc" : "true to cancel the query",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "The query event object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "disable",
+ "name" : "beforeselect",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
+ "sig" : "function (combo, record, index)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.ComboBox",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "combo",
+ "type" : "Roo.bootstrap.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The data record returned from the underlying store",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the selected item in the dropdown list",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enable",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "hide",
+ "name" : "blur",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires when this field loses input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "render",
+ "name" : "change",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Fires when the dropdown list is collapsed",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "edit",
+ "type" : "function",
+ "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo, record)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record|false",
+ "desc" : "The data record returned from the underlying store (or false on nothing selected)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Fires when the dropdown list is expanded",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "paste",
+ "type" : "function",
+ "desc" : "Fires after the user pastes into input",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "remove",
+ "type" : "function",
+ "desc" : "Fires when the remove value from the combobox array",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
],
"returns" : []
},
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "Fires when a list item is selected",
+ "sig" : "function (combo, record, index)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The data record returned from the underlying store (or false on clear)",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the selected item in the dropdown list",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "specialfilter",
+ "type" : "function",
+ "desc" : "Fires when specialfilter",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "tick",
+ "type" : "function",
+ "desc" : "Fires when tick the element",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "touchviewdisplay",
+ "type" : "function",
+ "desc" : "Fires when touch view require special display (default is using displayField)",
+ "sig" : "function (combo, cfg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "cfg",
+ "type" : "Object",
+ "desc" : "set html .",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
],
"returns" : []
},
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.TriggerField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "clearValue",
+ "type" : "function",
+ "desc" : "Clears any text/value currently set in the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "doQuery",
+ "type" : "function",
+ "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
+ "sig" : "(query, forceAll)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "query",
+ "type" : "String",
+ "desc" : "The SQL query to execute",
+ "isOptional" : false
+ },
+ {
+ "name" : "forceAll",
+ "type" : "Boolean",
+ "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "enable",
"type" : "function",
}
]
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "name The name field"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the currently selected field value or empty string if no value is set.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "value The selected value"
+ }
+ ]
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isExpanded",
+ "type" : "function",
+ "desc" : "Returns true if the dropdown list is expanded, else false.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "onTriggerClick",
+ "type" : "function",
+ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.TriggerField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "purgeListeners",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(index, scrollIntoView)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The zero-based index of the list item to select",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollIntoView",
+ "type" : "Boolean",
+ "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "selectByValue",
+ "type" : "function",
+ "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(value, scrollIntoView)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The data value of the item to select",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollIntoView",
+ "type" : "Boolean",
+ "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value matched an item in the list, else false"
+ }
+ ]
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setEditable",
+ "type" : "function",
+ "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Boolean",
+ "desc" : "True to allow the user to directly edit the field text",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setFromData",
+ "type" : "function",
+ "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Object",
+ "desc" : "the value to set as. or false on reset?",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The value to match",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
]
},
- "Roo.bootstrap.MessageBar" : {
+ "Roo.bootstrap.MonthField" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default left",
+ "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" : "allowDomMove",
"type" : "Boolean",
"memberOf" : "Roo.Component"
},
{
- "name" : "beforeClass",
+ "name" : "autocomplete",
"type" : "String",
- "desc" : "insert the bar before the given class",
- "memberOf" : ""
+ "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "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" : "can_build_overlaid",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "closable",
- "type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "cls",
"memberOf" : "Roo.Component"
},
{
- "name" : "fixed",
+ "name" : "disableKeyFilter",
"type" : "Boolean",
- "desc" : "e) default false, fix the bar at the top",
- "memberOf" : ""
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "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" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "hideMode",
"memberOf" : "Roo.Component"
},
{
- "name" : "html",
+ "name" : "indicatorpos",
"type" : "String",
- "desc" : "contents of the MessageBar",
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "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" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "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" : "language",
+ "type" : "String",
+ "desc" : "default en",
"memberOf" : ""
},
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "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"
},
+ {
+ "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" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "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" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "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" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "placeholder",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "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" : "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" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "style",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.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" : "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" : "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" : "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" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "weight",
+ "name" : "vtype",
"type" : "String",
- "desc" : "r) default info",
- "memberOf" : ""
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "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" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
],
"returns" : []
},
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "paste",
+ "type" : "function",
+ "desc" : "Fires after the user pastes into input",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "Fires when select a date.",
+ "sig" : "function (_self, oldvalue, newvalue)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.MonthField",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldvalue",
+ "type" : "String",
+ "desc" : "The old value",
+ "isOptional" : false
+ },
+ {
+ "name" : "newvalue",
+ "type" : "String",
+ "desc" : "The new value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
- "desc" : "Fires after the component is shown.",
+ "desc" : "Fires when this field show.",
+ "sig" : "function (_self, date)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.MonthField",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "date",
+ "type" : "Mixed",
+ "desc" : "The date value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "name The name field"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
}
],
"returns" : []
- }
- ]
- },
- "Roo.bootstrap.MessageBox" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "alert",
+ "name" : "validate",
"type" : "function",
- "desc" : "Displays a standard read-only message box with an OK button (comparable to the basic JavaScript Window.alert).\nIf a callback function is passed it will be called after the user clicks the button, and the\nid of the button that was clicked will be passed as the only parameter to the callback\n(could also be the top-right close button).",
- "sig" : "(title, msg, fn, scope)",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "title",
- "type" : "String",
- "desc" : "The title bar text",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The message box body text",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "(optional) The callback function invoked after the message box is closed",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the callback function",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
}
]
},
{
- "name" : "confirm",
+ "name" : "validateValue",
"type" : "function",
- "desc" : "Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's Window.confirm).\nIf a callback function is passed it will be called after the user clicks either button, and the id of the\nbutton that was clicked will be passed as the only parameter to the callback (could also be the top-right close button).",
- "sig" : "(title, msg, fn, scope)",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "title",
- "type" : "String",
- "desc" : "The title bar text",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The message box body text",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "(optional) The callback function invoked after the message box is closed",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the callback function",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
}
]
+ }
+ ]
+ },
+ "Roo.bootstrap.NumberField" : {
+ "props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "getDialog",
- "type" : "function",
- "desc" : "Returns a reference to the underlying {@link Roo.BasicDialog} element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.BasicDialog",
- "desc" : "The BasicDialog element"
- }
- ]
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "hide",
- "type" : "function",
- "desc" : "Hides the message box if it is displayed",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if the message box is currently displayed",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the message box is visible, else false"
- }
- ]
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "progress",
- "type" : "function",
- "desc" : "Displays a message box with a progress bar. This message box has no buttons and is not closeable by\nthe user. You are responsible for updating the progress bar as needed via {@link Roo.MessageBox#updateProgress}\nand closing the message box when the process is complete.",
- "sig" : "(title, msg)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "title",
- "type" : "String",
- "desc" : "The title bar text",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The message box body text",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default left",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "prompt",
- "type" : "function",
- "desc" : "Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to\nJavaScript's Window.prompt). The prompt can be a single-line or multi-line textbox. If a callback function\nis passed it will be called after the user clicks either button, and the id of the button that was clicked\n(could also be the top-right close button) and the text that was entered will be passed as the two\nparameters to the callback.",
- "sig" : "(title, msg, fn, scope, multiline)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "title",
- "type" : "String",
- "desc" : "The title bar text",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The message box body text",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "(optional) The callback function invoked after the message box is closed",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the callback function",
- "isOptional" : false
- },
- {
- "name" : "multiline",
- "type" : "Boolean/Number",
- "desc" : "(optional) True to create a multiline textbox using the defaultTextHeight\nproperty, or the height in pixels to create the textbox (defaults to false / single-line)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Displays a new message box, or reinitializes an existing message box, based on the config options\npassed in. All functions (e.g. prompt, alert, etc) on MessageBox call this function internally.\nThe following config object properties are supported:\n<pre>\nProperty Type Description\n---------- --------------- ------------------------------------------------------------------------------------\nanimEl String/Element An id or Element from which the message box should animate as it opens and\n closes (defaults to undefined)\nbuttons Object/Boolean A button config object (e.g., Roo.MessageBox.OKCANCEL or {ok:'Foo',\n cancel:'Bar'}), or false to not show any buttons (defaults to false)\nclosable Boolean False to hide the top-right close button (defaults to true). Note that\n progress and wait dialogs will ignore this property and always hide the\n close button as they can only be closed programmatically.\ncls String A custom CSS class to apply to the message box element\ndefaultTextHeight Number The default height in pixels of the message box's multiline textarea if\n displayed (defaults to 75)\nfn Function A callback function to execute after closing the dialog. The arguments to the\n function will be btn (the name of the button that was clicked, if applicable,\n e.g. \"ok\"), and text (the value of the active text field, if applicable).\n Progress and wait dialogs will ignore this option since they do not respond to\n user actions and can only be closed programmatically, so any required function\n should be called by the same code after it closes the dialog.\nicon String A CSS class that provides a background image to be used as an icon for\n the dialog (e.g., Roo.MessageBox.WARNING or 'custom-class', defaults to '')\nmaxWidth Number The maximum width in pixels of the message box (defaults to 600)\nminWidth Number The minimum width in pixels of the message box (defaults to 100)\nmodal Boolean False to allow user interaction with the page while the message box is\n displayed (defaults to true)\nmsg String A string that will replace the existing message box body text (defaults\n to the XHTML-compliant non-breaking space character ' ')\nmultiline Boolean True to prompt the user to enter multi-line text (defaults to false)\nprogress Boolean True to display a progress bar (defaults to false)\nprogressText String The text to display inside the progress bar if progress = true (defaults to '')\nprompt Boolean True to prompt the user to enter single-line text (defaults to false)\nproxyDrag Boolean True to display a lightweight proxy while dragging (defaults to false)\ntitle String The title text\nvalue String The string value to set into the active textbox element if displayed\nwait Boolean True to display a progress bar (defaults to false)\nwidth Number The width of the dialog in pixels\n</pre>\n\nExample usage:\n<pre><code>\nRoo.Msg.show({\n title: 'Address',\n msg: 'Please enter your address:',\n width: 300,\n buttons: Roo.MessageBox.OKCANCEL,\n multiline: true,\n fn: saveAddress,\n animEl: 'addAddressBtn'\n});\n</code></pre>",
- "sig" : "(config)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "config",
- "type" : "Object",
- "desc" : "Configuration options",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
- },
- {
- "name" : "updateProgress",
- "type" : "function",
- "desc" : "Updates a progress-style message box's text and progress bar. Only relevant on message boxes\ninitiated via {@link Roo.MessageBox#progress} or by calling {@link Roo.MessageBox#show} with progress: true.",
- "sig" : "(value, text)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Number",
- "desc" : "Any number between 0 and 1 (e.g., .5)",
- "isOptional" : false
- },
- {
- "name" : "text",
- "type" : "String",
- "desc" : "(optional) If defined, the message box's body text is replaced with the specified string (defaults to undefined)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
- },
- {
- "name" : "updateText",
- "type" : "function",
- "desc" : "Updates the message box body text",
- "sig" : "(text)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "text",
- "type" : "String",
- "desc" : "(optional) Replaces the message box element's innerHTML with the specified string (defaults to\nthe XHTML-compliant non-breaking space character '&#160;')",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "wait",
- "type" : "function",
- "desc" : "Displays a message box with an infinitely auto-updating progress bar. This can be used to block user\ninteraction while waiting for a long-running process to complete that does not have defined intervals.\nYou are responsible for closing the message box when the process is complete.",
- "sig" : "(msg, title)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The message box body text",
- "isOptional" : false
- },
- {
- "name" : "title",
- "type" : "String",
- "desc" : "(optional) The title bar text",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
- }
- ]
- },
- "Roo.bootstrap.Modal" : {
- "props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "name" : "allowDecimals",
+ "type" : "Boolean",
+ "desc" : "False to disallow decimal values (defaults to true)",
+ "memberOf" : ""
},
{
"name" : "allowDomMove",
"memberOf" : "Roo.Component"
},
{
- "name" : "allow_close",
+ "name" : "allowNegative",
"type" : "Boolean",
- "desc" : "default true",
+ "desc" : "False to prevent entering a negative sign (defaults to true)",
"memberOf" : ""
},
{
- "name" : "animate",
+ "name" : "allowZero",
"type" : "Boolean",
- "desc" : "default true",
+ "desc" : "False to blank out if the user enters '0' (defaults to true)",
"memberOf" : ""
},
{
- "name" : "bodyOverflow",
- "type" : "Boolean",
- "desc" : "should the body element have overflow auto added default false",
- "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" : "Roo.bootstrap.Input"
},
{
- "name" : "buttonPosition",
- "type" : "String",
- "desc" : "r) default right (DEPRICATED) - use mr-auto on buttons to put them on the left",
- "memberOf" : ""
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "buttons",
- "type" : "Array",
- "desc" : "Array of buttons or standard button set..",
- "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" : "can_build_overlaid",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "cls",
"type" : "String",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "decimalPrecision",
+ "type" : "Number",
+ "desc" : "The maximum precision to display after the decimal separator (defaults to 2)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "decimalSeparator",
+ "type" : "String",
+ "desc" : "Character(s) to allow as the decimal separator (defaults to '.')",
+ "memberOf" : ""
+ },
{
"name" : "disableClass",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "editableTitle",
+ "name" : "disableKeyFilter",
"type" : "Boolean",
- "desc" : "can the title be edited",
- "memberOf" : ""
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "fitwindow",
+ "name" : "disabled",
"type" : "Boolean",
- "desc" : "default false",
- "memberOf" : ""
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "fixed height - usefull for chrome extension only really.",
- "memberOf" : ""
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "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" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "hideMode",
"memberOf" : "Roo.Component"
},
{
- "name" : "html",
+ "name" : "indicatorpos",
"type" : "String",
- "desc" : "- the body of the dialog (for simple ones) - you can also use template..",
- "memberOf" : ""
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "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" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "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" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "max_width",
+ "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" : "maxLength",
"type" : "Number",
- "desc" : "set the max width of modal",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "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" : "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" : "maxValue",
+ "type" : "Number",
+ "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "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" : "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" : "minValue",
+ "type" : "Number",
+ "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
"memberOf" : ""
},
{
"name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "size",
+ "name" : "nanText",
"type" : "String",
- "desc" : "l) default empty",
+ "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" : "specificTitle",
+ "name" : "placeholder",
+ "type" : "string",
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "preventMark",
"type" : "Boolean",
- "desc" : "default false",
- "memberOf" : ""
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "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" : "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" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "style",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "title",
+ "name" : "thousandsDelimiter",
"type" : "String",
- "desc" : "Title of dialog",
- "memberOf" : ""
- },
- {
- "name" : "tmpl",
- "type" : "Roo.Template",
- "desc" : "- a template with variables. to use it, add a handler in show:method adn",
+ "desc" : "Symbol of thousandsDelimiter",
"memberOf" : ""
},
{
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.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" : "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" : "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" : "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" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "valueAlign",
+ "type" : "String",
+ "desc" : "alignment of value",
+ "memberOf" : ""
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "fixed width - usefull for chrome extension only really.",
- "memberOf" : ""
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "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" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
"returns" : []
},
{
- "name" : "btnclick",
+ "name" : "blur",
"type" : "function",
- "desc" : "The raw btnclick event for the button",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
}
],
"returns" : []
],
"returns" : []
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
"returns" : []
},
{
- "name" : "render",
+ "name" : "invalid",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resize",
+ "name" : "keyup",
"type" : "function",
- "desc" : "Fire when dialog resize",
+ "desc" : "Fires after the key up",
"sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Modal",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "paste",
+ "type" : "function",
+ "desc" : "Fires after the user pastes into input",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
},
{
"name" : "e",
"type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "titlechanged",
+ "name" : "specialkey",
"type" : "function",
- "desc" : "Fire when the editable title has been changed",
- "sig" : "function (_self, value)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Modal",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
},
{
- "name" : "value",
+ "name" : "e",
"type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "applyBody",
- "type" : "function",
- "desc" : "Set the body of the Dialog using the template",
- "sig" : "(data)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "data",
- "type" : "Obj",
- "desc" : "- apply this data to the template and replace the body contents.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "name The name field"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
"returns" : []
},
{
- "name" : "setBody",
+ "name" : "reset",
"type" : "function",
- "desc" : "Set the body of the Dialog",
- "sig" : "(str)",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "str",
- "type" : "String",
- "desc" : "new Title",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
"returns" : []
},
{
- "name" : "setTitle",
+ "name" : "setRawValue",
"type" : "function",
- "desc" : "Set the title of the Dialog",
- "sig" : "(str)",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "str",
- "type" : "String",
- "desc" : "new Title",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
"isOptional" : false
}
],
}
],
"returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
]
},
- "Roo.bootstrap.MoneyField" : {
+ "Roo.bootstrap.Pagination" : {
"props" : [
- {
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "accept",
- "type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "actionMode",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "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" : "align",
- "type" : "String",
- "desc" : "t) Default left",
- "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" : "allQuery",
+ "name" : "cls",
"type" : "String",
- "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "allowDecimals",
- "type" : "Boolean",
- "desc" : "False to disallow decimal values (defaults to true)",
- "memberOf" : ""
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "allowNegative",
- "type" : "Boolean",
- "desc" : "False to prevent entering a negative sign (defaults to true)",
- "memberOf" : ""
- },
- {
- "name" : "allowZero",
- "type" : "Boolean",
- "desc" : "False to blank out if the user enters '0' (defaults to true)",
- "memberOf" : ""
- },
- {
- "name" : "alwaysQuery",
- "type" : "Boolean",
- "desc" : "Disable caching of results, and always send query",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "animate",
- "type" : "Boolean",
- "desc" : "default true",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "append",
- "type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "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" : "autoFocus",
- "type" : "Boolean",
- "desc" : "e) auto focus the first item, default true",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "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" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "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" : "blockFocus",
- "type" : "Boolean",
- "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "btnPosition",
- "type" : "String",
- "desc" : "set the position of the trigger button (left | right) default right",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "capture",
- "type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "caret",
- "type" : "String",
- "desc" : "r) BS3 only - carat fa name",
- "memberOf" : "Roo.bootstrap.TriggerField"
- },
- {
- "name" : "castInt",
- "type" : "Boolean",
- "desc" : "e) cast int if true (defalut true)",
- "memberOf" : ""
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "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" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "decimalPrecision",
- "type" : "Number",
- "desc" : "The maximum precision to display after the decimal separator (defaults to 2)",
- "memberOf" : ""
- },
- {
- "name" : "decimalSeparator",
- "type" : "String",
- "desc" : "Character(s) to allow as the decimal separator (defaults to '.')",
- "memberOf" : ""
- },
- {
- "name" : "defaults",
- "type" : "String",
- "desc" : "currency of the MoneyField\nvalue should be in lkey",
- "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" : "disableClear",
- "type" : "Boolean",
- "desc" : "Disable showing of clear button.",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "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" : "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" : "emptyResultText",
- "type" : "Boolean",
- "desc" : "only for touch device",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "emptyTitle",
- "type" : "String",
- "desc" : "default ''",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "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" : "forceFeedback",
- "type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "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" : "grow",
- "type" : "Boolean",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "growMax",
- "type" : "Number",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "growMin",
- "type" : "Number",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "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" : "hasFeedback",
- "type" : "Boolean",
- "desc" : "e) default true",
- "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" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "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" : "indicatorpos",
- "type" : "String",
- "desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - uses BS4 is-valid now",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "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" : "labelAlign",
- "type" : "String",
- "desc" : "t)",
- "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" : "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" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "listAlign",
- "type" : "String",
- "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "listClass",
- "type" : "String",
- "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "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" : "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" : "loadingText",
- "type" : "String",
- "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "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" : "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" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "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" : "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" : "maxValue",
- "type" : "Number",
- "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)",
- "memberOf" : ""
- },
- {
- "name" : "max_length",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : ""
- },
- {
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "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" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "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" : "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" : "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" : "minValue",
- "type" : "Number",
- "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
- "memberOf" : ""
- },
- {
- "name" : "mobileTouchView",
- "type" : "Boolean",
- "desc" : "e) show mobile touch view when using a mobile default true",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "mobile_restrict_height",
- "type" : "Boolean",
- "desc" : "e) restrict height for touch view",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "modalTitle",
- "type" : "String",
- "desc" : "The title of the dialog that pops up on mobile views.",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "mode",
- "type" : "String",
- "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "multiple",
- "type" : "Boolean",
- "desc" : "e) ComboBobArray, default false",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "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" : "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" : "placeholder",
- "type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "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" : "queryParam",
- "type" : "String",
- "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "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" : "removable",
- "type" : "Boolean",
- "desc" : "e) special filter default false",
- "memberOf" : "Roo.bootstrap.TriggerField"
- },
- {
- "name" : "resizable",
- "type" : "Boolean",
- "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "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" : "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" : "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" : "showToggleBtn",
- "type" : "Boolean",
- "desc" : "show toggle button or not (true|false) default true",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "size",
- "type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "specialFilter",
- "type" : "Boolean",
- "desc" : "e) special filter default false",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to which this combo is bound (defaults to undefined)",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "thousandsDelimiter",
- "type" : "String",
- "desc" : "Symbol of thousandsDelimiter",
- "memberOf" : ""
- },
- {
- "name" : "tickable",
- "type" : "Boolean",
- "desc" : "ComboBox with tickable selections (true|false), default false",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "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" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "tpl",
- "type" : "String/Roo.Template",
- "desc" : "The template to use to render the output default is '<a class=\"dropdown-item\" href=\"#\">{' + this.displayField + '}</a>'",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "triggerAction",
- "type" : "String",
- "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "triggerClass",
- "type" : "String",
- "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
- "memberOf" : "Roo.bootstrap.TriggerField"
- },
- {
- "name" : "triggerList",
- "type" : "Boolean",
- "desc" : "trigger show the list or not (true|false) default true",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "triggerText",
- "type" : "String",
- "desc" : "multiple combobox trigger button text default 'Select'",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "typeAhead",
- "type" : "Boolean",
- "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "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" : "useNativeIOS",
- "type" : "Boolean",
- "desc" : "e) render it as classic select for ios, not support dynamic load data (default false)",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - uses BS4 is-valid now",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "validFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "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" : "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" : "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" : "value",
- "type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "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" : "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" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "fixed with? experimental",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- }
- ],
- "events" : [
- {
- "name" : "add",
- "type" : "function",
- "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "afterremove",
- "type" : "function",
- "desc" : "Fires when the remove value from the combobox array",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforequery",
- "type" : "function",
- "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
- "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "query",
- "type" : "String",
- "desc" : "The query",
- "isOptional" : false
- },
- {
- "name" : "forceAll",
- "type" : "Boolean",
- "desc" : "true to force \"all\" query",
- "isOptional" : false
- },
- {
- "name" : "cancel",
- "type" : "Boolean",
- "desc" : "true to cancel the query",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Object",
- "desc" : "The query event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeselect",
- "type" : "function",
- "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
- "sig" : "function (combo, record, index)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The data record returned from the underlying store",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the selected item in the dropdown list",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Fires when the dropdown list is collapsed",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "edit",
- "type" : "function",
- "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo, record)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record|false",
- "desc" : "The data record returned from the underlying store (or false on nothing selected)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Fires when the dropdown list is expanded",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "paste",
- "type" : "function",
- "desc" : "Fires after the user pastes into input",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "remove",
- "type" : "function",
- "desc" : "Fires when the remove value from the combobox array",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when a list item is selected",
- "sig" : "function (combo, record, index)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The data record returned from the underlying store (or false on clear)",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the selected item in the dropdown list",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "specialfilter",
- "type" : "function",
- "desc" : "Fires when specialfilter",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "tick",
- "type" : "function",
- "desc" : "Fires when tick the element",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "touchviewdisplay",
- "type" : "function",
- "desc" : "Fires when touch view require special display (default is using displayField)",
- "sig" : "function (combo, cfg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "cfg",
- "type" : "Object",
- "desc" : "set html .",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "methods" : [
- {
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "addListener",
- "type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "capture",
- "type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "clearValue",
- "type" : "function",
- "desc" : "Clears any text/value currently set in the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "doQuery",
- "type" : "function",
- "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
- "sig" : "(query, forceAll)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "query",
- "type" : "String",
- "desc" : "The SQL query to execute",
- "isOptional" : false
- },
- {
- "name" : "forceAll",
- "type" : "Boolean",
- "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "fireEvent",
- "type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "getChildContainer",
- "type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
- },
- {
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
- }
- ]
- },
- {
- "name" : "getId",
- "type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "name The name field"
- }
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the currently selected field value or empty string if no value is set.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "value The selected value"
- }
- ]
- },
- {
- "name" : "getVisibilityEl",
- "type" : "function",
- "desc" : "Get the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "hasListener",
- "type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "initEvents",
- "type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isExpanded",
- "type" : "function",
- "desc" : "Returns true if the dropdown list is expanded, else false.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "on",
- "type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "onTriggerClick",
- "type" : "function",
- "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "removeListener",
- "type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(index, scrollIntoView)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The zero-based index of the list item to select",
- "isOptional" : false
- },
- {
- "name" : "scrollIntoView",
- "type" : "Boolean",
- "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "selectByValue",
- "type" : "function",
- "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(value, scrollIntoView)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "String",
- "desc" : "The data value of the item to select",
- "isOptional" : false
- },
- {
- "name" : "scrollIntoView",
- "type" : "Boolean",
- "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value matched an item in the list, else false"
- }
- ]
- },
- {
- "name" : "setDisabled",
- "type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setEditable",
- "type" : "function",
- "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Boolean",
- "desc" : "True to allow the user to directly edit the field text",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setFromData",
- "type" : "function",
- "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Object",
- "desc" : "the value to set as. or false on reset?",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "String",
- "desc" : "The value to match",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setVisibilityEl",
- "type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
- },
- {
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- }
- ]
- },
- "Roo.bootstrap.MonthField" : {
- "props" : [
- {
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "accept",
- "type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) Default left",
- "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" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
- },
- {
- "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" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "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" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "capture",
- "type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "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" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "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" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "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" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "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" : "labelAlign",
- "type" : "String",
- "desc" : "t)",
- "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" : "language",
- "type" : "String",
- "desc" : "default en",
- "memberOf" : ""
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "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"
- },
- {
- "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" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "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" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "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" : "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" : "preventMark",
- "type" : "Boolean",
- "desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "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" : "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" : "size",
- "type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.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" : "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" : "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" : "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" : "value",
- "type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- }
- ],
- "events" : [
- {
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "paste",
- "type" : "function",
- "desc" : "Fires after the user pastes into input",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when select a date.",
- "sig" : "function (_self, oldvalue, newvalue)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.MonthField",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "oldvalue",
- "type" : "String",
- "desc" : "The old value",
- "isOptional" : false
- },
- {
- "name" : "newvalue",
- "type" : "String",
- "desc" : "The new value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Fires when this field show.",
- "sig" : "function (_self, date)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.MonthField",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "date",
- "type" : "Mixed",
- "desc" : "The date value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "methods" : [
- {
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "addListener",
- "type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "capture",
- "type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "fireEvent",
- "type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "getChildContainer",
- "type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
- },
- {
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
- }
- ]
- },
- {
- "name" : "getId",
- "type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "name The name field"
- }
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "getVisibilityEl",
- "type" : "function",
- "desc" : "Get the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "hasListener",
- "type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "initEvents",
- "type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "on",
- "type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "removeListener",
- "type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "setDisabled",
- "type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setVisibilityEl",
- "type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
- },
- {
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- }
- ]
- },
- "Roo.bootstrap.NavGroup" : {
- "props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t)",
- "memberOf" : ""
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "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" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "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" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "",
- "memberOf" : ""
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "navId",
- "type" : "String",
- "desc" : "- reference Id for navbar.",
- "memberOf" : ""
- },
- {
- "name" : "pilltype",
- "type" : "Boolean",
- "desc" : "default true (turn to off to disable active toggle)",
- "memberOf" : ""
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "type",
- "type" : "String",
- "desc" : "b) default nav",
- "memberOf" : ""
- },
- {
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "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" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "changed",
- "type" : "function",
- "desc" : "Fires when the active item changes",
- "sig" : "function (_self, selected, prev)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.NavGroup",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "selected",
- "type" : "Roo.bootstrap.Navbar.Item",
- "desc" : "The item selected",
- "isOptional" : false
- },
- {
- "name" : "prev",
- "type" : "Roo.bootstrap.Navbar.Item",
- "desc" : "The previously selected item",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "methods" : [
- {
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "addItem",
- "type" : "function",
- "desc" : "adds a Navigation item",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.NavItem",
- "desc" : "navitem to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "addListener",
- "type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "capture",
- "type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "clearAll",
- "type" : "function",
- "desc" : "clear all the Navigation item",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "fireEvent",
- "type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "get",
- "type" : "function",
- "desc" : "fetch a Navigation Group based on the navigation ID",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "string",
- "desc" : "navgroup to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "getActive",
- "type" : "function",
- "desc" : "gets the active Navigation item",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.bootstrap.NavItem",
- "desc" : "the current navitem"
- }
- ]
- },
- {
- "name" : "getChildContainer",
- "type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
- },
- {
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
- }
- ]
- },
- {
- "name" : "getId",
- "type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getVisibilityEl",
- "type" : "function",
- "desc" : "Get the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "hasListener",
- "type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "initEvents",
- "type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "on",
- "type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "register",
- "type" : "function",
- "desc" : "register a Navigation item",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.NavItem",
- "desc" : "navitem to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "register",
- "type" : "function",
- "desc" : "register a Navigation Group",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.NavGroup",
- "desc" : "navgroup to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "removeListener",
- "type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setActiveItem",
- "type" : "function",
- "desc" : "sets the active Navigation item",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.NavItem",
- "desc" : "new current navitem",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setDisabled",
- "type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setVisibilityEl",
- "type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
- },
- {
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ]
- },
- "Roo.bootstrap.NavHeaderbar" : {
- "props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) alignment",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "arrangement",
- "type" : "Boolean",
- "desc" : "stacked | justified",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
- {
- "name" : "autohide",
- "type" : "Boolean",
- "desc" : "a top nav bar header that hides on scroll.",
- "memberOf" : ""
- },
- {
- "name" : "brand",
- "type" : "String",
- "desc" : "what is brand",
- "memberOf" : ""
- },
- {
- "name" : "brand_href",
- "type" : "String",
- "desc" : "href of the brand",
- "memberOf" : ""
- },
- {
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "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" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "desktopCenter",
- "type" : "Boolean",
- "desc" : "should the header be centered on desktop using a container class",
- "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" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "is inverted color",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
- {
- "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" : "loadMask",
- "type" : "Boolean",
- "desc" : "e) loadMask on the bar",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
- {
- "name" : "main",
- "type" : "Boolean",
- "desc" : "e) main nav bar? default false",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
- {
- "name" : "mobilerow",
- "type" : "Roo.bootstrap.Row",
- "desc" : "- a row to display on mobile only..",
- "memberOf" : ""
- },
- {
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "position",
- "type" : "String",
- "desc" : "p) position",
- "memberOf" : ""
- },
- {
- "name" : "srButton",
- "type" : "Boolean",
- "desc" : "generate the (screen reader / mobile) sr-only button default true",
- "memberOf" : ""
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "tag",
- "type" : "String",
- "desc" : "v) default is nav",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
- {
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "type",
- "type" : "String",
- "desc" : "s)",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
- {
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "weight",
- "type" : "String",
- "desc" : "e) default is light.",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
- {
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
- }
- ],
- "events" : [
- {
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforetoggle",
- "type" : "function",
- "desc" : "Fire before toggle the menu",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Navbar",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "methods" : [
- {
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "addListener",
- "type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "capture",
- "type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Collapse the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Navbar",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expand the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Navbar",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "fireEvent",
- "type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "getChildContainer",
- "type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
- },
- {
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
- }
- ]
- },
- {
- "name" : "getId",
- "type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getVisibilityEl",
- "type" : "function",
- "desc" : "Get the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "hasListener",
- "type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "initEvents",
- "type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "on",
- "type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "removeListener",
- "type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setDisabled",
- "type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setVisibilityEl",
- "type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
- },
- {
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ]
- },
- "Roo.bootstrap.NavItem" : {
- "props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "active",
- "type" : "Boolean",
- "desc" : "Is item active",
- "memberOf" : ""
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "animateRef",
- "type" : "Boolean",
- "desc" : "e) link to element default false",
- "memberOf" : ""
- },
- {
- "name" : "badge",
- "type" : "String",
- "desc" : "text inside badge",
- "memberOf" : ""
- },
- {
- "name" : "badgecls",
- "type" : "String",
- "desc" : "w)the extra classes for the badge",
- "memberOf" : ""
- },
- {
- "name" : "button_outline",
- "type" : "Boolean",
- "desc" : "show and outlined button",
- "memberOf" : ""
- },
- {
- "name" : "button_weight",
- "type" : "String",
- "desc" : "k) default none",
- "memberOf" : ""
- },
- {
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "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" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "dataId",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "Is item disabled",
- "memberOf" : ""
- },
- {
- "name" : "fa",
- "type" : "String",
- "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)",
- "memberOf" : ""
- },
- {
- "name" : "glyphicon",
- "type" : "String",
- "desc" : "DEPRICATED - use fa",
- "memberOf" : ""
- },
{
"name" : "hideMode",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "href",
- "type" : "String",
- "desc" : "link to",
- "memberOf" : ""
- },
- {
- "name" : "html",
- "type" : "String",
- "desc" : "content of button",
- "memberOf" : ""
- },
- {
- "name" : "icon",
- "type" : "String",
- "desc" : "DEPRICATED - use fa",
- "memberOf" : ""
- },
- {
- "name" : "linkcls",
- "type" : "String",
- "desc" : "Link Class",
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "",
"memberOf" : ""
},
{
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "e) default false",
+ "name" : "size",
+ "type" : "String",
+ "desc" : "l)",
"memberOf" : ""
},
{
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "tabId",
- "type" : "String",
- "desc" : "the tab that this item activates.",
- "memberOf" : ""
- },
- {
- "name" : "tagtype",
- "type" : "String",
- "desc" : "n) render as a href or span?",
- "memberOf" : ""
- },
{
"name" : "tooltip",
"type" : "string",
],
"returns" : []
},
- {
- "name" : "changed",
- "type" : "function",
- "desc" : "Fires when the active item active state changes",
- "sig" : "function (_self, state)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.NavItem",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "state",
- "type" : "boolean",
- "desc" : "the new state",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "scrollto",
- "type" : "function",
- "desc" : "Fires when scroll to element",
- "sig" : "function (_self, options, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.NavItem",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setHtml",
- "type" : "function",
- "desc" : "Set the HTML (text content) of the item",
- "sig" : "(html)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "html",
- "type" : "string",
- "desc" : "content for the nav item",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
"desc" : "Fetch the element to display the tooltip on.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
- "Roo.bootstrap.NavProgressBar" : {
+ "Roo.bootstrap.PaginationItem" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "active",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : ""
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "default false",
+ "memberOf" : ""
+ },
{
"name" : "hideMode",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "href",
+ "type" : "String",
+ "desc" : "the link",
+ "memberOf" : ""
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "text",
+ "memberOf" : ""
+ },
{
"name" : "listeners",
"type" : "Object",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : ""
+ },
{
"name" : "style",
"type" : "String",
"returns" : []
},
{
- "name" : "changed",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires when the active item changes",
- "sig" : "function (_self, selected, prev)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.NavProgressBar",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "selected",
- "type" : "Roo.bootstrap.NavProgressItem",
- "desc" : "The item selected",
- "isOptional" : false
- },
- {
- "name" : "prev",
- "type" : "Roo.bootstrap.NavProgressItem",
- "desc" : "The previously selected item",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "click",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "The raw click event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
}
]
},
- "Roo.bootstrap.NavProgressItem" : {
+ "Roo.bootstrap.PagingToolbar" : {
"props" : [
{
"name" : "actionMode",
"memberOf" : "Roo.Component"
},
{
- "name" : "active",
- "type" : "Boolean",
- "desc" : "e) Is item active default false",
- "memberOf" : ""
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) alignment",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
"name" : "allowDomMove",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "arrangement",
+ "type" : "Boolean",
+ "desc" : "stacked | justified",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
+ {
+ "name" : "buttons[]",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "Buttons for the toolbar",
+ "memberOf" : ""
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "css class",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "container The id or element that will contain the toolbar",
+ "memberOf" : ""
+ },
{
"name" : "container_method",
"type" : "string",
"memberOf" : "Roo.Component"
},
{
- "name" : "disabled",
+ "name" : "displayInfo",
"type" : "Boolean",
- "desc" : "e) Is item active default false",
+ "desc" : "True to display the displayMsg (defaults to false)",
"memberOf" : ""
},
{
- "name" : "hideMode",
+ "name" : "displayMsg",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "The paging status message to display (defaults to \"Displaying {start} - {end} of {total}\")",
+ "memberOf" : ""
},
{
- "name" : "html",
+ "name" : "emptyMsg",
"type" : "String",
- "desc" : "",
+ "desc" : "The message to display when no records are found (defaults to \"No data to display\")",
"memberOf" : ""
},
{
- "name" : "icon",
+ "name" : "hideMode",
"type" : "String",
- "desc" : "show icon instead of number",
- "memberOf" : ""
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "is inverted color",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
"name" : "listeners",
"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" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "e) loadMask on the bar",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
+ {
+ "name" : "main",
+ "type" : "Boolean",
+ "desc" : "e) main nav bar? default false",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
{
"name" : "name",
"type" : "string",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "position",
- "type" : "String",
- "desc" : "m) text position default bottom",
+ "name" : "pageSize",
+ "type" : "Number",
+ "desc" : "The number of records to display per page (defaults to 20)",
"memberOf" : ""
},
{
- "name" : "rid",
- "type" : "String",
- "desc" : "the reference id",
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The underlying data store providing the paged data",
"memberOf" : ""
},
{
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "v) default is nav",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "type",
+ "type" : "String",
+ "desc" : "s)",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "e) default is light.",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
{
"name" : "xattr",
"type" : "Object",
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "beforetoggle",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "Fire before toggle the menu",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "click",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.NavProgressItem",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "bind",
+ "type" : "function",
+ "desc" : "Binds the paging toolbar to the specified {@link Roo.data.Store}",
+ "sig" : "(store)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to bind",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Collapse the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expand the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "unbind",
+ "type" : "function",
+ "desc" : "Unbinds the paging toolbar from the specified {@link Roo.data.Store}",
+ "sig" : "(store)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to unbind",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
]
},
- "Roo.bootstrap.NavSidebar" : {
+ "Roo.bootstrap.PhoneInput" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default left",
+ "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" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "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" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "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" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "caret",
+ "type" : "String",
+ "desc" : "r) BS3 only - carat fa name",
+ "memberOf" : "Roo.bootstrap.TriggerField"
+ },
{
"name" : "cls",
"type" : "String",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "defaultDialCode",
+ "type" : "String",
+ "desc" : "default '+852'",
+ "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" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "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" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "hideMode",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "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" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "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" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "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" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "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"
},
+ {
+ "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" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "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" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "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" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "placeholder",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "preferedCountries",
+ "type" : "Array",
+ "desc" : "default []",
+ "memberOf" : ""
+ },
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "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" : "removable",
+ "type" : "Boolean",
+ "desc" : "e) special filter default false",
+ "memberOf" : "Roo.bootstrap.TriggerField"
+ },
+ {
+ "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" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "[required] The data store to which this combo is bound (defaults to undefined)",
+ "memberOf" : ""
},
{
"name" : "style",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.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" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-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" : "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" : "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" : "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" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
"returns" : []
},
{
- "name" : "beforetoggle",
+ "name" : "blur",
"type" : "function",
- "desc" : "Fire before toggle the menu",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Navbar",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "paste",
+ "type" : "function",
+ "desc" : "Fires after the user pastes into input",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
],
"returns" : []
},
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.TriggerField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
"returns" : []
},
{
- "name" : "collapse",
+ "name" : "clearInvalid",
"type" : "function",
- "desc" : "Collapse the navbar pulldown",
+ "desc" : "Clear any invalid styles/messages for this field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Navbar",
+ "memberOf" : "Roo.bootstrap.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expand the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Navbar",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "fireEvent",
"type" : "function",
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "name The name field"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "onTriggerClick",
+ "type" : "function",
+ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.TriggerField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "purgeListeners",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
]
},
- "Roo.bootstrap.NavSidebarItem" : {
+ "Roo.bootstrap.Popover" : {
"props" : [
+ {
+ "name" : "(right|top|bottom|left|auto)",
+ "type" : "String|function",
+ "desc" : "placement how it is placed",
+ "memberOf" : ""
+ },
{
"name" : "actionMode",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "active",
- "type" : "Boolean",
- "desc" : "Is item active",
- "memberOf" : "Roo.bootstrap.NavItem"
+ "name" : "add",
+ "type" : "String|Boolean|Roo.Element",
+ "desc" : "click hander to trigger show over what element\n - if false and it has a 'parent' then it will be automatically added to that element\n - if string - Roo.get will be called",
+ "memberOf" : ""
},
{
"name" : "allowDomMove",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "animateRef",
- "type" : "Boolean",
- "desc" : "e) link to element default false",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
- {
- "name" : "badge",
- "type" : "String",
- "desc" : "text inside badge",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
- {
- "name" : "badgecls",
- "type" : "String",
- "desc" : "w)the extra classes for the badge",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
- {
- "name" : "button_outline",
- "type" : "Boolean",
- "desc" : "show and outlined button",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
- {
- "name" : "button_weight",
- "type" : "String",
- "desc" : "k) default none",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "delay",
+ "type" : "Number",
+ "desc" : "- delay before showing",
+ "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" : "disabled",
- "type" : "Boolean",
- "desc" : "Is item disabled",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
- {
- "name" : "fa",
- "type" : "String",
- "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
- {
- "name" : "glyphicon",
- "type" : "String",
- "desc" : "DEPRICATED - use fa",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
{
"name" : "hideMode",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
- {
- "name" : "href",
- "type" : "String",
- "desc" : "link to",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
{
"name" : "html",
"type" : "String",
- "desc" : "content of button",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
- {
- "name" : "icon",
- "type" : "String",
- "desc" : "DEPRICATED - use fa",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
- {
- "name" : "linkcls",
- "type" : "String",
- "desc" : "Link Class",
- "memberOf" : "Roo.bootstrap.NavItem"
+ "desc" : "contents of the popover (or false to use children..)",
+ "memberOf" : ""
},
{
"name" : "listeners",
"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" : "modal",
+ "type" : "Boolean",
+ "desc" : "- popovers that are modal will mask the screen, and must be closed with another event.",
+ "memberOf" : ""
+ },
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
{
"name" : "style",
"type" : "String",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "tabId",
- "type" : "String",
- "desc" : "the tab that this item activates.",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
- {
- "name" : "tagtype",
+ "name" : "title",
"type" : "String",
- "desc" : "n) render as a href or span?",
- "memberOf" : "Roo.bootstrap.NavItem"
+ "desc" : "of popover (or false to hide)",
+ "memberOf" : ""
},
{
"name" : "tooltip",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "trigger",
+ "type" : "String",
+ "desc" : "click || hover (or false to trigger manually)",
+ "memberOf" : ""
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
],
"returns" : []
},
- {
- "name" : "changed",
- "type" : "function",
- "desc" : "Fires when the active item active state changes",
- "sig" : "function (_self, state)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.NavSidebarItem",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "state",
- "type" : "boolean",
- "desc" : "the new state",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
{
"name" : "hide",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "After the popover hide",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.Popover",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "scrollto",
- "type" : "function",
- "desc" : "Fires when scroll to element",
- "sig" : "function (_self, options, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.NavItem",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.NavItem",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
- "desc" : "Fires after the component is shown.",
+ "desc" : "After the popover show",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.Popover",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "setContent",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "(the)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "string",
+ "desc" : "body content",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
"returns" : []
},
{
- "name" : "setHtml",
+ "name" : "setTitle",
"type" : "function",
- "desc" : "Set the HTML (text content) of the item",
- "sig" : "(html)",
+ "desc" : "",
+ "sig" : "(the)",
"static" : false,
- "memberOf" : "Roo.bootstrap.NavItem",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "html",
+ "name" : "the",
"type" : "string",
- "desc" : "content for the nav item",
+ "desc" : "title",
"isOptional" : false
}
],
{
"name" : "show",
"type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
+ "desc" : "Show the popover",
+ "sig" : "(-, (left|right|top|bottom))",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "-",
+ "type" : "Roo.Element|string|Boolean",
+ "desc" : "element to align and point to. (set align to [ pos, offset ])",
+ "isOptional" : false
+ },
+ {
+ "name" : "(left|right|top|bottom)",
+ "type" : "string",
+ "desc" : "position",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
"desc" : "Fetch the element to display the tooltip on.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.NavItem",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
],
"returns" : []
+ },
+ {
+ "name" : "updatePosition",
+ "type" : "function",
+ "desc" : "fire this manually after loading a grid in the table for example",
+ "sig" : "((left|right|top|bottom), try)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "(left|right|top|bottom)",
+ "type" : "string",
+ "desc" : "where to try and put it (use false to use the last one)",
+ "isOptional" : false
+ },
+ {
+ "name" : "try",
+ "type" : "Boolean",
+ "desc" : "and move it if we cant get right position.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
]
},
- "Roo.bootstrap.NavSimplebar" : {
+ "Roo.bootstrap.PopoverNav" : {
"props" : [
{
"name" : "actionMode",
"name" : "align",
"type" : "String",
"desc" : "t) alignment",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
"name" : "allowDomMove",
"name" : "arrangement",
"type" : "Boolean",
"desc" : "stacked | justified",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
"name" : "can_build_overlaid",
"name" : "inverse",
"type" : "Boolean",
"desc" : "is inverted color",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
"name" : "listeners",
"name" : "loadMask",
"type" : "Boolean",
"desc" : "e) loadMask on the bar",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
"name" : "main",
"type" : "Boolean",
"desc" : "e) main nav bar? default false",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
"name" : "name",
"name" : "tag",
"type" : "String",
"desc" : "v) default is nav",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
"name" : "tooltip",
"name" : "type",
"type" : "String",
"desc" : "s)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
"name" : "visibilityEl",
"name" : "weight",
"type" : "String",
"desc" : "e) default is light.",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
"name" : "xattr",
"type" : "function",
"desc" : "Fire before toggle the menu",
"sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Navbar",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"example" : "",
"deprecated" : "",
"since" : "",
"desc" : "Collapse the navbar pulldown",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Navbar",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Expand the navbar pulldown",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Navbar",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
- "Roo.bootstrap.Navbar" : {
+ "Roo.bootstrap.Progress" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "active",
+ "type" : "Boolean",
+ "desc" : "animated of the progress bar",
+ "memberOf" : ""
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "striped",
+ "type" : "Boolean",
+ "desc" : "striped of the progress bar",
+ "memberOf" : ""
+ },
{
"name" : "style",
"type" : "String",
],
"returns" : []
},
- {
- "name" : "beforetoggle",
- "type" : "function",
- "desc" : "Fire before toggle the menu",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Collapse the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expand the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "fireEvent",
"type" : "function",
}
]
},
- "Roo.bootstrap.NumberField" : {
+ "Roo.bootstrap.ProgressBar" : {
"props" : [
- {
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "accept",
- "type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) Default left",
- "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" : "allowDecimals",
- "type" : "Boolean",
- "desc" : "False to disallow decimal values (defaults to true)",
- "memberOf" : ""
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"memberOf" : "Roo.Component"
},
{
- "name" : "allowNegative",
- "type" : "Boolean",
- "desc" : "False to prevent entering a negative sign (defaults to true)",
+ "name" : "aria_valuemax",
+ "type" : "Number",
+ "desc" : "aria-value max",
"memberOf" : ""
},
{
- "name" : "allowZero",
- "type" : "Boolean",
- "desc" : "False to blank out if the user enters '0' (defaults to true)",
+ "name" : "aria_valuemin",
+ "type" : "Number",
+ "desc" : "aria-value min",
"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" : "Roo.bootstrap.Input"
- },
- {
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "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" : "aria_valuenow",
+ "type" : "Number",
+ "desc" : "aria-value now",
+ "memberOf" : ""
},
{
"name" : "can_build_overlaid",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "capture",
- "type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "cls",
"type" : "String",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "decimalPrecision",
- "type" : "Number",
- "desc" : "The maximum precision to display after the decimal separator (defaults to 2)",
- "memberOf" : ""
- },
- {
- "name" : "decimalSeparator",
- "type" : "String",
- "desc" : "Character(s) to allow as the decimal separator (defaults to '.')",
- "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" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "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" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "hideMode",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "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" : "labelAlign",
+ "name" : "label",
"type" : "String",
- "desc" : "t)",
- "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" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "label for the progress bar",
+ "memberOf" : ""
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "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" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "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" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "maxText",
+ "name" : "panel",
"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" : "maxValue",
- "type" : "Number",
- "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)",
+ "desc" : ")",
"memberOf" : ""
},
{
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "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" : "minText",
+ "name" : "role",
"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" : "minValue",
- "type" : "Number",
- "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
+ "desc" : "role of the progress bar",
"memberOf" : ""
},
{
- "name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "nanText",
+ "name" : "sr_only",
"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\")",
+ "desc" : "text",
"memberOf" : ""
},
- {
- "name" : "placeholder",
- "type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "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" : "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" : "size",
- "type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "thousandsDelimiter",
- "type" : "String",
- "desc" : "Symbol of thousandsDelimiter",
- "memberOf" : ""
- },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.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" : "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" : "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" : "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" : "value",
- "type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "valueAlign",
- "type" : "String",
- "desc" : "alignment of value",
- "memberOf" : ""
- },
{
"name" : "visibilityEl",
"type" : "string|object",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
],
"returns" : []
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "paste",
- "type" : "function",
- "desc" : "Fires after the user pastes into input",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"methods" : [
],
"returns" : []
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "name The name field"
- }
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
]
},
- "Roo.bootstrap.Pagination" : {
+ "Roo.bootstrap.Radio" : {
"props" : [
{
"name" : "actionMode",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "boxLabel",
+ "type" : "String",
+ "desc" : "- the label associated",
+ "memberOf" : ""
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
- {
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "false | true",
- "memberOf" : ""
- },
{
"name" : "listeners",
"type" : "Object",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "size",
- "type" : "String",
- "desc" : "xs | sm | md | lg",
- "memberOf" : ""
- },
{
"name" : "style",
"type" : "String",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "- the value of radio",
+ "memberOf" : ""
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
}
]
},
- "Roo.bootstrap.PaginationItem" : {
+ "Roo.bootstrap.RadioSet" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "actionMode",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "active",
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default left",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "allowBlank",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "allowDomMove",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "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" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "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" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "cls",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "disabled",
"type" : "Boolean",
- "desc" : "default false",
- "memberOf" : ""
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "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" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "hideMode",
"memberOf" : "Roo.Component"
},
{
- "name" : "href",
+ "name" : "indicatorpos",
"type" : "String",
- "desc" : "the link",
+ "desc" : "t) default left",
"memberOf" : ""
},
{
- "name" : "html",
- "type" : "String",
- "desc" : "text",
+ "name" : "inline",
+ "type" : "Boolean",
+ "desc" : "e) inline the element (default true)",
"memberOf" : ""
},
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "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" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "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" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "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"
},
+ {
+ "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" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "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" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "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" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "placeholder",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "preventDefault",
+ "name" : "preventMark",
"type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : ""
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "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" : "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" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "style",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.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" : "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" : "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" : "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" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "s) The text that appears beside the radio",
+ "memberOf" : ""
+ },
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
],
"returns" : []
},
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "check",
+ "type" : "function",
+ "desc" : "Fires when the element is checked or unchecked.",
+ "sig" : "function (_self, item)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.RadioSet",
+ "desc" : "This radio",
+ "isOptional" : false
+ },
+ {
+ "name" : "item",
+ "type" : "Roo.bootstrap.Radio",
+ "desc" : "The checked item",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
{
"name" : "click",
"type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
+ "desc" : "Fires when the element is click.",
+ "sig" : "function (_self, item, e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.RadioSet",
+ "desc" : "This radio set",
+ "isOptional" : false
+ },
+ {
+ "name" : "item",
+ "type" : "Roo.bootstrap.Radio",
+ "desc" : "The checked item",
+ "isOptional" : false
+ },
{
"name" : "e",
"type" : "Roo.EventObject",
- "desc" : "",
+ "desc" : "The event object",
"isOptional" : false
}
],
],
"returns" : []
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "paste",
+ "type" : "function",
+ "desc" : "Fires after the user pastes into input",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "name The name field"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
]
},
- "Roo.bootstrap.PagingToolbar" : {
+ "Roo.bootstrap.Row" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) alignment",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "arrangement",
- "type" : "Boolean",
- "desc" : "stacked | justified",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "css class",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "container The id or element that will contain the toolbar",
- "memberOf" : ""
- },
{
"name" : "container_method",
"type" : "string",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "dataSource",
- "type" : "Roo.data.Store",
- "desc" : "The underlying data store providing the paged data",
- "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" : "displayInfo",
- "type" : "Boolean",
- "desc" : "True to display the displayMsg (defaults to false)",
- "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" : "hideMode",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
- {
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "is inverted color",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
{
"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" : "loadMask",
- "type" : "Boolean",
- "desc" : "e) loadMask on the bar",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
- {
- "name" : "main",
- "type" : "Boolean",
- "desc" : "e) main nav bar? default false",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "pageSize",
- "type" : "Number",
- "desc" : "The number of records to display per page (defaults to 20)",
- "memberOf" : ""
- },
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "tag",
- "type" : "String",
- "desc" : "v) default is nav",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "type",
- "type" : "String",
- "desc" : "s)",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
{
"name" : "visibilityEl",
"type" : "string|object",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "weight",
- "type" : "String",
- "desc" : "e) default is light.",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
{
"name" : "xattr",
"type" : "Object",
],
"returns" : []
},
- {
- "name" : "beforetoggle",
- "type" : "function",
- "desc" : "Fire before toggle the menu",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Navbar",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "bind",
- "type" : "function",
- "desc" : "Binds the paging toolbar to the specified {@link Roo.data.Store}",
- "sig" : "(store)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to bind",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Collapse the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Navbar",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expand the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Navbar",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "fireEvent",
"type" : "function",
"returns" : []
},
{
- "name" : "render",
- "type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setDisabled",
- "type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setVisibilityEl",
- "type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
- },
- {
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "unbind",
+ "name" : "render",
"type" : "function",
- "desc" : "Unbinds the paging toolbar from the specified {@link Roo.data.Store}",
- "sig" : "(store)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to unbind",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setVisibilityEl",
+ "type" : "function",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
+ }
+ ]
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
}
]
},
- "Roo.bootstrap.PhoneInput" : {
+ "Roo.bootstrap.SecurePass" : {
"props" : [
{
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "Label",
+ "type" : "String/Object",
+ "desc" : "for the strength meter (defaults to\n'Password strength:')",
+ "memberOf" : ""
},
{
"name" : "accept",
"desc" : "- input group add on after",
"memberOf" : "Roo.bootstrap.Input"
},
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "align",
"type" : "String",
"desc" : "a) use for file input only. (default empty)",
"memberOf" : "Roo.bootstrap.Input"
},
- {
- "name" : "caret",
- "type" : "String",
- "desc" : "r) BS3 only - carat fa name",
- "memberOf" : "Roo.bootstrap.TriggerField"
- },
{
"name" : "cls",
"type" : "String",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "defaultDialCode",
- "type" : "String",
- "desc" : "default '+852'",
- "memberOf" : ""
- },
{
"name" : "disableClass",
"type" : "String",
"desc" : "is it disabled",
"memberOf" : "Roo.bootstrap.Input"
},
+ {
+ "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" : "fieldLabel",
"type" : "string",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
- {
- "name" : "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" : "indicatorpos",
"type" : "String",
"desc" : "t) default left",
"memberOf" : "Roo.bootstrap.Input"
},
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "invalidClass",
"type" : "String",
"desc" : "- placeholder to put in text.",
"memberOf" : "Roo.bootstrap.Input"
},
- {
- "name" : "preferedCountries",
- "type" : "Array",
- "desc" : "default []",
- "memberOf" : ""
- },
{
"name" : "preventMark",
"type" : "Boolean",
"desc" : "Do not show tick or cross if error/success",
"memberOf" : "Roo.bootstrap.Input"
},
+ {
+ "name" : "pwdStrengths",
+ "type" : "String/Object",
+ "desc" : "A pwdStrengths spec, or true for a default spec (defaults to\n['Weak', 'Medium', 'Strong'])",
+ "memberOf" : ""
+ },
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "-- Depricated - use Invalid Text",
"memberOf" : "Roo.bootstrap.Input"
},
- {
- "name" : "removable",
- "type" : "Boolean",
- "desc" : "e) special filter default false",
- "memberOf" : "Roo.bootstrap.TriggerField"
- },
{
"name" : "selectOnFocus",
"type" : "Boolean",
"desc" : "colspan out of 12 for tablet-sized screens",
"memberOf" : "Roo.bootstrap.Input"
},
- {
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "[required] The data store to which this combo is bound (defaults to undefined)",
- "memberOf" : ""
- },
{
"name" : "style",
"type" : "String",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.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" : "validClass",
"type" : "String",
],
"returns" : []
},
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "onTriggerClick",
- "type" : "function",
- "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "purgeListeners",
"type" : "function",
}
]
},
- "Roo.bootstrap.Popover" : {
+ "Roo.bootstrap.Slider" : {
"props" : [
- {
- "name" : "(right|top|bottom|left|auto)",
- "type" : "String|function",
- "desc" : "placement how it is placed",
- "memberOf" : ""
- },
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "add",
- "type" : "String|Boolean|Roo.Element",
- "desc" : "click hander to trigger show over what element\n - if false and it has a 'parent' then it will be automatically added to that element\n - if string - Roo.get will be called",
- "memberOf" : ""
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "delay",
- "type" : "Number",
- "desc" : "- delay before showing",
- "memberOf" : ""
- },
{
"name" : "disableClass",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
- {
- "name" : "html",
- "type" : "String",
- "desc" : "contents of the popover (or false to use children..)",
- "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" : "modal",
- "type" : "Boolean",
- "desc" : "- popovers that are modal will mask the screen, and must be closed with another event.",
- "memberOf" : ""
- },
{
"name" : "name",
"type" : "string",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "title",
- "type" : "String",
- "desc" : "of popover (or false to hide)",
- "memberOf" : ""
- },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "trigger",
- "type" : "String",
- "desc" : "click || hover (or false to trigger manually)",
- "memberOf" : ""
- },
{
"name" : "visibilityEl",
"type" : "string|object",
{
"name" : "hide",
"type" : "function",
- "desc" : "After the popover hide",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Popover",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
{
"name" : "show",
"type" : "function",
- "desc" : "After the popover show",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Popover",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "setContent",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "",
- "sig" : "(the)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "the",
- "type" : "string",
- "desc" : "body content",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
"memberOf" : "Roo.Component",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
+ "name" : "visible",
"type" : "Boolean",
- "desc" : "",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "setTitle",
+ "name" : "tooltipEl",
"type" : "function",
- "desc" : "",
- "sig" : "(the)",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
"static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
+ }
+ ]
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ]
+ },
+ "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",
+ "type" : "function",
+ "desc" : "Fires before the splitter is dragged",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.SplitBar",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "moved",
+ "type" : "function",
+ "desc" : "Fires when the splitter is moved",
+ "sig" : "function (_self, newSize)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.SplitBar",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "the new width or height",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "resize",
+ "type" : "function",
+ "desc" : "Fires when the splitter is moved (alias for {@link #event-moved})",
+ "sig" : "function (_self, newSize)\n{\n\n}",
"memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.SplitBar",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "the new width or height",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "the",
- "type" : "string",
- "desc" : "title",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setVisibilityEl",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "capture",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Destroy this splitbar.",
+ "sig" : "(removeEl)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
+ "name" : "removeEl",
"type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "desc" : "True to remove the element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "fireEvent",
+ "type" : "function",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "show",
+ "name" : "getAdapter",
"type" : "function",
- "desc" : "Show the popover",
- "sig" : "(-, (left|right|top|bottom))",
+ "desc" : "Get the adapter this SplitBar uses",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "",
+ "desc" : "The adapter object"
+ }
+ ]
+ },
+ {
+ "name" : "getMaximumSize",
+ "type" : "function",
+ "desc" : "Gets the maximum size for the resizing element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The maximum size"
+ }
+ ]
+ },
+ {
+ "name" : "getMinimumSize",
+ "type" : "function",
+ "desc" : "Gets the minimum size for the resizing element",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The minimum size"
+ }
+ ]
+ },
+ {
+ "name" : "hasListener",
+ "type" : "function",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "-",
- "type" : "Roo.Element|string|Boolean",
- "desc" : "element to align and point to. (set align to [ pos, offset ])",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
+ },
+ {
+ "name" : "on",
+ "type" : "function",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "(left|right|top|bottom)",
- "type" : "string",
- "desc" : "position",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "tooltipEl",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setAdapter",
+ "type" : "function",
+ "desc" : "Set the adapter this SplitBar uses",
+ "sig" : "(adapter)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "adapter",
+ "type" : "Object",
+ "desc" : "A SplitBar adapter object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setCurrentSize",
+ "type" : "function",
+ "desc" : "Sets the initialize size for the resizing element",
+ "sig" : "(size)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "size",
+ "type" : "Number",
+ "desc" : "The initial size",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setMaximumSize",
+ "type" : "function",
+ "desc" : "Sets the maximum size for the resizing element",
+ "sig" : "(maxSize)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "maxSize",
+ "type" : "Number",
+ "desc" : "The maximum size",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setMinimumSize",
+ "type" : "function",
+ "desc" : "Sets the minimum size for the resizing element",
+ "sig" : "(minSize)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "minSize",
+ "type" : "Number",
+ "desc" : "The minimum size",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
"name" : "un",
}
],
"returns" : []
+ }
+ ]
+ },
+ "Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "getElementSize",
+ "type" : "function",
+ "desc" : "Called before drag operations to get the current size of the resizing element.",
+ "sig" : "(s)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "s",
+ "type" : "Roo.bootstrap.SplitBar",
+ "desc" : "The SplitBar using this adapter",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "updatePosition",
+ "name" : "setElementSize",
"type" : "function",
- "desc" : "fire this manually after loading a grid in the table for example",
- "sig" : "((left|right|top|bottom), try)",
+ "desc" : "Called after drag operations to set the size of the resizing element.",
+ "sig" : "(s, newSize, onComplete)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "s",
+ "type" : "Roo.bootstrap.SplitBar",
+ "desc" : "The SplitBar using this adapter",
+ "isOptional" : false
+ },
+ {
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new size to set",
+ "isOptional" : false
+ },
+ {
+ "name" : "onComplete",
+ "type" : "Function",
+ "desc" : "A function to be invoked when resizing is complete",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ]
+ },
+ "Roo.bootstrap.SplitBar.BasicLayoutAdapter" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "getElementSize",
+ "type" : "function",
+ "desc" : "Called before drag operations to get the current size of the resizing element.",
+ "sig" : "(s)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "(left|right|top|bottom)",
- "type" : "string",
- "desc" : "where to try and put it (use false to use the last one)",
+ "name" : "s",
+ "type" : "Roo.bootstrap.SplitBar",
+ "desc" : "The SplitBar using this adapter",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setElementSize",
+ "type" : "function",
+ "desc" : "Called after drag operations to set the size of the resizing element.",
+ "sig" : "(s, newSize, onComplete)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "s",
+ "type" : "Roo.bootstrap.SplitBar",
+ "desc" : "The SplitBar using this adapter",
"isOptional" : false
},
{
- "name" : "try",
- "type" : "Boolean",
- "desc" : "and move it if we cant get right position.",
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new size to set",
+ "isOptional" : false
+ },
+ {
+ "name" : "onComplete",
+ "type" : "Function",
+ "desc" : "A function to be invoked when resizing is complete",
"isOptional" : false
}
],
}
]
},
- "Roo.bootstrap.PopoverNav" : {
+ "Roo.bootstrap.TabGroup" : {
"props" : [
{
"name" : "actionMode",
"memberOf" : "Roo.Component"
},
{
- "name" : "align",
+ "name" : "alert",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.NavGroup"
+ "desc" : "r) type alert (changes background / border...)",
+ "memberOf" : "Roo.bootstrap.Column"
},
{
"name" : "allowDomMove",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "autoslide",
+ "type" : "Boolean",
+ "desc" : "e) auto slide .. default false",
+ "memberOf" : ""
+ },
+ {
+ "name" : "bullets",
+ "type" : "Boolean",
+ "desc" : "show bullets for the panels",
+ "memberOf" : ""
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "carousel",
+ "type" : "Boolean",
+ "desc" : "true to make the group behave like a carousel",
+ "memberOf" : ""
+ },
{
"name" : "cls",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "fa",
+ "type" : "String",
+ "desc" : ".) font awesome icon",
+ "memberOf" : "Roo.bootstrap.Column"
+ },
+ {
+ "name" : "fasize",
+ "type" : "Number",
+ "desc" : ".) font awsome size",
+ "memberOf" : "Roo.bootstrap.Column"
+ },
+ {
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "e) hide the element",
+ "memberOf" : "Roo.bootstrap.Column"
+ },
{
"name" : "hideMode",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.NavGroup"
+ "name" : "html",
+ "type" : "String",
+ "desc" : "content of column.",
+ "memberOf" : "Roo.bootstrap.Column"
+ },
+ {
+ "name" : "icon",
+ "type" : "String",
+ "desc" : ".) glyphicon name",
+ "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" : "lgoff",
+ "type" : "Number",
+ "desc" : "colspan offset out of 12 for large computer-sized screens or 0 for hidden",
+ "memberOf" : "Roo.bootstrap.Column"
},
{
"name" : "listeners",
"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" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-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" : "name",
"type" : "string",
{
"name" : "navId",
"type" : "String",
- "desc" : "- reference Id for navbar.",
- "memberOf" : "Roo.bootstrap.NavGroup"
+ "desc" : "the navigation id (for use with navbars) - will be auto generated if it does not exist..",
+ "memberOf" : ""
},
{
- "name" : "pilltype",
+ "name" : "showarrow",
"type" : "Boolean",
- "desc" : "default true (turn to off to disable active toggle)",
- "memberOf" : "Roo.bootstrap.NavGroup"
+ "desc" : "e) show arrow default true",
+ "memberOf" : ""
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-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" : "style",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "timer",
+ "type" : "Number",
+ "desc" : "auto slide timer .. default 0 millisecond",
+ "memberOf" : ""
+ },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "type",
- "type" : "String",
- "desc" : "b) default nav",
- "memberOf" : "Roo.bootstrap.NavGroup"
- },
{
"name" : "visibilityEl",
"type" : "string|object",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-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"
}
],
"events" : [
],
"returns" : []
},
- {
- "name" : "changed",
- "type" : "function",
- "desc" : "Fires when the active item changes",
- "sig" : "function (_self, selected, prev)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.NavGroup",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.NavGroup",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "selected",
- "type" : "Roo.bootstrap.Navbar.Item",
- "desc" : "The item selected",
- "isOptional" : false
- },
- {
- "name" : "prev",
- "type" : "Roo.bootstrap.Navbar.Item",
- "desc" : "The previously selected item",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "addItem",
- "type" : "function",
- "desc" : "adds a Navigation item",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.NavGroup",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.NavItem",
- "desc" : "navitem to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "addListener",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "clearAll",
- "type" : "function",
- "desc" : "clear all the Navigation item",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.NavGroup",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
{
"name" : "get",
"type" : "function",
- "desc" : "fetch a Navigation Group based on the navigation ID",
+ "desc" : "fetch a Navigation Group based on the navigation ID\nif one does not exist , it will get created.",
"sig" : "(the)",
"static" : true,
- "memberOf" : "Roo.bootstrap.NavGroup",
+ "memberOf" : "",
"isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
},
- {
- "name" : "getActive",
- "type" : "function",
- "desc" : "gets the active Navigation item",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.NavGroup",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.bootstrap.NavItem",
- "desc" : "the current navitem"
- }
- ]
- },
{
"name" : "getChildContainer",
"type" : "function",
"desc" : "register a Navigation item",
"sig" : "(the)",
"static" : false,
- "memberOf" : "Roo.bootstrap.NavGroup",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [
{
"name" : "the",
- "type" : "Roo.bootstrap.NavItem",
+ "type" : "Roo.bootstrap.nav.Item",
"desc" : "navitem to add",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "register",
+ "type" : "function",
+ "desc" : "register a Navigation Group",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "Roo.bootstrap.nav.Group",
+ "desc" : "navgroup to add",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "releaseCapture",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setActiveItem",
- "type" : "function",
- "desc" : "sets the active Navigation item",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.NavGroup",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.NavItem",
- "desc" : "new current navitem",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "showPanel",
+ "type" : "function",
+ "desc" : "show a specific panel",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Roo.bootstrap.TabPanel|number|string",
+ "desc" : "to change to (use the tabId to specify a specific one)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "boolean",
+ "desc" : "false if panel was not shown (invalid entry or beforedeactivate fails.)"
+ }
+ ]
+ },
{
"name" : "tooltipEl",
"type" : "function",
}
]
},
- "Roo.bootstrap.Progress" : {
+ "Roo.bootstrap.TabPanel" : {
"props" : [
{
"name" : "actionMode",
{
"name" : "active",
"type" : "Boolean",
- "desc" : "animated of the progress bar",
+ "desc" : "panel active",
"memberOf" : ""
},
{
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "href",
+ "type" : "String",
+ "desc" : "click to link..",
+ "memberOf" : ""
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "panel content",
+ "memberOf" : ""
+ },
{
"name" : "listeners",
"type" : "Object",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "striped",
- "type" : "Boolean",
- "desc" : "striped of the progress bar",
+ "name" : "navId",
+ "type" : "String",
+ "desc" : "The Roo.bootstrap.nav.Group which triggers show hide ()",
"memberOf" : ""
},
{
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "tabId",
+ "type" : "String",
+ "desc" : "unique tab ID (will be autogenerated if not set. - used to match TabItem to Panel)",
+ "memberOf" : ""
+ },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "touchSlide",
+ "type" : "Boolean",
+ "desc" : "if swiping slides tab to next panel (default off)",
+ "memberOf" : ""
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
}
],
"events" : [
+ {
+ "name" : "beforedeactivate",
+ "type" : "function",
+ "desc" : "Fires before a tab is de-activated - can be used to do validation on a form.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.TabPanel",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "false if there is an error"
+ }
+ ]
+ },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "changed",
+ "type" : "function",
+ "desc" : "Fires when the active status changes",
+ "sig" : "function (_self, state)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.TabPanel",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "the new state",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
}
]
},
- "Roo.bootstrap.ProgressBar" : {
+ "Roo.bootstrap.Table" : {
"props" : [
{
"name" : "actionMode",
"memberOf" : "Roo.Component"
},
{
- "name" : "aria_valuemax",
- "type" : "Number",
- "desc" : "aria-value max",
- "memberOf" : ""
- },
- {
- "name" : "aria_valuemin",
- "type" : "Number",
- "desc" : "aria-value min",
+ "name" : "auto_hide_footer",
+ "type" : "Boolean",
+ "desc" : "auto hide footer if only one page (default false)",
"memberOf" : ""
},
{
- "name" : "aria_valuenow",
- "type" : "Number",
- "desc" : "aria-value now",
+ "name" : "bordered",
+ "type" : "boolean",
+ "desc" : "Add borders to the table",
"memberOf" : ""
},
{
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "cellSelection",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : ""
+ },
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "table class",
+ "memberOf" : ""
+ },
+ {
+ "name" : "cm[]",
+ "type" : "Roo.grid.ColumnModel",
+ "desc" : "A column for the grid.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "condensed",
+ "type" : "boolean",
+ "desc" : "Format condensed",
+ "memberOf" : ""
},
{
"name" : "container_method",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "enableColumnResize",
+ "type" : "Boolean",
+ "desc" : "default true if columns can be resized (drag/drop)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "footer",
+ "type" : "Roo.bootstrap.PagingToolbar",
+ "desc" : "a paging toolbar",
+ "memberOf" : ""
+ },
+ {
+ "name" : "footerShow",
+ "type" : "Boolean",
+ "desc" : "e) generate tfoot, default true",
+ "memberOf" : ""
+ },
+ {
+ "name" : "headerShow",
+ "type" : "Boolean",
+ "desc" : "e) generate thead, default true",
+ "memberOf" : ""
+ },
{
"name" : "hideMode",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "label",
- "type" : "String",
- "desc" : "label for the progress bar",
+ "name" : "hover",
+ "type" : "boolean",
+ "desc" : "Add hover highlighting",
+ "memberOf" : ""
+ },
+ {
+ "name" : "lazyLoad",
+ "type" : "Boolean",
+ "desc" : "auto load data while scrolling to the end (default false)",
"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"
},
+ {
+ "name" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : ""
+ },
+ {
+ "name" : "minColumnWidth",
+ "type" : "Number",
+ "desc" : "default 50 pixels minimum column width",
+ "memberOf" : ""
+ },
{
"name" : "name",
"type" : "string",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "panel",
- "type" : "String",
- "desc" : ")",
+ "name" : "responsive",
+ "type" : "boolean",
+ "desc" : "default false - if this is on, columns are rendered with col-xs-4 etc. classes, otherwise columns will be sized by CSS,\n also adds table-responsive (see bootstrap docs for details)",
"memberOf" : ""
},
{
- "name" : "role",
- "type" : "String",
- "desc" : "role of the progress bar",
+ "name" : "rowSelection",
+ "type" : "Boolean",
+ "desc" : "e) default false",
"memberOf" : ""
},
{
- "name" : "sr_only",
- "type" : "String",
- "desc" : "text",
+ "name" : "scrollBody",
+ "type" : "Boolean",
+ "desc" : "e) default false - body scrolled / fixed header",
+ "memberOf" : ""
+ },
+ {
+ "name" : "sm",
+ "type" : "Roo.grid.AbstractSelectionModel",
+ "desc" : "The selection model to use (cell selection is not supported yet)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to use",
+ "memberOf" : ""
+ },
+ {
+ "name" : "striped",
+ "type" : "boolean",
+ "desc" : "Should the rows be alternative striped",
"memberOf" : ""
},
{
],
"returns" : []
},
+ {
+ "name" : "cellclick",
+ "type" : "function",
+ "desc" : "Fires when a cell is clicked",
+ "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "el",
+ "type" : "Roo.Element",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "cellcontextmenu",
+ "type" : "function",
+ "desc" : "Fires when a cell is right clicked",
+ "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "cellIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "celldblclick",
+ "type" : "function",
+ "desc" : "Fires when a cell is double clicked",
+ "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "el",
+ "type" : "Roo.Element",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "contextmenu",
+ "type" : "function",
+ "desc" : "The raw contextmenu event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "headercontextmenu",
+ "type" : "function",
+ "desc" : "Fires when a header is right clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "mousedown",
+ "type" : "function",
+ "desc" : "The raw mousedown event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "mouseout",
+ "type" : "function",
+ "desc" : "Fires when a mouseout occur",
+ "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "el",
+ "type" : "Roo.Element",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "mouseover",
+ "type" : "function",
+ "desc" : "Fires when a mouseover occur",
+ "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "el",
+ "type" : "Roo.Element",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "rowclass",
+ "type" : "function",
+ "desc" : "Fires when a row is rendered, so you can change add a style to it.",
+ "sig" : "function (_self, rowcfg)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowcfg",
+ "type" : "Object",
+ "desc" : "contains record rowIndex colIndex and rowClass - set rowClass to add a style.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "rowclick",
+ "type" : "function",
+ "desc" : "Fires when a row is clicked",
+ "sig" : "function (_self, el, rowIndex, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "el",
+ "type" : "Roo.Element",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "rowcontextmenu",
+ "type" : "function",
+ "desc" : "Fires when a row is right clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "rowdblclick",
+ "type" : "function",
+ "desc" : "Fires when a row is double clicked",
+ "sig" : "function (_self, el, rowIndex, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "el",
+ "type" : "Roo.Element",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "rowsrendered",
+ "type" : "function",
+ "desc" : "Fires when all the rows have been rendered",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "Forces a resize - used by panel.Grid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Element",
+ "desc" : "The element"
+ }
+ ]
+ },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "clear",
+ "type" : "function",
+ "desc" : "Remove all rows",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "ensureVisible",
+ "type" : "function",
+ "desc" : "Scrolls the specified cell into view",
+ "sig" : "(row, col, hscroll)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "row",
+ "type" : "Number",
+ "desc" : "The row index",
+ "isOptional" : false
+ },
+ {
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ },
+ {
+ "name" : "hscroll",
+ "type" : "Boolean",
+ "desc" : "false to disable horizontal scrolling",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
}
]
},
+ {
+ "name" : "focusCell",
+ "type" : "function",
+ "desc" : "Focuses the specified cell.",
+ "sig" : "(row, col, hscroll)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "row",
+ "type" : "Number",
+ "desc" : "The row index",
+ "isOptional" : false
+ },
+ {
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ },
+ {
+ "name" : "hscroll",
+ "type" : "Boolean",
+ "desc" : "false to disable horizontal scrolling",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "focusRow",
+ "type" : "function",
+ "desc" : "Focuses the specified row.",
+ "sig" : "(row)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "row",
+ "type" : "Number",
+ "desc" : "The row index",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "getCellIndex",
+ "type" : "function",
+ "desc" : "get the Column Index from a dom element. (using regex on x-hcol-{colid})",
+ "sig" : "(cell)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "cell",
+ "type" : "domElement",
+ "desc" : "to look for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
}
]
},
+ {
+ "name" : "getGridEl",
+ "type" : "function",
+ "desc" : "Returns the grid's underlying element = used by panel.Grid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Element",
+ "desc" : "The element"
+ }
+ ]
+ },
+ {
+ "name" : "getHeaderIndex",
+ "type" : "function",
+ "desc" : "get the header TH element for columnIndex",
+ "sig" : "(columnIndex)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "getId",
"type" : "function",
}
]
},
+ {
+ "name" : "getRowIndex",
+ "type" : "function",
+ "desc" : "get the Row Index from a dom element.",
+ "sig" : "(row)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "row",
+ "type" : "Roo.Element",
+ "desc" : "The row to look for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setRowVisibility",
+ "type" : "function",
+ "desc" : "Show or hide a row.",
+ "sig" : "(rowIndex, state)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "to show or hide",
+ "isOptional" : false
+ },
+ {
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "hide",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
}
]
},
- "Roo.bootstrap.Radio" : {
+ "Roo.bootstrap.TableBody" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "Aligns the content inside the element",
+ "memberOf" : ""
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "boxLabel",
- "type" : "String",
- "desc" : "- the label associated",
- "memberOf" : ""
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "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" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "element class",
+ "memberOf" : ""
},
{
"name" : "container_method",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "element tag (thead|tbody|tfoot) default tbody",
+ "memberOf" : ""
+ },
{
"name" : "tooltip",
"type" : "string",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "value",
+ "name" : "valign",
"type" : "String",
- "desc" : "- the value of radio",
+ "desc" : "Vertical aligns the content inside the <tbody> element",
"memberOf" : ""
},
{
}
]
},
- "Roo.bootstrap.RadioSet" : {
+ "Roo.bootstrap.TableCell" : {
"props" : [
{
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "accept",
+ "name" : "abbr",
"type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Specifies an abbreviated version of the content in a cell",
+ "memberOf" : ""
},
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "align",
"type" : "String",
- "desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Aligns the content in a cell",
+ "memberOf" : ""
},
{
"name" : "allowDomMove",
"memberOf" : "Roo.Component"
},
{
- "name" : "autocomplete",
+ "name" : "axis",
"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" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Categorizes cells",
+ "memberOf" : ""
},
{
- "name" : "blankText",
+ "name" : "bgcolor",
"type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Specifies the background color of a cell",
+ "memberOf" : ""
},
{
"name" : "can_build_overlaid",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "capture",
- "type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "charoff",
+ "type" : "Number",
+ "desc" : "Sets the number of characters the content will be aligned from the character specified by the char attribute",
+ "memberOf" : ""
},
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "cell class",
+ "memberOf" : ""
+ },
+ {
+ "name" : "colspan",
+ "type" : "Number",
+ "desc" : "Specifies the number of columns a cell should span",
+ "memberOf" : ""
},
{
"name" : "container_method",
"memberOf" : "Roo.Component"
},
{
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "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" : "focusClass",
+ "name" : "headers",
"type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Specifies one or more header cells a cell is related to",
+ "memberOf" : ""
},
{
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "Sets the height of a cell",
+ "memberOf" : ""
},
{
"name" : "hideMode",
"memberOf" : "Roo.Component"
},
{
- "name" : "indicatorpos",
+ "name" : "html",
"type" : "String",
- "desc" : "t) default left",
- "memberOf" : ""
- },
- {
- "name" : "inline",
- "type" : "Boolean",
- "desc" : "e) inline the element (default true)",
+ "desc" : "cell contain text",
"memberOf" : ""
},
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "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" : "labelAlign",
- "type" : "String",
- "desc" : "t)",
- "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" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "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"
},
- {
- "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" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "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" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "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" : "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" : "preventMark",
- "type" : "Boolean",
- "desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "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" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "regexText",
+ "name" : "nowrap",
"type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "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"
+ "desc" : "Specifies that the content inside a cell should not wrap",
+ "memberOf" : ""
},
{
- "name" : "size",
- "type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "rowspan",
+ "type" : "Number",
+ "desc" : "Sets the number of rows a cell should span",
+ "memberOf" : ""
},
{
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "scope",
+ "type" : "String",
+ "desc" : "Defines a way to associate header cells and data cells in a table",
+ "memberOf" : ""
},
{
"name" : "style",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "cell tag (td|th) default td",
+ "memberOf" : ""
+ },
{
"name" : "tooltip",
"type" : "string",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validFeedbackIcon",
+ "name" : "valign",
"type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "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" : "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" : "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" : "value",
- "type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Vertical aligns the content in a cell",
+ "memberOf" : ""
},
{
"name" : "visibilityEl",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "weight",
- "type" : "String",
- "desc" : "s) The text that appears beside the radio",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "Specifies the width of a cell",
"memberOf" : ""
},
{
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
],
"returns" : []
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "check",
- "type" : "function",
- "desc" : "Fires when the element is checked or unchecked.",
- "sig" : "function (_self, item)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.RadioSet",
- "desc" : "This radio",
- "isOptional" : false
- },
- {
- "name" : "item",
- "type" : "Roo.bootstrap.Radio",
- "desc" : "The checked item",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "Fires when the element is click.",
- "sig" : "function (_self, item, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.RadioSet",
- "desc" : "This radio set",
- "isOptional" : false
- },
- {
- "name" : "item",
- "type" : "Roo.bootstrap.Radio",
- "desc" : "The checked item",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "paste",
- "type" : "function",
- "desc" : "Fires after the user pastes into input",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"methods" : [
],
"returns" : []
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "name The name field"
- }
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
"returns" : []
},
{
- "name" : "render",
- "type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "setDisabled",
- "type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setVisibilityEl",
- "type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
- },
- {
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "validate",
+ "name" : "render",
"type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "disabled",
"type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "validateValue",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
+ }
+ ]
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
]
},
- "Roo.bootstrap.Row" : {
+ "Roo.bootstrap.TableRow" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "Aligns the content in a table row",
+ "memberOf" : ""
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "bgcolor",
+ "type" : "String",
+ "desc" : "Specifies a background color for a table row",
+ "memberOf" : ""
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "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" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "row class",
+ "memberOf" : ""
},
{
"name" : "container_method",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "valign",
+ "type" : "String",
+ "desc" : "Vertical aligns the content in a table row",
+ "memberOf" : ""
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
}
]
},
- "Roo.bootstrap.SecurePass" : {
+ "Roo.bootstrap.TextArea" : {
"props" : [
- {
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "Label",
- "type" : "String/Object",
- "desc" : "for the strength meter (defaults to\n'Password strength:')",
- "memberOf" : ""
- },
{
"name" : "accept",
"type" : "String",
"desc" : "- input group add on after",
"memberOf" : "Roo.bootstrap.Input"
},
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "align",
"type" : "String",
"desc" : "css class",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "cols",
+ "type" : "Number",
+ "desc" : "Specifies the visible width of a text area",
+ "memberOf" : ""
+ },
{
"name" : "container_method",
"type" : "string",
"desc" : "is it disabled",
"memberOf" : "Roo.bootstrap.Input"
},
- {
- "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" : "fieldLabel",
"type" : "string",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "html",
+ "type" : "string",
+ "desc" : "text",
+ "memberOf" : ""
+ },
{
"name" : "indicatorpos",
"type" : "String",
"desc" : "t) default left",
"memberOf" : "Roo.bootstrap.Input"
},
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "invalidClass",
"type" : "String",
"desc" : "Do not show tick or cross if error/success",
"memberOf" : "Roo.bootstrap.Input"
},
- {
- "name" : "pwdStrengths",
- "type" : "String/Object",
- "desc" : "A pwdStrengths spec, or true for a default spec (defaults to\n['Weak', 'Medium', 'Strong'])",
- "memberOf" : ""
- },
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "-- Depricated - use Invalid Text",
"memberOf" : "Roo.bootstrap.Input"
},
+ {
+ "name" : "resize",
+ "type" : "string",
+ "desc" : "l)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "rows",
+ "type" : "Number",
+ "desc" : "Specifies the visible number of lines in a text area",
+ "memberOf" : ""
+ },
{
"name" : "selectOnFocus",
"type" : "Boolean",
"desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
"memberOf" : "Roo.bootstrap.Input"
},
+ {
+ "name" : "wrap",
+ "type" : "string",
+ "desc" : "d)Specifies how the text in a text area is to be wrapped when submitted in a form",
+ "memberOf" : ""
+ },
{
"name" : "xattr",
"type" : "Object",
"desc" : "Clear any invalid styles/messages for this field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "inputEl",
"type" : "function",
- "desc" : "return the real input element.",
+ "desc" : "return the real textarea element.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Mark this field as invalid",
"sig" : "(msg)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Mark this field as valid",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
- "Roo.bootstrap.Slider" : {
+ "Roo.bootstrap.TimeField" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default left",
+ "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" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "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" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "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" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "cls",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "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" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "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" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "hideMode",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "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" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "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" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "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"
},
+ {
+ "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" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "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" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "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" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "placeholder",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "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" : "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" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "style",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.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" : "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" : "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" : "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" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "blur",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
+ "desc" : "Fires when this field loses input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "change",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
+ "desc" : "Fires when the children have been rendered..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "enable",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
+ "desc" : "Fires after the component is destroyed.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "hide",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires after the component is disabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "render",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
+ "desc" : "Fires after the component is enabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "show",
+ "name" : "focus",
"type" : "function",
- "desc" : "Fires after the component is shown.",
+ "desc" : "Fires when this field receives input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "addEvents",
+ "name" : "hide",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "invalid",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "keyup",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "fireEvent",
+ "name" : "paste",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the user pastes into input",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
+ "name" : "this",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
},
{
- "name" : "focus",
+ "name" : "render",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "getChildContainer",
- "type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
+ "returns" : []
},
{
- "name" : "getEl",
+ "name" : "select",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when select a date.",
+ "sig" : "function (_self, date)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
- }
- ]
- },
- {
- "name" : "getId",
- "type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "name" : "this",
+ "type" : "Roo.bootstrap.DateField",
+ "desc" : "",
+ "isOptional" : false
+ },
{
- "name" : "",
- "type" : "String",
- "desc" : ""
+ "name" : "date",
+ "type" : "Mixed",
+ "desc" : "The date value",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "getVisibilityEl",
- "type" : "function",
- "desc" : "Get the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ ],
"returns" : []
},
{
- "name" : "hasListener",
+ "name" : "show",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when this field show.",
+ "sig" : "function (thisthis, date)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "thisthis",
+ "type" : "Roo.bootstrap.DateField",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "name" : "date",
+ "type" : "Mixed",
+ "desc" : "The date value",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "initEvents",
- "type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ ],
"returns" : []
},
{
- "name" : "on",
+ "name" : "specialkey",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "valid",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "releaseCapture",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
"memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "capture",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "clearInvalid",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setVisibilityEl",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Set the element that will be used to show or hide",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "disable",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
]
},
{
- "name" : "show",
+ "name" : "enable",
"type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
+ "desc" : "Enable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "tooltipEl",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "un",
+ "name" : "focus",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
"isOptional" : false
}
],
- "returns" : []
- }
- ]
- },
- "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" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
{
- "name" : "beforeresize",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Fires before the splitter is dragged",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fetch the element to add children to",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.SplitBar",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "moved",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Fires when the splitter is moved",
- "sig" : "function (_self, newSize)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.SplitBar",
- "desc" : "",
- "isOptional" : false
- },
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "the new width or height",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "resize",
+ "name" : "getId",
"type" : "function",
- "desc" : "Fires when the splitter is moved (alias for {@link #event-moved})",
- "sig" : "function (_self, newSize)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.SplitBar",
- "desc" : "",
- "isOptional" : false
- },
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "the new width or height",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
}
- ],
- "returns" : []
- }
- ],
- "methods" : [
+ ]
+ },
{
- "name" : "addEvents",
+ "name" : "getName",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.bootstrap.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "name The name field"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "addListener",
+ "name" : "getRawValue",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.bootstrap.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
- "isOptional" : false
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "capture",
+ "name" : "getValue",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "destroy",
+ "name" : "getVisibilityEl",
"type" : "function",
- "desc" : "Destroy this splitbar.",
- "sig" : "(removeEl)",
+ "desc" : "Get the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "removeEl",
- "type" : "Boolean",
- "desc" : "True to remove the element",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "getAdapter",
+ "name" : "hide",
"type" : "function",
- "desc" : "Get the adapter this SplitBar uses",
+ "desc" : "Hide a component - adds 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "",
- "desc" : "The adapter object"
- }
- ]
+ "returns" : []
},
{
- "name" : "getMaximumSize",
+ "name" : "initEvents",
"type" : "function",
- "desc" : "Gets the maximum size for the resizing element",
+ "desc" : "Initialize Events for the element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "The maximum size"
- }
- ]
+ "returns" : []
},
{
- "name" : "getMinimumSize",
+ "name" : "inputEl",
"type" : "function",
- "desc" : "Gets the minimum size for the resizing element",
+ "desc" : "return the real input element.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "The minimum size"
- }
- ]
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "msg",
"type" : "String",
- "desc" : "The name of the event to check for",
+ "desc" : "The validation message",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "returns" : []
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
"name" : "on",
"returns" : []
},
{
- "name" : "setAdapter",
+ "name" : "render",
"type" : "function",
- "desc" : "Set the adapter this SplitBar uses",
- "sig" : "(adapter)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "adapter",
- "type" : "Object",
- "desc" : "A SplitBar adapter object",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setCurrentSize",
+ "name" : "reset",
"type" : "function",
- "desc" : "Sets the initialize size for the resizing element",
- "sig" : "(size)",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "size",
- "type" : "Number",
- "desc" : "The initial size",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setMaximumSize",
+ "name" : "setRawValue",
"type" : "function",
- "desc" : "Sets the maximum size for the resizing element",
- "sig" : "(maxSize)",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "maxSize",
- "type" : "Number",
- "desc" : "The maximum size",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setMinimumSize",
+ "name" : "setValue",
"type" : "function",
- "desc" : "Sets the minimum size for the resizing element",
- "sig" : "(minSize)",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "minSize",
- "type" : "Number",
- "desc" : "The minimum size",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "un",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
- }
- ]
- },
- "Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "getElementSize",
+ "name" : "tooltipEl",
"type" : "function",
- "desc" : "Called before drag operations to get the current size of the resizing element.",
- "sig" : "(s)",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "s",
- "type" : "Roo.bootstrap.SplitBar",
- "desc" : "The SplitBar using this adapter",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setElementSize",
+ "name" : "un",
"type" : "function",
- "desc" : "Called after drag operations to set the size of the resizing element.",
- "sig" : "(s, newSize, onComplete)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "s",
- "type" : "Roo.bootstrap.SplitBar",
- "desc" : "The SplitBar using this adapter",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new size to set",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "onComplete",
- "type" : "Function",
- "desc" : "A function to be invoked when resizing is complete",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
- }
- ]
- },
- "Roo.bootstrap.SplitBar.BasicLayoutAdapter" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "getElementSize",
+ "name" : "validate",
"type" : "function",
- "desc" : "Called before drag operations to get the current size of the resizing element.",
- "sig" : "(s)",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "s",
- "type" : "Roo.bootstrap.SplitBar",
- "desc" : "The SplitBar using this adapter",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setElementSize",
+ "name" : "validateValue",
"type" : "function",
- "desc" : "Called after drag operations to set the size of the resizing element.",
- "sig" : "(s, newSize, onComplete)",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "s",
- "type" : "Roo.bootstrap.SplitBar",
- "desc" : "The SplitBar using this adapter",
- "isOptional" : false
- },
- {
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new size to set",
- "isOptional" : false
- },
- {
- "name" : "onComplete",
- "type" : "Function",
- "desc" : "A function to be invoked when resizing is complete",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
"isOptional" : false
}
],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ }
+ ]
+ },
+ "Roo.bootstrap.Tooltip" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "currentEl",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
}
]
},
- "Roo.bootstrap.TabGroup" : {
+ "Roo.bootstrap.TriggerField" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "actionMode",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "alert",
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "align",
"type" : "String",
- "desc" : "r) type alert (changes background / border...)",
- "memberOf" : "Roo.bootstrap.Column"
+ "desc" : "t) Default left",
+ "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" : "allowDomMove",
"memberOf" : "Roo.Component"
},
{
- "name" : "autoslide",
- "type" : "Boolean",
- "desc" : "e) auto slide .. default false",
- "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" : "Roo.bootstrap.Input"
},
{
- "name" : "bullets",
- "type" : "Boolean",
- "desc" : "show bullets for the panels",
- "memberOf" : ""
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "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" : "can_build_overlaid",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "carousel",
- "type" : "Boolean",
- "desc" : "true to make the group behave like a carousel",
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "caret",
+ "type" : "String",
+ "desc" : "r) BS3 only - carat fa name",
"memberOf" : ""
},
{
"memberOf" : "Roo.Component"
},
{
- "name" : "fa",
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "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" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "hideTrigger",
+ "type" : "Boolean",
+ "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "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" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "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" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "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"
+ },
+ {
+ "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" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "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" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "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" : "name",
"type" : "String",
- "desc" : ".) font awesome icon",
- "memberOf" : "Roo.bootstrap.Column"
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "fasize",
- "type" : "Number",
- "desc" : ".) font awsome size",
- "memberOf" : "Roo.bootstrap.Column"
+ "name" : "placeholder",
+ "type" : "string",
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "hidden",
+ "name" : "preventMark",
"type" : "Boolean",
- "desc" : "e) hide the element",
- "memberOf" : "Roo.bootstrap.Column"
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "html",
- "type" : "String",
- "desc" : "content of column.",
- "memberOf" : "Roo.bootstrap.Column"
+ "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" : "icon",
+ "name" : "regexText",
"type" : "String",
- "desc" : ".) glyphicon name",
- "memberOf" : "Roo.bootstrap.Column"
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
+ "name" : "removable",
+ "type" : "Boolean",
+ "desc" : "e) special filter default false",
+ "memberOf" : ""
},
{
- "name" : "lgoff",
- "type" : "Number",
- "desc" : "colspan offset out of 12 for large computer-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
+ "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" : "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" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "md",
+ "name" : "sm",
"type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "mdoff",
- "type" : "Number",
- "desc" : "colspan offset out of 12 for computer-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "name",
+ "name" : "tooltip",
"type" : "string",
- "desc" : "Specifies name attribute",
+ "desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "navId",
+ "name" : "triggerClass",
"type" : "String",
- "desc" : "the navigation id (for use with navbars) - will be auto generated if it does not exist..",
+ "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" : "showarrow",
- "type" : "Boolean",
- "desc" : "e) show arrow default true",
- "memberOf" : ""
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "smoff",
+ "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" : "colspan offset out of 12 for tablet-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.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" : "timer",
- "type" : "Number",
- "desc" : "auto slide timer .. default 0 millisecond",
- "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" : "tooltip",
+ "name" : "value",
"type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "visibilityEl",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "xattr",
"type" : "Object",
{
"name" : "xs",
"type" : "Number",
- "desc" : "colspan out of 12 for mobile-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"
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
],
"returns" : []
},
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "paste",
+ "type" : "function",
+ "desc" : "Fires after the user pastes into input",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
],
"returns" : []
},
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "get",
- "type" : "function",
- "desc" : "fetch a Navigation Group based on the navigation ID\nif one does not exist , it will get created.",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "string",
- "desc" : "navgroup to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "getChildContainer",
"type" : "function",
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "name The name field"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
"returns" : []
},
{
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "register",
+ "name" : "onTriggerClick",
"type" : "function",
- "desc" : "register a Navigation item",
- "sig" : "(the)",
+ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
+ "sig" : "(e)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "the",
- "type" : "Roo.bootstrap.NavItem",
- "desc" : "navitem to add",
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "register",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "register a Navigation Group",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.NavGroup",
- "desc" : "navgroup to add",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
"returns" : []
},
{
- "name" : "setVisibilityEl",
+ "name" : "setRawValue",
"type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "setValue",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "show",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
+ "desc" : "Set the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.bootstrap.Component",
"returns" : []
},
{
- "name" : "showPanel",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "show a specific panel",
- "sig" : "(panel)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Roo.bootstrap.TabPanel|number|string",
- "desc" : "to change to (use the tabId to specify a specific one)",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "boolean",
- "desc" : "false if panel was not shown (invalid entry or beforedeactivate fails.)"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "tooltipEl",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
]
},
- "Roo.bootstrap.TabPanel" : {
+ "Roo.bootstrap.UploadCropbox" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "active",
- "type" : "Boolean",
- "desc" : "panel active",
- "memberOf" : ""
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "buttons",
+ "type" : "Array",
+ "desc" : "default ['rotateLeft', 'pictureBtn', 'rotateRight']",
+ "memberOf" : ""
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"memberOf" : "Roo.Component"
},
{
- "name" : "hideMode",
+ "name" : "emptyText",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "show when image has been loaded",
+ "memberOf" : ""
},
{
- "name" : "href",
- "type" : "String",
- "desc" : "click to link..",
+ "name" : "errorTimeout",
+ "type" : "Number",
+ "desc" : "default 3000",
"memberOf" : ""
},
{
- "name" : "html",
+ "name" : "hideMode",
"type" : "String",
- "desc" : "panel content",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "isDocument",
+ "type" : "Boolean",
+ "desc" : "e) default false",
"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"
},
+ {
+ "name" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : ""
+ },
+ {
+ "name" : "loadingText",
+ "type" : "Boolean",
+ "desc" : "default 'Loading...'",
+ "memberOf" : ""
+ },
+ {
+ "name" : "method",
+ "type" : "String",
+ "desc" : "default POST",
+ "memberOf" : ""
+ },
+ {
+ "name" : "minHeight",
+ "type" : "Number",
+ "desc" : "default 300",
+ "memberOf" : ""
+ },
+ {
+ "name" : "minWidth",
+ "type" : "Number",
+ "desc" : "default 300",
+ "memberOf" : ""
+ },
{
"name" : "name",
"type" : "string",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "navId",
+ "name" : "paramName",
"type" : "String",
- "desc" : "The Roo.bootstrap.NavGroup which triggers show hide ()",
+ "desc" : "default 'imageUpload'",
"memberOf" : ""
},
{
- "name" : "style",
+ "name" : "rotateNotify",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "show when image too small to rotate",
+ "memberOf" : ""
},
{
- "name" : "tabId",
+ "name" : "style",
"type" : "String",
- "desc" : "unique tab ID (will be autogenerated if not set. - used to match TabItem to Panel)",
- "memberOf" : ""
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "touchSlide",
- "type" : "Boolean",
- "desc" : "if swiping slides tab to next panel (default off)",
+ "name" : "url",
+ "type" : "String",
+ "desc" : "action url",
"memberOf" : ""
},
{
"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" : "beforedeactivate",
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component"
+ }
+ ],
+ "events" : [
+ {
+ "name" : "arrange",
+ "type" : "function",
+ "desc" : "Fire when arrange the file data",
+ "sig" : "function (_self, formData)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "formData",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforedestroy",
+ "type" : "function",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforehide",
+ "type" : "function",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeloadcanvas",
+ "type" : "function",
+ "desc" : "Fire before load the canvas",
+ "sig" : "function (_self, src)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "src",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforerender",
+ "type" : "function",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeselectfile",
+ "type" : "function",
+ "desc" : "Fire before select file",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "crop",
"type" : "function",
- "desc" : "Fires before a tab is de-activated - can be used to do validation on a form.",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Fire after initEvent",
+ "sig" : "function (_self, data)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.TabPanel",
+ "type" : "Roo.bootstrap.UploadCropbox",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "false if there is an error"
+ "name" : "data",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "beforedestroy",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "desc" : "Fires after the component is destroyed.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "beforehide",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "desc" : "Fires after the component is disabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "download",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "desc" : "Fire when download the image",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.UploadCropbox",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "desc" : "Fires after the component is enabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "changed",
+ "name" : "exception",
"type" : "function",
- "desc" : "Fires when the active status changes",
- "sig" : "function (_self, state)\n{\n\n}",
+ "desc" : "Fire when get exception",
+ "sig" : "function (_self, xhr)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.TabPanel",
+ "type" : "Roo.bootstrap.UploadCropbox",
"desc" : "",
"isOptional" : false
},
{
- "name" : "state",
- "type" : "Boolean",
- "desc" : "the new state",
+ "name" : "xhr",
+ "type" : "XMLHttpRequest",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "footerbuttonclick",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "Fire when footerbuttonclick",
+ "sig" : "function (_self, type)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "type",
+ "type" : "String",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "disable",
+ "name" : "initial",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
+ "desc" : "Fire after initEvent",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.UploadCropbox",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "enable",
+ "name" : "inspect",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fire when inspect the file",
+ "sig" : "function (_self, file)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "file",
+ "type" : "Object",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "hide",
+ "name" : "prepare",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fire when preparing the file data",
+ "sig" : "function (_self, file)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "file",
+ "type" : "Object",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "resize",
+ "type" : "function",
+ "desc" : "Fire when resize",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "rotate",
+ "type" : "function",
+ "desc" : "Fire when rotate the image",
+ "sig" : "function (_self, pos)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "pos",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "trash",
+ "type" : "function",
+ "desc" : "Fire when trash image",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "upload",
+ "type" : "function",
+ "desc" : "Fire when xhr upload the file",
+ "sig" : "function (_self, data)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
}
]
},
- "Roo.bootstrap.Table" : {
+ "Roo.bootstrap.breadcrumb" : {
+ "props" : [],
+ "events" : [],
+ "methods" : []
+ },
+ "Roo.bootstrap.breadcrumb.Item" : {
"props" : [
{
"name" : "actionMode",
"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" : "auto_hide_footer",
+ "name" : "active",
"type" : "Boolean",
- "desc" : "auto hide footer if only one page (default false)",
+ "desc" : "is it active",
"memberOf" : ""
},
{
- "name" : "bordered",
- "type" : "boolean",
- "desc" : "Add borders to the table",
- "memberOf" : ""
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component"
},
{
"name" : "can_build_overlaid",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "cellSelection",
- "type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
- },
{
"name" : "cls",
"type" : "String",
- "desc" : "table class",
- "memberOf" : ""
- },
- {
- "name" : "cm[]",
- "type" : "Roo.grid.ColumnModel",
- "desc" : "A column for th grid.",
- "memberOf" : ""
- },
- {
- "name" : "condensed",
- "type" : "boolean",
- "desc" : "Format condensed",
- "memberOf" : ""
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "container_method",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
- {
- "name" : "enableColumnResize",
- "type" : "Boolean",
- "desc" : "default true if columns can be resized (drag/drop)",
- "memberOf" : ""
- },
- {
- "name" : "footer",
- "type" : "Roo.bootstrap.PagingToolbar",
- "desc" : "a paging toolbar",
- "memberOf" : ""
- },
- {
- "name" : "footerShow",
- "type" : "Boolean",
- "desc" : "e) generate tfoot, default true",
- "memberOf" : ""
- },
- {
- "name" : "headerShow",
- "type" : "Boolean",
- "desc" : "e) generate thead, default true",
- "memberOf" : ""
- },
{
"name" : "hideMode",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "hover",
- "type" : "boolean",
- "desc" : "Add hover highlighting",
+ "name" : "href",
+ "type" : "String",
+ "desc" : "where it links to if '#' is used the link will be handled by onClick.",
"memberOf" : ""
},
{
- "name" : "lazyLoad",
- "type" : "Boolean",
- "desc" : "auto load data while scrolling to the end (default false)",
+ "name" : "html",
+ "type" : "String",
+ "desc" : "the content of the link.",
"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"
},
- {
- "name" : "loadMask",
- "type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
- },
- {
- "name" : "minColumnWidth",
- "type" : "Number",
- "desc" : "default 50 pixels minimum column width",
- "memberOf" : ""
- },
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "responsive",
- "type" : "boolean",
- "desc" : "default false - if this is on, columns are rendered with col-xs-4 etc. classes, otherwise columns will be sized by CSS,\n also adds table-responsive (see bootstrap docs for details)",
- "memberOf" : ""
- },
- {
- "name" : "rowSelection",
- "type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
- },
- {
- "name" : "scrollBody",
- "type" : "Boolean",
- "desc" : "e) default false - body scrolled / fixed header",
- "memberOf" : ""
- },
- {
- "name" : "sm",
- "type" : "Roo.grid.AbstractSelectionModel",
- "desc" : "The selection model to use (cell selection is not supported yet)",
- "memberOf" : ""
- },
- {
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to use",
- "memberOf" : ""
- },
- {
- "name" : "striped",
- "type" : "boolean",
- "desc" : "Should the rows be alternative striped",
- "memberOf" : ""
- },
{
"name" : "style",
"type" : "String",
],
"returns" : []
},
- {
- "name" : "cellclick",
- "type" : "function",
- "desc" : "Fires when a cell is clicked",
- "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "el",
- "type" : "Roo.Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "cellcontextmenu",
- "type" : "function",
- "desc" : "Fires when a cell is right clicked",
- "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "cellIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "celldblclick",
- "type" : "function",
- "desc" : "Fires when a cell is double clicked",
- "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "el",
- "type" : "Roo.Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "childrenrendered",
"type" : "function",
"returns" : []
},
{
- "name" : "contextmenu",
+ "name" : "click",
"type" : "function",
- "desc" : "The raw contextmenu event for the entire grid.",
+ "desc" : "The img click event for the img.",
"sig" : "function (e)\n{\n\n}",
"memberOf" : "",
"example" : "",
],
"returns" : []
},
- {
- "name" : "headercontextmenu",
- "type" : "function",
- "desc" : "Fires when a header is right clicked",
- "sig" : "function (_self, columnIndex, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "mousedown",
- "type" : "function",
- "desc" : "The raw mousedown event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "mouseout",
- "type" : "function",
- "desc" : "Fires when a mouseout occur",
- "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "el",
- "type" : "Roo.Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "mouseover",
- "type" : "function",
- "desc" : "Fires when a mouseover occur",
- "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "el",
- "type" : "Roo.Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "rowclass",
- "type" : "function",
- "desc" : "Fires when a row is rendered, so you can change add a style to it.",
- "sig" : "function (_self, rowcfg)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowcfg",
- "type" : "Object",
- "desc" : "contains record rowIndex colIndex and rowClass - set rowClass to add a style.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "rowclick",
- "type" : "function",
- "desc" : "Fires when a row is clicked",
- "sig" : "function (_self, el, rowIndex, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "el",
- "type" : "Roo.Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "rowcontextmenu",
- "type" : "function",
- "desc" : "Fires when a row is right clicked",
- "sig" : "function (_self, rowIndex, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "rowdblclick",
- "type" : "function",
- "desc" : "Fires when a row is double clicked",
- "sig" : "function (_self, el, rowIndex, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "el",
- "type" : "Roo.Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "rowsrendered",
- "type" : "function",
- "desc" : "Fires when all the rows have been rendered",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "Forces a resize - used by panel.Grid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Element",
- "desc" : "The element"
- }
- ]
- },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "clear",
- "type" : "function",
- "desc" : "Remove all rows",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "ensureVisible",
- "type" : "function",
- "desc" : "Scrolls the specified cell into view",
- "sig" : "(row, col, hscroll)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "row",
- "type" : "Number",
- "desc" : "The row index",
- "isOptional" : false
- },
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "hscroll",
- "type" : "Boolean",
- "desc" : "false to disable horizontal scrolling",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "fireEvent",
"type" : "function",
}
]
},
- {
- "name" : "focusCell",
- "type" : "function",
- "desc" : "Focuses the specified cell.",
- "sig" : "(row, col, hscroll)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "row",
- "type" : "Number",
- "desc" : "The row index",
- "isOptional" : false
- },
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "hscroll",
- "type" : "Boolean",
- "desc" : "false to disable horizontal scrolling",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "focusRow",
- "type" : "function",
- "desc" : "Focuses the specified row.",
- "sig" : "(row)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "row",
- "type" : "Number",
- "desc" : "The row index",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "getCellIndex",
- "type" : "function",
- "desc" : "get the Column Index from a dom element. (using regex on x-hcol-{colid})",
- "sig" : "(cell)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "cell",
- "type" : "domElement",
- "desc" : "to look for",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "getChildContainer",
"type" : "function",
}
]
},
- {
- "name" : "getGridEl",
- "type" : "function",
- "desc" : "Returns the grid's underlying element = used by panel.Grid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Element",
- "desc" : "The element"
- }
- ]
- },
- {
- "name" : "getHeaderIndex",
- "type" : "function",
- "desc" : "get the header TH element for columnIndex",
- "sig" : "(columnIndex)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "getId",
"type" : "function",
}
]
},
- {
- "name" : "getRowIndex",
- "type" : "function",
- "desc" : "get the Row Index from a dom element.",
- "sig" : "(row)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "row",
- "type" : "Roo.Element",
- "desc" : "The row to look for",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "getVisibilityEl",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setRowVisibility",
- "type" : "function",
- "desc" : "Show or hide a row.",
- "sig" : "(rowIndex, state)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "to show or hide",
- "isOptional" : false
- },
- {
- "name" : "state",
- "type" : "Boolean",
- "desc" : "hide",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
}
]
},
- "Roo.bootstrap.TableBody" : {
+ "Roo.bootstrap.breadcrumb.Nav" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "align",
- "type" : "String",
- "desc" : "Aligns the content inside the element",
- "memberOf" : ""
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "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" : "cls",
"type" : "String",
- "desc" : "element class",
- "memberOf" : ""
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "container_method",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "tag",
- "type" : "String",
- "desc" : "element tag (thead|tbody|tfoot) default tbody",
- "memberOf" : ""
- },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "valign",
- "type" : "String",
- "desc" : "Vertical aligns the content inside the <tbody> element",
- "memberOf" : ""
- },
{
"name" : "visibilityEl",
"type" : "string|object",
}
]
},
- "Roo.bootstrap.TableCell" : {
+ "Roo.bootstrap.dash" : {
+ "props" : [],
+ "events" : [],
+ "methods" : []
+ },
+ "Roo.bootstrap.dash.NumberBox" : {
"props" : [
- {
- "name" : "abbr",
- "type" : "String",
- "desc" : "Specifies an abbreviated version of the content in a cell",
- "memberOf" : ""
- },
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "align",
- "type" : "String",
- "desc" : "Aligns the content in a cell",
- "memberOf" : ""
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "axis",
- "type" : "String",
- "desc" : "Categorizes cells",
- "memberOf" : ""
- },
- {
- "name" : "bgcolor",
- "type" : "String",
- "desc" : "Specifies the background color of a cell",
- "memberOf" : ""
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "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" : "cls",
"type" : "String",
- "desc" : "cell class",
- "memberOf" : ""
- },
- {
- "name" : "colspan",
- "type" : "Number",
- "desc" : "Specifies the number of columns a cell should span",
- "memberOf" : ""
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "container_method",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "content",
+ "type" : "String",
+ "desc" : "Box content",
+ "memberOf" : ""
+ },
{
"name" : "dataId",
"type" : "string",
"memberOf" : "Roo.Component"
},
{
- "name" : "headers",
+ "name" : "fhref",
"type" : "String",
- "desc" : "Specifies one or more header cells a cell is related to",
+ "desc" : "Footer href",
"memberOf" : ""
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "Sets the height of a cell",
+ "name" : "footer",
+ "type" : "String",
+ "desc" : "Footer text",
+ "memberOf" : ""
+ },
+ {
+ "name" : "headline",
+ "type" : "String",
+ "desc" : "Box headline",
"memberOf" : ""
},
{
"memberOf" : "Roo.Component"
},
{
- "name" : "html",
+ "name" : "icon",
"type" : "String",
- "desc" : "cell contain text",
+ "desc" : "Box icon",
"memberOf" : ""
},
{
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "nowrap",
- "type" : "String",
- "desc" : "Specifies that the content inside a cell should not wrap",
- "memberOf" : ""
- },
- {
- "name" : "rowspan",
- "type" : "Number",
- "desc" : "Sets the number of rows a cell should span",
- "memberOf" : ""
- },
- {
- "name" : "scope",
- "type" : "String",
- "desc" : "Defines a way to associate header cells and data cells in a table",
- "memberOf" : ""
- },
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "tag",
- "type" : "String",
- "desc" : "cell tag (td|th) default td",
- "memberOf" : ""
- },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "valign",
- "type" : "String",
- "desc" : "Vertical aligns the content in a cell",
- "memberOf" : ""
- },
{
"name" : "visibilityEl",
"type" : "string|object",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "Specifies the width of a cell",
- "memberOf" : ""
- },
{
"name" : "xattr",
"type" : "Object",
}
]
},
- "Roo.bootstrap.TableRow" : {
+ "Roo.bootstrap.dash.TabBox" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "align",
- "type" : "String",
- "desc" : "Aligns the content in a table row",
- "memberOf" : ""
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "bgcolor",
- "type" : "String",
- "desc" : "Specifies a background color for a table row",
- "memberOf" : ""
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "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" : "cls",
"type" : "String",
- "desc" : "row class",
- "memberOf" : ""
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "container_method",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "icon",
+ "type" : "String",
+ "desc" : "Icon of the TabBox",
+ "memberOf" : ""
+ },
{
"name" : "listeners",
"type" : "Object",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "showtabs",
+ "type" : "Boolean",
+ "desc" : "e) show the tabs default true",
+ "memberOf" : ""
+ },
{
"name" : "style",
"type" : "String",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "tabScrollable",
+ "type" : "Boolean",
+ "desc" : "e) tab scrollable when mobile view default false",
+ "memberOf" : ""
},
{
- "name" : "valign",
+ "name" : "title",
"type" : "String",
- "desc" : "Vertical aligns the content in a table row",
+ "desc" : "Title of the TabBox",
"memberOf" : ""
},
+ {
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
}
],
"events" : [
+ {
+ "name" : "activatepane",
+ "type" : "function",
+ "desc" : "When a pane is activated",
+ "sig" : "function (pane)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "pane",
+ "type" : "Roo.bootstrap.dash.TabPane",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "addpane",
+ "type" : "function",
+ "desc" : "When a pane is added",
+ "sig" : "function (pane)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "pane",
+ "type" : "Roo.bootstrap.dash.TabPane",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setTitle",
+ "type" : "function",
+ "desc" : "Updates the box title",
+ "sig" : "(html)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "to set the title to.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
}
]
},
- "Roo.bootstrap.TextArea" : {
+ "Roo.bootstrap.dash.TabPane" : {
"props" : [
- {
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "accept",
- "type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "actionMode",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "allowBlank",
+ "name" : "active",
"type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "e) Default false",
+ "memberOf" : ""
},
{
"name" : "allowDomMove",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "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" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "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" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "capture",
- "type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "cols",
- "type" : "Number",
- "desc" : "Specifies the visible width of a text area",
- "memberOf" : ""
- },
{
"name" : "container_method",
"type" : "string",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "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" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "hideMode",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
- {
- "name" : "html",
- "type" : "string",
- "desc" : "text",
- "memberOf" : ""
- },
- {
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "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" : "labelAlign",
- "type" : "String",
- "desc" : "t)",
- "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" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "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"
},
- {
- "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" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "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" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "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" : "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" : "preventMark",
- "type" : "Boolean",
- "desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "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" : "resize",
- "type" : "string",
- "desc" : "l)",
- "memberOf" : ""
- },
- {
- "name" : "rows",
- "type" : "Number",
- "desc" : "Specifies the visible number of lines in a text area",
- "memberOf" : ""
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "size",
- "type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "style",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validFeedbackIcon",
+ "name" : "title",
"type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "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" : "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" : "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"
+ "desc" : "title of panel",
+ "memberOf" : ""
},
{
- "name" : "value",
+ "name" : "tooltip",
"type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "visibilityEl",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "wrap",
- "type" : "string",
- "desc" : "d)Specifies how the text in a text area is to be wrapped when submitted in a form",
- "memberOf" : ""
- },
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
{
- "name" : "beforedestroy",
+ "name" : "activate",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "When a pane is activated",
+ "sig" : "function (pane)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "pane",
+ "type" : "Roo.bootstrap.dash.TabPane",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforehide",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "blur",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Fires when this field loses input focus.",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
}
],
"returns" : []
],
"returns" : []
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "paste",
- "type" : "function",
- "desc" : "Fires after the user pastes into input",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"methods" : [
],
"returns" : []
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "name The name field"
- }
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real textarea element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
"returns" : []
},
{
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setValue",
+ "name" : "setTitle",
"type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
+ "desc" : "Updates the tab title",
+ "sig" : "(html)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "html",
+ "type" : "String",
+ "desc" : "to set the title to.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
- },
- {
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "validate",
+ "name" : "tooltipEl",
"type" : "function",
- "desc" : "Validates the field value",
+ "desc" : "Fetch the element to display the tooltip on.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
{
- "name" : "validateValue",
+ "name" : "un",
"type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
}
]
},
- "Roo.bootstrap.TimeField" : {
+ "Roo.bootstrap.htmleditor" : {
+ "props" : [],
+ "events" : [],
+ "methods" : []
+ },
+ "Roo.bootstrap.htmleditor.ToolbarStandard" : {
"props" : [
- {
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "accept",
- "type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "align",
"type" : "String",
- "desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "t) alignment",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
"name" : "allowDomMove",
"memberOf" : "Roo.Component"
},
{
- "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" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "arrangement",
+ "type" : "Boolean",
+ "desc" : "stacked | justified",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
- "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" : "btns",
+ "type" : "Array",
+ "desc" : "List of additional buttons.\n\n\nNEEDS Extra CSS? \n.x-html-editor-tb .x-edit-none .x-btn-text { background: none; }",
+ "memberOf" : ""
},
{
"name" : "can_build_overlaid",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "capture",
- "type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "cls",
"type" : "String",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "disable",
+ "type" : "Object",
+ "desc" : "List of elements to disable..",
+ "memberOf" : ""
+ },
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "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" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "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" : "hasFeedback",
- "type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "hideMode",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "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" : "labelAlign",
- "type" : "String",
- "desc" : "t)",
- "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" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "is inverted color",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "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" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "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" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "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" : "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" : "preventMark",
- "type" : "Boolean",
- "desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "readOnly",
+ "name" : "loadMask",
"type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "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"
+ "desc" : "e) loadMask on the bar",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
- "name" : "selectOnFocus",
+ "name" : "main",
"type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "e) main nav bar? default false",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
- "name" : "size",
+ "name" : "name",
"type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "style",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "v) default is nav",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
{
"name" : "tooltip",
"type" : "string",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validFeedbackIcon",
+ "name" : "type",
"type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "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" : "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" : "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" : "value",
- "type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "s)",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
"name" : "visibilityEl",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "vtype",
+ "name" : "weight",
"type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "e) default is light.",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
"returns" : []
},
{
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
+ "name" : "beforetoggle",
"type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "desc" : "Fire before toggle the menu",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
}
],
"returns" : []
],
"returns" : []
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "paste",
- "type" : "function",
- "desc" : "Fires after the user pastes into input",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when select a date.",
- "sig" : "function (_self, date)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DateField",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "date",
- "type" : "Mixed",
- "desc" : "The date value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
- "desc" : "Fires when this field show.",
- "sig" : "function (thisthis, date)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "thisthis",
- "type" : "Roo.bootstrap.DateField",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "date",
- "type" : "Mixed",
- "desc" : "The date value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "clearInvalid",
+ "name" : "collapse",
"type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
+ "desc" : "Collapse the navbar pulldown",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expand the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
]
},
{
- "name" : "getName",
+ "name" : "getVisibilityEl",
"type" : "function",
- "desc" : "Returns the name of the field",
+ "desc" : "Get the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "hasListener",
+ "type" : "function",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "name The name field"
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "getRawValue",
+ "name" : "hide",
"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",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
+ "returns" : []
},
{
- "name" : "getValue",
+ "name" : "initEvents",
"type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "desc" : "Initialize Events for the element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
+ "returns" : []
},
{
- "name" : "getVisibilityEl",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Get the element that will be used to show or hide",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "hasListener",
+ "name" : "on",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The name of the event to check for",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hide",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "initEvents",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "inputEl",
+ "name" : "render",
"type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "isVisible",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
"memberOf" : "Roo.Component",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
+ "params" : [
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setVisibilityEl",
+ "type" : "function",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
- "name" : "markInvalid",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "markValid",
+ "name" : "show",
"type" : "function",
- "desc" : "Mark this field as valid",
+ "desc" : "Show a component - removes 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "on",
+ "name" : "tooltipEl",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
+ }
+ ]
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "updateToolbar",
+ "type" : "function",
+ "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ }
+ ]
+ },
+ "Roo.bootstrap.layout" : {
+ "props" : [],
+ "events" : [],
+ "methods" : []
+ },
+ "Roo.bootstrap.layout.Basic" : {
+ "props" : [
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "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" : ""
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "add",
+ "type" : "function",
+ "desc" : "Add the passed ContentPanel(s)",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "options",
+ "name" : "panel",
+ "type" : "ContentPanel...",
+ "desc" : "The ContentPanel(s) to add (you can pass more than one)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel added (if only one was added)"
+ }
+ ]
+ },
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "object",
"type" : "Object",
- "desc" : "(optional)",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "capture",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
"static" : true,
"memberOf" : "Roo.util.Observable",
"isStatic" : true,
{
"name" : "o",
"type" : "Observable",
- "desc" : "The Observable to release",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "render",
+ "name" : "getActivePanel",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Get the active panel for this region.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The active panel or null"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "reset",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "desc" : "Returns the container element for this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "setDisabled",
+ "name" : "getPanel",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Returns the panel specified or null if it's not in this region.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "setRawValue",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
+ "desc" : "Returns this regions position (north/south/east/west/center).",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "hasListener",
+ "type" : "function",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "setValue",
+ "name" : "hasPanel",
"type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
+ "desc" : "Returns true if the panel is in this region.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "setVisibilityEl",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Set the element that will be used to show or hide",
+ "desc" : "Returns true if this region is currently visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "setVisible",
+ "name" : "on",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "show",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "tooltipEl",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "remove",
+ "type" : "function",
+ "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
+ "sig" : "(panel, preservePanel)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
+ "isOptional" : false
+ },
+ {
+ "name" : "preservePanel",
+ "type" : "Boolean",
+ "desc" : "Overrides the config preservePanel option",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel that was removed"
}
]
},
{
- "name" : "un",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
+ "desc" : "Removes a listener",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"returns" : []
},
{
- "name" : "validate",
+ "name" : "resizeTo",
"type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
+ "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
+ "sig" : "(newSize)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new width or height",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "validateValue",
+ "name" : "showPanel",
"type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
+ "desc" : "Show the specified panel.",
+ "sig" : "(panelId)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
+ "name" : "panelId",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "type" : "Roo.ContentPanel",
+ "desc" : "The shown panel or null"
}
]
- }
- ]
- },
- "Roo.bootstrap.Tooltip" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "currentEl",
+ "name" : "un",
"type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
"returns" : []
}
]
},
- "Roo.bootstrap.TriggerField" : {
+ "Roo.bootstrap.layout.Border" : {
"props" : [
- {
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "accept",
- "type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) Default left",
- "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" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "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" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "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" : "can_build_overlaid",
"type" : "Boolean",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "capture",
- "type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "caret",
- "type" : "String",
- "desc" : "r) BS3 only - carat fa name",
+ "name" : "center",
+ "type" : "Roo.bootstrap.layout.Region",
+ "desc" : "region to go in center",
"memberOf" : ""
},
{
"memberOf" : "Roo.Component"
},
{
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "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" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "east",
+ "type" : "Roo.bootstrap.layout.Region",
+ "desc" : "region to go in east",
+ "memberOf" : ""
},
{
"name" : "hideMode",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
- {
- "name" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : ""
- },
- {
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "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" : "labelAlign",
- "type" : "String",
- "desc" : "t)",
- "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" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "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"
},
- {
- "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" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "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" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "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" : "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" : "preventMark",
- "type" : "Boolean",
- "desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "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"
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "removable",
- "type" : "Boolean",
- "desc" : "e) special filter default false",
+ "name" : "north",
+ "type" : "Roo.bootstrap.layout.Region",
+ "desc" : "region to go in north",
"memberOf" : ""
},
{
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "size",
- "type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "south",
+ "type" : "Roo.bootstrap.layout.Region",
+ "desc" : "region to go in south",
+ "memberOf" : ""
},
{
"name" : "style",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.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" : ""
- },
- {
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-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" : "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" : "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" : "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" : "value",
- "type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "visibilityEl",
"type" : "string|object",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "west",
+ "type" : "Roo.bootstrap.layout.Region",
+ "desc" : "region to go in west",
+ "memberOf" : ""
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
],
"returns" : []
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "childrenrendered",
"type" : "function",
"returns" : []
},
{
- "name" : "focus",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires when this field receives input focus.",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "hide",
+ "name" : "layout",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires when a layout is performed.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutManager",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "invalid",
+ "name" : "regioncollapsed",
"type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "desc" : "Fires when a region is collapsed.",
+ "sig" : "function (region)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
+ "name" : "region",
+ "type" : "Roo.LayoutRegion",
+ "desc" : "The collapsed region",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "keyup",
+ "name" : "regionexpanded",
"type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "desc" : "Fires when a region is expanded.",
+ "sig" : "function (region)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
+ "name" : "region",
+ "type" : "Roo.LayoutRegion",
+ "desc" : "The expanded region",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "paste",
+ "name" : "regionresized",
"type" : "function",
- "desc" : "Fires after the user pastes into input",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "desc" : "Fires when the user resizes a region.",
+ "sig" : "function (region, newSize)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "region",
+ "type" : "Roo.LayoutRegion",
+ "desc" : "The resized region",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new size (width for east/west, height for north/south)",
"isOptional" : false
}
],
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "specialkey",
+ "name" : "add",
"type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "desc" : "Adds a ContentPanel (or subclass) to this layout.",
+ "sig" : "(target, panel)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "target",
+ "type" : "String",
+ "desc" : "The target region key (north, south, east, west or center).",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
+ "name" : "panel",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel to add",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The added panel"
}
- ],
- "returns" : []
- }
- ],
- "methods" : [
+ ]
+ },
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "autoSize",
+ "name" : "addRegion",
"type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
+ "desc" : "Creates and adds a new region if it doesn't already exist.",
+ "sig" : "(target, config)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "String",
+ "desc" : "The target region key (north, south, east, west or center).",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The regions config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BorderLayoutRegion",
+ "desc" : "The new region"
+ }
+ ]
+ },
+ {
+ "name" : "addxtype",
+ "type" : "function",
+ "desc" : "Adds a xtype elements to the layout.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'ContentPanel',\n region: 'west',\n items: [ .... ]\n }\n);\n\nlayout.addxtype({\n xtype : 'NestedLayoutPanel',\n region: 'west',\n layout: {\n center: { },\n west: { } \n },\n items : [ ... list of content panels or nested layout panels.. ]\n }\n);\n</code></pre>",
+ "sig" : "(cfg)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
+ "params" : [
+ {
+ "name" : "cfg",
+ "type" : "Object",
+ "desc" : "Xtype definition of item to add.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beginUpdate",
+ "type" : "function",
+ "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.layout.Manager",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
"returns" : []
},
{
- "name" : "clearInvalid",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "disable",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "desc" : "Disable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "disable",
+ "name" : "enable",
"type" : "function",
- "desc" : "Disable this component.",
+ "desc" : "Enable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component",
]
},
{
- "name" : "enable",
+ "name" : "endUpdate",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
+ "sig" : "(noLayout)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "noLayout",
+ "type" : "Boolean",
+ "desc" : "true to disable a layout update",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "findPanel",
+ "type" : "function",
+ "desc" : "Searches all regions for a panel with the specified id",
+ "sig" : "(panelId)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panelId",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel or null if it wasn't found"
}
]
},
{
"name" : "getEl",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Returns the Element this layout is bound to.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "The element"
+ "desc" : ""
}
]
},
]
},
{
- "name" : "getName",
+ "name" : "getRegion",
"type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the specified region.",
+ "sig" : "(target)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Mixed",
- "desc" : "name The name field"
+ "name" : "target",
+ "type" : "String",
+ "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ ],
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "Roo.LayoutRegion",
+ "desc" : ""
}
]
},
{
- "name" : "getValue",
+ "name" : "getViewSize",
"type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "Object",
+ "desc" : "The size as an object {width: (the width), height: (the height)}"
}
]
},
"returns" : []
},
{
- "name" : "inputEl",
+ "name" : "isUpdating",
"type" : "function",
- "desc" : "return the real input element.",
+ "desc" : "Returns true if this layout is currently being updated",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
"name" : "isVisible",
"returns" : []
},
{
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "markValid",
+ "name" : "layout",
"type" : "function",
- "desc" : "Mark this field as valid",
+ "desc" : "Performs a layout update.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
},
- {
- "name" : "onTriggerClick",
- "type" : "function",
- "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "purgeListeners",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "remove",
+ "type" : "function",
+ "desc" : "Remove a ContentPanel (or subclass) to this layout.",
+ "sig" : "(target, panel)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "String",
+ "desc" : "The target region key (north, south, east, west or center).",
+ "isOptional" : false
+ },
+ {
+ "name" : "panel",
+ "type" : "Number/String/Roo.ContentPanel",
+ "desc" : "The index, id or panel to remove",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The removed panel"
+ }
+ ]
+ },
{
"name" : "removeListener",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
"returns" : []
},
{
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
- },
- {
- "name" : "un",
+ "name" : "showPanel",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Searches all regions for a panel with the specified id and activates (shows) it.",
+ "sig" : "(panelId)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "panelId",
+ "type" : "String/ContentPanel",
+ "desc" : "The panels id or the panel itself",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The shown panel or null"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "validate",
+ "name" : "tooltipEl",
"type" : "function",
- "desc" : "Validates the field value",
+ "desc" : "Fetch the element to display the tooltip on.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
{
- "name" : "validateValue",
+ "name" : "un",
"type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
}
]
},
- "Roo.bootstrap.UploadCropbox" : {
+ "Roo.bootstrap.layout.Manager" : {
"props" : [
{
"name" : "actionMode",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "buttons",
- "type" : "Array",
- "desc" : "default ['rotateLeft', 'pictureBtn', 'rotateRight']",
- "memberOf" : ""
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
- {
- "name" : "emptyText",
- "type" : "String",
- "desc" : "show when image has been loaded",
- "memberOf" : ""
- },
- {
- "name" : "errorTimeout",
- "type" : "Number",
- "desc" : "default 3000",
- "memberOf" : ""
- },
{
"name" : "hideMode",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
- {
- "name" : "isDocument",
- "type" : "Boolean",
- "desc" : "e) default 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"
},
- {
- "name" : "loadMask",
- "type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : ""
- },
- {
- "name" : "loadingText",
- "type" : "Boolean",
- "desc" : "default 'Loading...'",
- "memberOf" : ""
- },
- {
- "name" : "method",
- "type" : "String",
- "desc" : "default POST",
- "memberOf" : ""
- },
- {
- "name" : "minHeight",
- "type" : "Number",
- "desc" : "default 300",
- "memberOf" : ""
- },
- {
- "name" : "minWidth",
- "type" : "Number",
- "desc" : "default 300",
- "memberOf" : ""
- },
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "paramName",
- "type" : "String",
- "desc" : "default 'imageUpload'",
- "memberOf" : ""
- },
- {
- "name" : "rotateNotify",
- "type" : "String",
- "desc" : "show when image too small to rotate",
- "memberOf" : ""
- },
{
"name" : "style",
"type" : "String",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "url",
- "type" : "String",
- "desc" : "action url",
- "memberOf" : ""
- },
{
"name" : "visibilityEl",
"type" : "string|object",
}
],
"events" : [
- {
- "name" : "arrange",
- "type" : "function",
- "desc" : "Fire when arrange the file data",
- "sig" : "function (_self, formData)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "formData",
- "type" : "Object",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "beforeloadcanvas",
- "type" : "function",
- "desc" : "Fire before load the canvas",
- "sig" : "function (_self, src)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "src",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforerender",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "beforeselectfile",
- "type" : "function",
- "desc" : "Fire before select file",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforeshow",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "crop",
- "type" : "function",
- "desc" : "Fire after initEvent",
- "sig" : "function (_self, data)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "download",
- "type" : "function",
- "desc" : "Fire when download the image",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "exception",
- "type" : "function",
- "desc" : "Fire when get exception",
- "sig" : "function (_self, xhr)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "xhr",
- "type" : "XMLHttpRequest",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "footerbuttonclick",
- "type" : "function",
- "desc" : "Fire when footerbuttonclick",
- "sig" : "function (_self, type)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "type",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
"returns" : []
},
{
- "name" : "initial",
+ "name" : "layout",
"type" : "function",
- "desc" : "Fire after initEvent",
+ "desc" : "Fires when a layout is performed.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "inspect",
- "type" : "function",
- "desc" : "Fire when inspect the file",
- "sig" : "function (_self, file)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "file",
- "type" : "Object",
+ "type" : "Roo.LayoutManager",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "prepare",
+ "name" : "regioncollapsed",
"type" : "function",
- "desc" : "Fire when preparing the file data",
- "sig" : "function (_self, file)\n{\n\n}",
+ "desc" : "Fires when a region is collapsed.",
+ "sig" : "function (region)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "file",
- "type" : "Object",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "region",
+ "type" : "Roo.LayoutRegion",
+ "desc" : "The collapsed region",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resize",
+ "name" : "regionexpanded",
"type" : "function",
- "desc" : "Fire when resize",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Fires when a region is expanded.",
+ "sig" : "function (region)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
+ "name" : "region",
+ "type" : "Roo.LayoutRegion",
+ "desc" : "The expanded region",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "rotate",
+ "name" : "regionresized",
"type" : "function",
- "desc" : "Fire when rotate the image",
- "sig" : "function (_self, pos)\n{\n\n}",
+ "desc" : "Fires when the user resizes a region.",
+ "sig" : "function (region, newSize)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
+ "name" : "region",
+ "type" : "Roo.LayoutRegion",
+ "desc" : "The resized region",
"isOptional" : false
},
{
- "name" : "pos",
- "type" : "String",
- "desc" : "",
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new size (width for east/west, height for north/south)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires after the component is shown.",
+ "desc" : "Fires after the component is rendered.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "trash",
+ "name" : "show",
"type" : "function",
- "desc" : "Fire when trash image",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "upload",
- "type" : "function",
- "desc" : "Fire when xhr upload the file",
- "sig" : "function (_self, data)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "Object",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "beginUpdate",
+ "type" : "function",
+ "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
}
]
},
+ {
+ "name" : "endUpdate",
+ "type" : "function",
+ "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
+ "sig" : "(noLayout)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "noLayout",
+ "type" : "Boolean",
+ "desc" : "true to disable a layout update",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
{
"name" : "getEl",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Returns the Element this layout is bound to.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "The element"
+ "desc" : ""
}
]
},
}
]
},
+ {
+ "name" : "getRegion",
+ "type" : "function",
+ "desc" : "Returns the specified region.",
+ "sig" : "(target)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "String",
+ "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.LayoutRegion",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getViewSize",
+ "type" : "function",
+ "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "The size as an object {width: (the width), height: (the height)}"
+ }
+ ]
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "isUpdating",
+ "type" : "function",
+ "desc" : "Returns true if this layout is currently being updated",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
+ },
{
"name" : "isVisible",
"type" : "function",
}
]
},
- "Roo.bootstrap.breadcrumb" : {
- "props" : [],
- "events" : [],
- "methods" : []
- },
- "Roo.bootstrap.breadcrumb.Item" : {
+ "Roo.bootstrap.layout.Region" : {
"props" : [
{
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "name" : "alwaysShowTabs",
+ "type" : "Boolean",
+ "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
+ "memberOf" : ""
},
{
- "name" : "active",
+ "name" : "animate",
"type" : "Boolean",
- "desc" : "is it active",
+ "desc" : "True to animate expand/collapse (defaults to false)",
"memberOf" : ""
},
{
- "name" : "allowDomMove",
+ "name" : "autoHide",
"type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
+ "memberOf" : ""
},
{
- "name" : "can_build_overlaid",
+ "name" : "autoScroll",
"type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "True to enable overflow scrolling (defaults to false)",
+ "memberOf" : ""
},
{
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "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" : ""
},
{
- "name" : "container_method",
+ "name" : "cls",
"type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "Extra CSS classes to add to region",
+ "memberOf" : ""
},
{
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "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" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "name" : "disableTabTips",
+ "type" : "Boolean",
+ "desc" : "True to disable tab tooltips",
+ "memberOf" : ""
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "For North/South panels",
+ "memberOf" : ""
},
{
- "name" : "href",
- "type" : "String",
- "desc" : "where it links to if '#' is used the link will be handled by onClick.",
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "True to start the region hidden (defaults to false)",
"memberOf" : ""
},
{
- "name" : "html",
- "type" : "String",
- "desc" : "the content of the link.",
+ "name" : "hideTabs",
+ "type" : "Boolean",
+ "desc" : "True to hide the tab strip (defaults to false)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "hideWhenEmpty",
+ "type" : "Boolean",
+ "desc" : "True to hide the region when it has no panels",
"memberOf" : ""
},
{
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "margins",
+ "type" : "Object",
+ "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
+ "memberOf" : ""
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "mgr",
+ "type" : "Roo.bootstrap.layout.Manager",
+ "desc" : "The manager",
+ "memberOf" : ""
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "minTabWidth",
+ "type" : "Number",
+ "desc" : "The minimum tab width (defaults to 40)",
+ "memberOf" : ""
},
{
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "overflow",
+ "type" : "String",
+ "desc" : "e) if you have menus in the region, then you need to set this to visible.",
+ "memberOf" : ""
},
{
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
- }
- ],
- "events" : [
- {
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "preferredTabWidth",
+ "type" : "Number",
+ "desc" : "The preferred tab width (defaults to 150)",
+ "memberOf" : ""
},
{
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "preservePanels",
+ "type" : "Boolean",
+ "desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
+ "memberOf" : ""
},
{
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "region",
+ "type" : "string",
+ "desc" : "the region that it inhabits..",
+ "memberOf" : ""
},
{
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "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" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "skipConfig",
+ "type" : "bool",
+ "desc" : "skip config?",
+ "memberOf" : "Roo.bootstrap.layout.Basic"
},
{
- "name" : "click",
- "type" : "function",
- "desc" : "The img click event for the img.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "split",
+ "type" : "Boolean",
+ "desc" : "To show the splitter",
+ "memberOf" : ""
},
{
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "tabPosition",
+ "type" : "String",
+ "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom\")",
+ "memberOf" : ""
},
{
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title for the region (overrides panel titles)",
+ "memberOf" : ""
},
{
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "titlebar",
+ "type" : "Boolean",
+ "desc" : "True to display a title bar (defaults to true)",
+ "memberOf" : ""
},
{
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "toolbar",
+ "type" : "Boolean",
+ "desc" : "xtype configuration for a toolbar - shows on right of tabbar",
+ "memberOf" : ""
},
{
- "name" : "render",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "For East/West panels",
+ "memberOf" : ""
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "add",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Adds the passed ContentPanel(s) to this region.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "panel",
+ "type" : "ContentPanel...",
+ "desc" : "The ContentPanel(s) to add (you can pass more than one)",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel added (if only one was added; null otherwise)"
}
- ],
- "returns" : []
- }
- ],
- "methods" : [
+ ]
+ },
{
"name" : "addEvents",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "animateCollapse",
+ "type" : "function",
+ "desc" : "Collapses this region.",
+ "sig" : "(skipAnim)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "skipAnim",
+ "type" : "Boolean",
+ "desc" : "(optional) true to collapse the element without animation (if animate is true)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "animateExpand",
+ "type" : "function",
+ "desc" : "Expands this region if it was previously collapsed.",
+ "sig" : "(e, skipAnim)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event that triggered the expand (or null if calling manually)",
+ "isOptional" : false
+ },
+ {
+ "name" : "skipAnim",
+ "type" : "Boolean",
+ "desc" : "(optional) true to expand the element without animation (if animate is true)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
"returns" : []
},
{
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "disable",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "enable",
+ "name" : "getActivePanel",
"type" : "function",
- "desc" : "Enable this component.",
+ "desc" : "Get the active panel for this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.ContentPanel",
+ "desc" : "The active panel or null"
}
]
},
{
- "name" : "fireEvent",
+ "name" : "getBox",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)",
+ "sig" : "(title)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "title",
"type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "desc" : "(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, \"&#160;\")",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
},
{
- "name" : "focus",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Returns the container element for this region.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.Element",
+ "desc" : ""
}
]
},
{
- "name" : "getChildContainer",
+ "name" : "getPanel",
"type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the panel specified or null if it's not in this region.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.layout.Basic",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Roo.ContentPanel",
+ "desc" : ""
}
]
},
{
- "name" : "getEl",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Returns this regions position (north/south/east/west/center).",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.layout.Basic",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getId",
+ "name" : "getTabs",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Returns the TabPanel component used by this region",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
+ "type" : "Roo.TabPanel",
"desc" : ""
}
]
},
{
- "name" : "getVisibilityEl",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Get the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "hasListener",
+ "name" : "hasPanel",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Returns true if the panel is in this region.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.bootstrap.layout.Basic",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "desc" : ""
}
]
},
{
"name" : "hide",
"type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
+ "desc" : "Hides this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "initEvents",
+ "name" : "hidePanel",
"type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
+ "desc" : "Hides the tab for the specified panel.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
"name" : "isVisible",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
+ "desc" : "Returns true if this region is currently visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
"name" : "on",
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "remove",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
+ "sig" : "(panel, preservePanel)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "preservePanel",
+ "type" : "Boolean",
+ "desc" : "Overrides the config preservePanel option",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel that was removed"
+ }
+ ]
},
{
- "name" : "render",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "resizeTo",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
+ "sig" : "(newSize)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.layout.Basic",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new width or height",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setVisibilityEl",
+ "name" : "show",
"type" : "function",
- "desc" : "Set the element that will be used to show or hide",
+ "desc" : "Shows this region if it was previously hidden.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "showPanel",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Shows the specified panel.",
+ "sig" : "(panelId)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "panelId",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Roo.ContentPanel",
+ "desc" : "The shown panel, or null if a panel could not be found from panelId"
}
]
},
}
],
"returns" : []
+ },
+ {
+ "name" : "unhidePanel",
+ "type" : "function",
+ "desc" : "Unhides the tab for a previously hidden panel.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
]
},
- "Roo.bootstrap.breadcrumb.Nav" : {
+ "Roo.bootstrap.layout.Split" : {
"props" : [
{
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "name" : "alwaysShowTabs",
+ "type" : "Boolean",
+ "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "allowDomMove",
+ "name" : "animate",
"type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "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" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "autoScroll",
+ "type" : "Boolean",
+ "desc" : "True to enable overflow scrolling (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" : "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" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "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" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "name" : "collapsed",
+ "type" : "Boolean",
+ "desc" : "True to set the initial display to collapsed (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "hideMode",
+ "name" : "collapsedTitle",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "Optional string message to display in the collapsed block of a north or south region",
+ "memberOf" : "Roo.LayoutRegion"
+ },
+ {
+ "name" : "collapsible",
+ "type" : "Boolean",
+ "desc" : "False to disable collapsing (defaults to true)",
+ "memberOf" : "Roo.LayoutRegion"
+ },
+ {
+ "name" : "disableTabTips",
+ "type" : "Boolean",
+ "desc" : "True to disable tab tooltips",
+ "memberOf" : "Roo.LayoutRegion"
+ },
+ {
+ "name" : "floatable",
+ "type" : "Boolean",
+ "desc" : "False to disable floating (defaults to true)",
+ "memberOf" : "Roo.LayoutRegion"
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "For North/South panels",
+ "memberOf" : "Roo.LayoutRegion"
+ },
+ {
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "True to start the region hidden (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion"
+ },
+ {
+ "name" : "hideTabs",
+ "type" : "Boolean",
+ "desc" : "True to hide the tab strip (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion"
+ },
+ {
+ "name" : "hideWhenEmpty",
+ "type" : "Boolean",
+ "desc" : "True to hide the region when it has no panels",
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "margins",
+ "type" : "Object",
+ "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "style",
+ "name" : "minTabWidth",
+ "type" : "Number",
+ "desc" : "The minimum tab width (defaults to 40)",
+ "memberOf" : "Roo.LayoutRegion"
+ },
+ {
+ "name" : "preferredTabWidth",
+ "type" : "Number",
+ "desc" : "The preferred tab width (defaults to 150)",
+ "memberOf" : "Roo.LayoutRegion"
+ },
+ {
+ "name" : "preservePanels",
+ "type" : "Boolean",
+ "desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion"
+ },
+ {
+ "name" : "resizeTabs",
+ "type" : "Boolean",
+ "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion"
+ },
+ {
+ "name" : "showPin",
+ "type" : "Boolean",
+ "desc" : "True to show a pin button",
+ "memberOf" : "Roo.LayoutRegion"
+ },
+ {
+ "name" : "split",
+ "type" : "Boolean",
+ "desc" : "To show the splitter",
+ "memberOf" : "Roo.LayoutRegion"
+ },
+ {
+ "name" : "tabPosition",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom\")",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title for the region (overrides panel titles)",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "titlebar",
+ "type" : "Boolean",
+ "desc" : "True to display a title bar (defaults to true)",
+ "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" : "toolbar",
+ "type" : "Boolean",
+ "desc" : "xtype configuration for a toolbar - shows on right of tabbar",
+ "memberOf" : "Roo.LayoutRegion"
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "For East/West panels",
+ "memberOf" : "Roo.LayoutRegion"
}
],
"events" : [
{
- "name" : "beforedestroy",
+ "name" : "beforecollapse",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "desc" : "Fires when this region before collapse.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforehide",
+ "name" : "beforeremove",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument.",
+ "sig" : "function (_self, panel, e)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "panel",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "The cancel event object",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "collapsed",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "desc" : "Fires when this region is collapsed.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "expanded",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "desc" : "Fires when this region is expanded.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "invalidated",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
+ "desc" : "Fires when the layout for this region is changed.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "panelactivated",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a panel is activated.",
+ "sig" : "function (_self, panel)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "panel",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The activated panel",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "paneladded",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a panel is added.",
+ "sig" : "function (_self, panel)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "panel",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enable",
+ "name" : "panelremoved",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a panel is removed.",
+ "sig" : "function (_self, panel)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "panel",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "hide",
+ "name" : "resized",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when the user resizes this region.",
+ "sig" : "function (_self, newSize)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new size (width for east/west, height for north/south)",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "slidehide",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
+ "desc" : "Fires when this region slides out of view.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "show",
+ "name" : "slideshow",
"type" : "function",
- "desc" : "Fires after the component is shown.",
+ "desc" : "Fires when this region is slid into view.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutRegion",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "visibilitychange",
+ "type" : "function",
+ "desc" : "Fires when this region is shown or hidden",
+ "sig" : "function (_self, visibility)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "visibility",
+ "type" : "Boolean",
+ "desc" : "true or false",
+ "isOptional" : false
}
],
"returns" : []
}
],
"methods" : [
+ {
+ "name" : "add",
+ "type" : "function",
+ "desc" : "Adds the passed ContentPanel(s) to this region.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "Roo.LayoutRegion",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "ContentPanel...",
+ "desc" : "The ContentPanel(s) to add (you can pass more than one)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel added (if only one was added; null otherwise)"
+ }
+ ]
+ },
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "disable",
+ "name" : "collapse",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Collapses this region.",
+ "sig" : "(skipAnim)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "skipAnim",
+ "type" : "Boolean",
+ "desc" : "(optional) true to collapse the element without animation (if animate is true)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "enable",
+ "name" : "expand",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Expands this region if it was previously collapsed.",
+ "sig" : "(e, skipAnim)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event that triggered the expand (or null if calling manually)",
+ "isOptional" : false
+ },
+ {
+ "name" : "skipAnim",
+ "type" : "Boolean",
+ "desc" : "(optional) true to expand the element without animation (if animate is true)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
"name" : "fireEvent",
]
},
{
- "name" : "focus",
+ "name" : "getActivePanel",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Get the active panel for this region.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.ContentPanel",
+ "desc" : "The active panel or null"
}
]
},
{
- "name" : "getChildContainer",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Fetch the element to add children to",
+ "desc" : "Returns the container element for this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "desc" : ""
}
]
},
{
- "name" : "getEl",
+ "name" : "getPanel",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Returns the panel specified or null if it's not in this region.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "Roo.BasicLayoutRegion",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getPosition",
+ "type" : "function",
+ "desc" : "Returns this regions position (north/south/east/west/center).",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.BasicLayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getId",
+ "name" : "getSplitBar",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Returns the {@link Roo.SplitBar} for this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
+ "type" : "Roo.SplitBar",
"desc" : ""
}
]
},
{
- "name" : "getVisibilityEl",
+ "name" : "getTabs",
"type" : "function",
- "desc" : "Get the element that will be used to show or hide",
+ "desc" : "Returns the TabPanel component used by this region",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.TabPanel",
+ "desc" : ""
+ }
+ ]
},
{
"name" : "hasListener",
}
]
},
+ {
+ "name" : "hasPanel",
+ "type" : "function",
+ "desc" : "Returns true if the panel is in this region.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "Roo.BasicLayoutRegion",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
+ },
{
"name" : "hide",
"type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
+ "desc" : "Hides this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "initEvents",
+ "name" : "hidePanel",
"type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
+ "desc" : "Hides the tab for the specified panel.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
"name" : "isVisible",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
+ "desc" : "Returns true if this region is currently visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
"name" : "on",
],
"returns" : []
},
+ {
+ "name" : "remove",
+ "type" : "function",
+ "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
+ "sig" : "(panel, preservePanel)",
+ "static" : false,
+ "memberOf" : "Roo.LayoutRegion",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
+ "isOptional" : false
+ },
+ {
+ "name" : "preservePanel",
+ "type" : "Boolean",
+ "desc" : "Overrides the config preservePanel option",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel that was removed"
+ }
+ ]
+ },
{
"name" : "removeListener",
"type" : "function",
"returns" : []
},
{
- "name" : "render",
+ "name" : "resizeTo",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
+ "sig" : "(newSize)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.BasicLayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new width or height",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "setCollapsedTitle",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)",
+ "sig" : "(title)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "title",
+ "type" : "String",
+ "desc" : "(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, \"&#160;\")",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setVisibilityEl",
+ "name" : "show",
"type" : "function",
- "desc" : "Set the element that will be used to show or hide",
+ "desc" : "Shows this region if it was previously hidden.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "showPanel",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Shows the specified panel.",
+ "sig" : "(panelId)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "panelId",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Roo.ContentPanel",
+ "desc" : "The shown panel, or null if a panel could not be found from panelId"
}
]
},
}
],
"returns" : []
+ },
+ {
+ "name" : "unhidePanel",
+ "type" : "function",
+ "desc" : "Unhides the tab for a previously hidden panel.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "Roo.LayoutRegion",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
]
},
- "Roo.bootstrap.dash" : {
+ "Roo.bootstrap.menu" : {
"props" : [],
"events" : [],
"methods" : []
},
- "Roo.bootstrap.dash.NumberBox" : {
+ "Roo.bootstrap.menu.Item" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "active",
+ "type" : "Boolean",
+ "desc" : "used on sidebars to highlight active itesm",
+ "memberOf" : ""
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "content",
- "type" : "String",
- "desc" : "Box content",
- "memberOf" : ""
- },
{
"name" : "dataId",
"type" : "string",
"memberOf" : "Roo.Component"
},
{
- "name" : "fhref",
+ "name" : "fa",
"type" : "String",
- "desc" : "Footer href",
+ "desc" : "favicon to show on left of menu item.",
"memberOf" : ""
},
{
- "name" : "footer",
+ "name" : "hideMode",
"type" : "String",
- "desc" : "Footer text",
- "memberOf" : ""
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "headline",
+ "name" : "href",
"type" : "String",
- "desc" : "Box headline",
+ "desc" : "the link",
"memberOf" : ""
},
{
- "name" : "hideMode",
+ "name" : "html",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "the menu label",
+ "memberOf" : ""
},
{
- "name" : "icon",
- "type" : "String",
- "desc" : "Box icon",
+ "name" : "isContainer",
+ "type" : "Boolean",
+ "desc" : "is it a container - just returns a drop down item..",
"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"
},
+ {
+ "name" : "menu",
+ "type" : "Roo.bootsrap.Menu",
+ "desc" : "the child menu.",
+ "memberOf" : ""
+ },
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "do not trigger A href on clicks (default false).",
+ "memberOf" : ""
+ },
{
"name" : "style",
"type" : "String",
],
"returns" : []
},
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "The raw click event for the entire grid.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.menu.Item",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
- "Roo.bootstrap.dash.TabBox" : {
+ "Roo.bootstrap.menu.Manager" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "get",
+ "type" : "function",
+ "desc" : "Returns a {@link Roo.menu.Menu} object",
+ "sig" : "(menu)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "menu",
+ "type" : "String/Object",
+ "desc" : "The string menu id, an existing menu object reference, or a Menu config that will\nbe used to generate and return a new Menu instance.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hideAll",
+ "type" : "function",
+ "desc" : "Hides all menus that are currently visible",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ }
+ ]
+ },
+ "Roo.bootstrap.menu.Menu" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "default tl-bl? == below - how the menu should be aligned.",
+ "memberOf" : ""
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "hidden",
+ "type" : "bool",
+ "desc" : "if the menu should be hidden when rendered.",
+ "memberOf" : ""
+ },
{
"name" : "hideMode",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "icon",
- "type" : "String",
- "desc" : "Icon of the TabBox",
+ "name" : "hideTrigger",
+ "type" : "bool",
+ "desc" : "e) default false - hide the carret for trigger.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "isLink",
+ "type" : "bool",
+ "desc" : "e) the menu has link disable auto expand and collaspe (default false)",
"memberOf" : ""
},
{
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "showtabs",
+ "name" : "registerMenu",
"type" : "Boolean",
- "desc" : "e) show the tabs default true",
+ "desc" : "True (default) - means that clicking on screen etc. hides it.",
"memberOf" : ""
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "tabScrollable",
- "type" : "Boolean",
- "desc" : "e) tab scrollable when mobile view default false",
+ "name" : "stopEvent",
+ "type" : "bool",
+ "desc" : "e) Stop event after trigger press (default true)",
"memberOf" : ""
},
{
- "name" : "title",
+ "name" : "style",
"type" : "String",
- "desc" : "Title of the TabBox",
- "memberOf" : ""
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "tooltip",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "type",
+ "type" : "String",
+ "desc" : "u) type of menu",
+ "memberOf" : ""
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
}
],
"events" : [
- {
- "name" : "activatepane",
- "type" : "function",
- "desc" : "When a pane is activated",
- "sig" : "function (pane)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "pane",
- "type" : "Roo.bootstrap.dash.TabPane",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "addpane",
- "type" : "function",
- "desc" : "When a pane is added",
- "sig" : "function (pane)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "pane",
- "type" : "Roo.bootstrap.dash.TabPane",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforedestroy",
"type" : "function",
{
"name" : "beforehide",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "desc" : "Fires before this menu is hidden (return false to block)",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
}
{
"name" : "beforeshow",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "desc" : "Fires before this menu is displayed (return false to block)",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)",
+ "sig" : "function (_self, menuItem, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "menuItem",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was clicked",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
{
"name" : "hide",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires after this menu is hidden",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "itemclick",
+ "type" : "function",
+ "desc" : "Fires when a menu item contained in this menu is clicked",
+ "sig" : "function (baseItem, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "baseItem",
+ "type" : "Roo.menu.BaseItem",
+ "desc" : "The BaseItem that was clicked",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "mouseout",
+ "type" : "function",
+ "desc" : "Fires when the mouse exits this menu",
+ "sig" : "function (_self, e, menuItem)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "menuItem",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was clicked",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "mouseover",
+ "type" : "function",
+ "desc" : "Fires when the mouse is hovering over this menu",
+ "sig" : "function (_self, e, menuItem)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "menuItem",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was clicked",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
{
"name" : "show",
"type" : "function",
- "desc" : "Fires after the component is shown.",
+ "desc" : "Fires after this menu is displayed",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
}
{
"name" : "hide",
"type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
+ "desc" : "Hides this menu and optionally all parent menus",
+ "sig" : "(deep)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "deep",
+ "type" : "Boolean",
+ "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
],
"returns" : []
},
- {
- "name" : "setTitle",
- "type" : "function",
- "desc" : "Updates the box title",
- "sig" : "(html)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "html",
- "type" : "String",
- "desc" : "to set the title to.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
{
"name" : "show",
"type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
+ "desc" : "Displays this menu relative to another element",
+ "sig" : "(element, position, parentMenu)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "element",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element to align to",
+ "isOptional" : false
+ },
+ {
+ "name" : "position",
+ "type" : "String",
+ "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)",
+ "isOptional" : false
+ },
+ {
+ "name" : "parentMenu",
+ "type" : "Roo.menu.Menu",
+ "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "showAt",
+ "type" : "function",
+ "desc" : "Displays this menu at a specific xy position",
+ "sig" : "(xyPosition, parentMenu)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "xyPosition",
+ "type" : "Array",
+ "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)",
+ "isOptional" : false
+ },
+ {
+ "name" : "parentMenu",
+ "type" : "Roo.menu.Menu",
+ "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
}
]
},
- "Roo.bootstrap.dash.TabPane" : {
+ "Roo.bootstrap.menu.Separator" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "active",
- "type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : ""
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "title",
- "type" : "String",
- "desc" : "title of panel",
- "memberOf" : ""
- },
{
"name" : "tooltip",
"type" : "string",
}
],
"events" : [
- {
- "name" : "activate",
- "type" : "function",
- "desc" : "When a pane is activated",
- "sig" : "function (pane)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "pane",
- "type" : "Roo.bootstrap.dash.TabPane",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setTitle",
- "type" : "function",
- "desc" : "Updates the tab title",
- "sig" : "(html)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "html",
- "type" : "String",
- "desc" : "to set the title to.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
}
]
},
- "Roo.bootstrap.htmleditor" : {
+ "Roo.bootstrap.nav" : {
"props" : [],
"events" : [],
"methods" : []
},
- "Roo.bootstrap.htmleditor.ToolbarStandard" : {
+ "Roo.bootstrap.nav.Bar" : {
"props" : [
{
- "name" : "btns",
- "type" : "Array",
- "desc" : "List of additional buttons.\n\n\nNEEDS Extra CSS? \n.x-html-editor-tb .x-edit-none .x-btn-text { background: none; }",
- "memberOf" : ""
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "disable",
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "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" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "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" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "listeners",
"type" : "Object",
- "desc" : "List of elements to disable..",
- "memberOf" : ""
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "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" : [],
- "methods" : [
+ "events" : [
{
- "name" : "updateToolbar",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforehide",
+ "type" : "function",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforerender",
+ "type" : "function",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforetoggle",
+ "type" : "function",
+ "desc" : "Fire before toggle the menu",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
- }
- ]
- },
- "Roo.bootstrap.layout" : {
- "props" : [],
- "events" : [],
- "methods" : []
- },
- "Roo.bootstrap.layout.Basic" : {
- "props" : [
+ },
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "mgr",
- "type" : "Roo.bootstrap.layout.Manager",
- "desc" : "The manager",
- "memberOf" : ""
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "region",
- "type" : "string",
- "desc" : "the region that it inhabits..",
- "memberOf" : ""
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "skipConfig",
- "type" : "bool",
- "desc" : "skip config?",
- "memberOf" : ""
- }
- ],
- "events" : [],
- "methods" : [
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
- "name" : "add",
+ "name" : "hide",
"type" : "function",
- "desc" : "Add the passed ContentPanel(s)",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "ContentPanel...",
- "desc" : "The ContentPanel(s) to add (you can pass more than one)",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel added (if only one was added)"
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
{
"name" : "addEvents",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Collapse the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expand the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
]
},
{
- "name" : "getActivePanel",
+ "name" : "focus",
"type" : "function",
- "desc" : "Get the active panel for this region.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The active panel or null"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getEl",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Returns the container element for this region.",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Roo.Element",
- "desc" : ""
+ "desc" : "defaults to this.el"
}
]
},
{
- "name" : "getPanel",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns the panel specified or null if it's not in this region.",
- "sig" : "(panel)",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "getPosition",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns this regions position (north/south/east/west/center).",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
+ {
+ "name" : "getVisibilityEl",
+ "type" : "function",
+ "desc" : "Get the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "hasListener",
"type" : "function",
]
},
{
- "name" : "hasPanel",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns true if the panel is in this region.",
- "sig" : "(panel)",
+ "desc" : "Hide a component - adds 'hidden' class",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "initEvents",
+ "type" : "function",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
"name" : "isVisible",
"type" : "function",
- "desc" : "Returns true if this region is currently visible.",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
"name" : "on",
"returns" : []
},
{
- "name" : "remove",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
- "sig" : "(panel, preservePanel)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "preservePanel",
- "type" : "Boolean",
- "desc" : "Overrides the config preservePanel option",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel that was removed"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "removeListener",
+ "name" : "render",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resizeTo",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
- "sig" : "(newSize)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new width or height",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "showPanel",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Show the specified panel.",
- "sig" : "(panelId)",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panelId",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The shown panel or null"
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
}
]
},
- "Roo.bootstrap.layout.Border" : {
+ "Roo.bootstrap.nav.Group" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : ""
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "",
+ "memberOf" : ""
+ },
{
"name" : "listeners",
"type" : "Object",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "navId",
+ "type" : "String",
+ "desc" : "- reference Id for navbar.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "pilltype",
+ "type" : "Boolean",
+ "desc" : "default true (turn to off to disable active toggle)",
+ "memberOf" : ""
+ },
{
"name" : "style",
"type" : "String",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "type",
+ "type" : "String",
+ "desc" : "b) default nav",
+ "memberOf" : ""
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "changed",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "Fires when the active item changes",
+ "sig" : "function (_self, selected, prev)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "type" : "Roo.bootstrap.nav.Group",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "selected",
+ "type" : "Roo.bootstrap.Navbar.Item",
+ "desc" : "The item selected",
+ "isOptional" : false
+ },
+ {
+ "name" : "prev",
+ "type" : "Roo.bootstrap.Navbar.Item",
+ "desc" : "The previously selected item",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
+ "desc" : "Fires when the children have been rendered..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "disable",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
+ "desc" : "Fires after the component is destroyed.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "enable",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
+ "desc" : "Fires after the component is disabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "hide",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires after the component is enabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "layout",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires when a layout is performed.",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.layout.Manager",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutManager",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "regioncollapsed",
- "type" : "function",
- "desc" : "Fires when a region is collapsed.",
- "sig" : "function (region)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.layout.Manager",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The collapsed region",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "regionexpanded",
- "type" : "function",
- "desc" : "Fires when a region is expanded.",
- "sig" : "function (region)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.layout.Manager",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The expanded region",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "regionresized",
- "type" : "function",
- "desc" : "Fires when the user resizes a region.",
- "sig" : "function (region, newSize)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.layout.Manager",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The resized region",
- "isOptional" : false
- },
- {
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new size (width for east/west, height for north/south)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
],
"methods" : [
{
- "name" : "add",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Adds a ContentPanel (or subclass) to this layout.",
- "sig" : "(target, panel)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "String",
- "desc" : "The target region key (north, south, east, west or center).",
- "isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel to add",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The added panel"
- }
- ]
+ "returns" : []
},
{
- "name" : "addEvents",
+ "name" : "addItem",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "adds a Navigation item",
+ "sig" : "(the)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "the",
+ "type" : "Roo.bootstrap.nav.Item",
+ "desc" : "navitem to add",
"isOptional" : false
}
],
],
"returns" : []
},
- {
- "name" : "addRegion",
- "type" : "function",
- "desc" : "Creates and adds a new region if it doesn't already exist.",
- "sig" : "(target, config)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "target",
- "type" : "String",
- "desc" : "The target region key (north, south, east, west or center).",
- "isOptional" : false
- },
- {
- "name" : "config",
- "type" : "Object",
- "desc" : "The regions config object",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "BorderLayoutRegion",
- "desc" : "The new region"
- }
- ]
- },
- {
- "name" : "addxtype",
- "type" : "function",
- "desc" : "Adds a xtype elements to the layout.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'ContentPanel',\n region: 'west',\n items: [ .... ]\n }\n);\n\nlayout.addxtype({\n xtype : 'NestedLayoutPanel',\n region: 'west',\n layout: {\n center: { },\n west: { } \n },\n items : [ ... list of content panels or nested layout panels.. ]\n }\n);\n</code></pre>",
- "sig" : "(cfg)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "cfg",
- "type" : "Object",
- "desc" : "Xtype definition of item to add.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beginUpdate",
- "type" : "function",
- "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "clearAll",
"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" : "clear all the Navigation item",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "disable",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Disable this component.",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "enable",
+ "name" : "disable",
"type" : "function",
- "desc" : "Enable this component.",
+ "desc" : "Disable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component",
]
},
{
- "name" : "endUpdate",
- "type" : "function",
- "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
- "sig" : "(noLayout)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "noLayout",
- "type" : "Boolean",
- "desc" : "true to disable a layout update",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "findPanel",
+ "name" : "enable",
"type" : "function",
- "desc" : "Searches all regions for a panel with the specified id",
- "sig" : "(panelId)",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "panelId",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel or null if it wasn't found"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
]
},
{
- "name" : "getChildContainer",
+ "name" : "get",
"type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
+ "desc" : "fetch a Navigation Group based on the navigation ID",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "name" : "the",
+ "type" : "string",
+ "desc" : "navgroup to add",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getEl",
+ "name" : "getActive",
"type" : "function",
- "desc" : "Returns the Element this layout is bound to.",
+ "desc" : "gets the active Navigation item",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : ""
+ "type" : "Roo.bootstrap.nav.Item",
+ "desc" : "the current navitem"
}
]
},
{
- "name" : "getId",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
{
- "name" : "getRegion",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns the specified region.",
- "sig" : "(target)",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "target",
- "type" : "String",
- "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.LayoutRegion",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "getViewSize",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "The size as an object {width: (the width), height: (the height)}"
+ "type" : "String",
+ "desc" : ""
}
]
},
"params" : [],
"returns" : []
},
- {
- "name" : "isUpdating",
- "type" : "function",
- "desc" : "Returns true if this layout is currently being updated",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
- },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "layout",
- "type" : "function",
- "desc" : "Performs a layout update.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "register",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "register a Navigation item",
+ "sig" : "(the)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "the",
+ "type" : "Roo.bootstrap.nav.Item",
+ "desc" : "navitem to add",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "register",
"type" : "function",
- "desc" : "Remove a ContentPanel (or subclass) to this layout.",
- "sig" : "(target, panel)",
- "static" : false,
+ "desc" : "register a Navigation Group",
+ "sig" : "(the)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "String",
- "desc" : "The target region key (north, south, east, west or center).",
- "isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Number/String/Roo.ContentPanel",
- "desc" : "The index, id or panel to remove",
+ "name" : "the",
+ "type" : "Roo.bootstrap.nav.Group",
+ "desc" : "navgroup to add",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The removed panel"
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
"name" : "removeListener",
],
"returns" : []
},
+ {
+ "name" : "setActiveItem",
+ "type" : "function",
+ "desc" : "sets the active Navigation item",
+ "sig" : "(the)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "Roo.bootstrap.nav.Item",
+ "desc" : "new current navitem",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "showPanel",
- "type" : "function",
- "desc" : "Searches all regions for a panel with the specified id and activates (shows) it.",
- "sig" : "(panelId)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panelId",
- "type" : "String/ContentPanel",
- "desc" : "The panels id or the panel itself",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The shown panel or null"
- }
- ]
- },
{
"name" : "tooltipEl",
"type" : "function",
}
]
},
- "Roo.bootstrap.layout.Manager" : {
+ "Roo.bootstrap.nav.Headerbar" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) alignment",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "arrangement",
+ "type" : "Boolean",
+ "desc" : "stacked | justified",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
+ {
+ "name" : "autohide",
+ "type" : "Boolean",
+ "desc" : "a top nav bar header that hides on scroll.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "brand",
+ "type" : "String",
+ "desc" : "what is brand",
+ "memberOf" : ""
+ },
+ {
+ "name" : "brand_href",
+ "type" : "String",
+ "desc" : "href of the brand",
+ "memberOf" : ""
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "desktopCenter",
+ "type" : "Boolean",
+ "desc" : "should the header be centered on desktop using a container class",
+ "memberOf" : ""
+ },
{
"name" : "disableClass",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "is inverted color",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
{
"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" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "e) loadMask on the bar",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
+ {
+ "name" : "main",
+ "type" : "Boolean",
+ "desc" : "e) main nav bar? default false",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
+ {
+ "name" : "mobilerow",
+ "type" : "Roo.bootstrap.Row",
+ "desc" : "- a row to display on mobile only..",
+ "memberOf" : ""
+ },
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "position",
+ "type" : "String",
+ "desc" : "p) position",
+ "memberOf" : ""
+ },
+ {
+ "name" : "srButton",
+ "type" : "Boolean",
+ "desc" : "generate the (screen reader / mobile) sr-only button default true",
+ "memberOf" : ""
+ },
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "v) default is nav",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "type",
+ "type" : "String",
+ "desc" : "s)",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "e) default is light.",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
{
"name" : "xattr",
"type" : "Object",
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "beforetoggle",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "Fire before toggle the menu",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
+ "desc" : "Fires when the children have been rendered..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "disable",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
+ "desc" : "Fires after the component is destroyed.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "enable",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
+ "desc" : "Fires after the component is disabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "hide",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires after the component is enabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "layout",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires when a layout is performed.",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutManager",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "regioncollapsed",
- "type" : "function",
- "desc" : "Fires when a region is collapsed.",
- "sig" : "function (region)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The collapsed region",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "regionexpanded",
- "type" : "function",
- "desc" : "Fires when a region is expanded.",
- "sig" : "function (region)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The expanded region",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "regionresized",
- "type" : "function",
- "desc" : "Fires when the user resizes a region.",
- "sig" : "function (region, newSize)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The resized region",
- "isOptional" : false
- },
- {
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new size (width for east/west, height for north/south)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "beginUpdate",
- "type" : "function",
- "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Collapse the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
]
},
{
- "name" : "endUpdate",
+ "name" : "expand",
"type" : "function",
- "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
- "sig" : "(noLayout)",
+ "desc" : "Expand the navbar pulldown",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "noLayout",
- "type" : "Boolean",
- "desc" : "true to disable a layout update",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
{
"name" : "getEl",
"type" : "function",
- "desc" : "Returns the Element this layout is bound to.",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Roo.Element",
- "desc" : ""
+ "desc" : "The element"
}
]
},
}
]
},
- {
- "name" : "getRegion",
- "type" : "function",
- "desc" : "Returns the specified region.",
- "sig" : "(target)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "target",
- "type" : "String",
- "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.LayoutRegion",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getViewSize",
- "type" : "function",
- "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "The size as an object {width: (the width), height: (the height)}"
- }
- ]
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "isUpdating",
- "type" : "function",
- "desc" : "Returns true if this layout is currently being updated",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
- },
{
"name" : "isVisible",
"type" : "function",
}
]
},
- "Roo.bootstrap.layout.Region" : {
+ "Roo.bootstrap.nav.Item" : {
"props" : [
{
- "name" : "alwaysShowTabs",
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "active",
"type" : "Boolean",
- "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
+ "desc" : "Is item active",
"memberOf" : ""
},
{
- "name" : "animate",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "True to animate expand/collapse (defaults to false)",
- "memberOf" : ""
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "autoHide",
+ "name" : "animateRef",
"type" : "Boolean",
- "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
+ "desc" : "e) link to element default false",
"memberOf" : ""
},
{
- "name" : "autoScroll",
- "type" : "Boolean",
- "desc" : "True to enable overflow scrolling (defaults to false)",
+ "name" : "badge",
+ "type" : "String",
+ "desc" : "text inside badge",
"memberOf" : ""
},
{
- "name" : "closeOnTab",
- "type" : "Boolean",
- "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
+ "name" : "badgecls",
+ "type" : "String",
+ "desc" : "w)the extra classes for the badge",
"memberOf" : ""
},
{
- "name" : "cls",
- "type" : "string",
- "desc" : "Extra CSS classes to add to region",
+ "name" : "button_outline",
+ "type" : "Boolean",
+ "desc" : "show and outlined button",
"memberOf" : ""
},
{
- "name" : "cmargins",
- "type" : "Object",
- "desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})",
+ "name" : "button_weight",
+ "type" : "String",
+ "desc" : "k) default none",
"memberOf" : ""
},
{
- "name" : "disableTabTips",
+ "name" : "can_build_overlaid",
"type" : "Boolean",
- "desc" : "True to disable tab tooltips",
- "memberOf" : ""
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "For North/South panels",
- "memberOf" : ""
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "True to start the region hidden (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" : "hideTabs",
- "type" : "Boolean",
- "desc" : "True to hide the tab strip (defaults to false)",
- "memberOf" : ""
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "hideWhenEmpty",
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "disabled",
"type" : "Boolean",
- "desc" : "True to hide the region when it has no panels",
+ "desc" : "Is item disabled",
"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" : "fa",
+ "type" : "String",
+ "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)",
+ "memberOf" : ""
},
{
- "name" : "margins",
- "type" : "Object",
- "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
+ "name" : "glyphicon",
+ "type" : "String",
+ "desc" : "DEPRICATED - use fa",
"memberOf" : ""
},
{
- "name" : "mgr",
- "type" : "Roo.bootstrap.layout.Manager",
- "desc" : "The manager",
- "memberOf" : ""
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "minTabWidth",
- "type" : "Number",
- "desc" : "The minimum tab width (defaults to 40)",
+ "name" : "href",
+ "type" : "String",
+ "desc" : "link to",
"memberOf" : ""
},
{
- "name" : "overflow",
+ "name" : "html",
"type" : "String",
- "desc" : "e) if you have menus in the region, then you need to set this to visible.",
+ "desc" : "content of button",
"memberOf" : ""
},
{
- "name" : "preferredTabWidth",
- "type" : "Number",
- "desc" : "The preferred tab width (defaults to 150)",
+ "name" : "icon",
+ "type" : "String",
+ "desc" : "DEPRICATED - use fa",
"memberOf" : ""
},
{
- "name" : "preservePanels",
- "type" : "Boolean",
- "desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
+ "name" : "linkcls",
+ "type" : "String",
+ "desc" : "Link Class",
"memberOf" : ""
},
{
- "name" : "region",
- "type" : "string",
- "desc" : "the region that it inhabits..",
- "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" : "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)",
+ "name" : "menu",
+ "type" : "Roo.bootstrap.menu.Menu",
+ "desc" : "a Menu",
"memberOf" : ""
},
{
- "name" : "skipConfig",
- "type" : "bool",
- "desc" : "skip config?",
- "memberOf" : "Roo.bootstrap.layout.Basic"
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "split",
+ "name" : "preventDefault",
"type" : "Boolean",
- "desc" : "To show the splitter",
+ "desc" : "e) default false",
"memberOf" : ""
},
{
- "name" : "tabPosition",
+ "name" : "style",
"type" : "String",
- "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom\")",
- "memberOf" : ""
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "title",
+ "name" : "tabId",
"type" : "String",
- "desc" : "The title for the region (overrides panel titles)",
+ "desc" : "the tab that this item activates.",
"memberOf" : ""
},
{
- "name" : "titlebar",
- "type" : "Boolean",
- "desc" : "True to display a title bar (defaults to true)",
+ "name" : "tagtype",
+ "type" : "String",
+ "desc" : "n) render as a href or span?",
"memberOf" : ""
},
{
- "name" : "toolbar",
- "type" : "Boolean",
- "desc" : "xtype configuration for a toolbar - shows on right of tabbar",
- "memberOf" : ""
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "For East/West panels",
- "memberOf" : ""
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "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" : [],
- "methods" : [
+ "events" : [
{
- "name" : "add",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Adds the passed ContentPanel(s) to this region.",
- "sig" : "(panel)",
- "static" : false,
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforehide",
+ "type" : "function",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforerender",
+ "type" : "function",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "changed",
+ "type" : "function",
+ "desc" : "Fires when the active item active state changes",
+ "sig" : "function (_self, state)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "ContentPanel...",
- "desc" : "The ContentPanel(s) to add (you can pass more than one)",
+ "name" : "this",
+ "type" : "Roo.bootstrap.nav.Item",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "state",
+ "type" : "boolean",
+ "desc" : "the new state",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel added (if only one was added; null otherwise)"
+ "name" : "this",
+ "type" : "Roo.bootstrap.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "The raw click event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "scrollto",
+ "type" : "function",
+ "desc" : "Fires when scroll to element",
+ "sig" : "function (_self, options, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.nav.Item",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "animateCollapse",
+ "name" : "capture",
"type" : "function",
- "desc" : "Collapses this region.",
- "sig" : "(skipAnim)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "skipAnim",
- "type" : "Boolean",
- "desc" : "(optional) true to collapse the element without animation (if animate is true)",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "animateExpand",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Expands this region if it was previously collapsed.",
- "sig" : "(e, skipAnim)",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event that triggered the expand (or null if calling manually)",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "skipAnim",
- "type" : "Boolean",
- "desc" : "(optional) true to expand the element without animation (if animate is true)",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "capture",
+ "name" : "enable",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
"name" : "fireEvent",
]
},
{
- "name" : "getActivePanel",
- "type" : "function",
- "desc" : "Get the active panel for this region.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The active panel or null"
- }
- ]
- },
- {
- "name" : "getBox",
+ "name" : "focus",
"type" : "function",
- "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)",
- "sig" : "(title)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "title",
- "type" : "String",
- "desc" : "(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, \"&#160;\")",
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "getEl",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Returns the container element for this region.",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Roo.Element",
- "desc" : ""
+ "desc" : "defaults to this.el"
}
]
},
{
- "name" : "getPanel",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns the panel specified or null if it's not in this region.",
- "sig" : "(panel)",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Basic",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "getPosition",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns this regions position (north/south/east/west/center).",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Basic",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
]
},
{
- "name" : "getTabs",
+ "name" : "getVisibilityEl",
"type" : "function",
- "desc" : "Returns the TabPanel component used by this region",
+ "desc" : "Get the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.TabPanel",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
"name" : "hasListener",
}
]
},
- {
- "name" : "hasPanel",
- "type" : "function",
- "desc" : "Returns true if the panel is in this region.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.layout.Basic",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
- },
{
"name" : "hide",
"type" : "function",
- "desc" : "Hides this region.",
+ "desc" : "Hide a component - adds 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "hidePanel",
+ "name" : "initEvents",
"type" : "function",
- "desc" : "Hides the tab for the specified panel.",
- "sig" : "(panel)",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
"name" : "isVisible",
"type" : "function",
- "desc" : "Returns true if this region is currently visible.",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
"name" : "on",
"returns" : []
},
{
- "name" : "remove",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
- "sig" : "(panel, preservePanel)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "preservePanel",
- "type" : "Boolean",
- "desc" : "Overrides the config preservePanel option",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel that was removed"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "removeListener",
+ "name" : "render",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resizeTo",
+ "name" : "setHtml",
"type" : "function",
- "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
- "sig" : "(newSize)",
+ "desc" : "Set the HTML (text content) of the item",
+ "sig" : "(html)",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Basic",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new width or height",
+ "name" : "html",
+ "type" : "string",
+ "desc" : "content for the nav item",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Shows this region if it was previously hidden.",
+ "desc" : "Set the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "showPanel",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Shows the specified panel.",
- "sig" : "(panelId)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panelId",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The shown panel, or null if a panel could not be found from panelId"
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
}
],
"returns" : []
- },
- {
- "name" : "unhidePanel",
- "type" : "function",
- "desc" : "Unhides the tab for a previously hidden panel.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
- "isOptional" : false
- }
- ],
- "returns" : []
}
]
},
- "Roo.bootstrap.layout.Split" : {
+ "Roo.bootstrap.nav.ProgressBar" : {
"props" : [
{
- "name" : "alwaysShowTabs",
- "type" : "Boolean",
- "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "animate",
- "type" : "Boolean",
- "desc" : "True to animate expand/collapse (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "autoHide",
- "type" : "Boolean",
- "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "autoScroll",
- "type" : "Boolean",
- "desc" : "True to enable overflow scrolling (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "closeOnTab",
- "type" : "Boolean",
- "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "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" : "collapsed",
- "type" : "Boolean",
- "desc" : "True to set the initial display to collapsed (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "NavProgressBar:bullets[]",
+ "type" : "Roo.bootstrap.nav.ProgressItem",
+ "desc" : "Bullets for the Nav Progress bar for the toolbar",
+ "memberOf" : ""
},
{
- "name" : "collapsedTitle",
+ "name" : "actionMode",
"type" : "String",
- "desc" : "Optional string message to display in the collapsed block of a north or south region",
- "memberOf" : "Roo.LayoutRegion"
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "collapsible",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "False to disable collapsing (defaults to true)",
- "memberOf" : "Roo.LayoutRegion"
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "disableTabTips",
+ "name" : "can_build_overlaid",
"type" : "Boolean",
- "desc" : "True to disable tab tooltips",
- "memberOf" : "Roo.LayoutRegion"
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "floatable",
- "type" : "Boolean",
- "desc" : "False to disable floating (defaults to true)",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "For North/South panels",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "True to start the region hidden (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "hideTabs",
- "type" : "Boolean",
- "desc" : "True to hide the tab strip (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" : "hideWhenEmpty",
- "type" : "Boolean",
- "desc" : "True to hide the region when it has no panels",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component"
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "margins",
- "type" : "Object",
- "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "minTabWidth",
- "type" : "Number",
- "desc" : "The minimum tab width (defaults to 40)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "preferredTabWidth",
- "type" : "Number",
- "desc" : "The preferred tab width (defaults to 150)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "preservePanels",
- "type" : "Boolean",
- "desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "resizeTabs",
- "type" : "Boolean",
- "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "showPin",
- "type" : "Boolean",
- "desc" : "True to show a pin button",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "split",
- "type" : "Boolean",
- "desc" : "To show the splitter",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "tabPosition",
- "type" : "String",
- "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom\")",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "title",
+ "name" : "style",
"type" : "String",
- "desc" : "The title for the region (overrides panel titles)",
- "memberOf" : "Roo.LayoutRegion"
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "titlebar",
- "type" : "Boolean",
- "desc" : "True to display a title bar (defaults to true)",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "toolbar",
- "type" : "Boolean",
- "desc" : "xtype configuration for a toolbar - shows on right of tabbar",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "For East/West panels",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component"
}
],
"events" : [
{
- "name" : "beforecollapse",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fires when this region before collapse.",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforeremove",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument.",
- "sig" : "function (_self, panel, e)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Object",
- "desc" : "The cancel event object",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "collapsed",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires when this region is collapsed.",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "expanded",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Fires when this region is expanded.",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "invalidated",
+ "name" : "changed",
"type" : "function",
- "desc" : "Fires when the layout for this region is changed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires when the active item changes",
+ "sig" : "function (_self, selected, prev)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.bootstrap.nav.ProgressBar",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "selected",
+ "type" : "Roo.bootstrap.nav.ProgressItem",
+ "desc" : "The item selected",
+ "isOptional" : false
+ },
+ {
+ "name" : "prev",
+ "type" : "Roo.bootstrap.nav.ProgressItem",
+ "desc" : "The previously selected item",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "panelactivated",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires when a panel is activated.",
- "sig" : "function (_self, panel)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The activated panel",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "paneladded",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires when a panel is added.",
- "sig" : "function (_self, panel)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "panelremoved",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires when a panel is removed.",
- "sig" : "function (_self, panel)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resized",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires when the user resizes this region.",
- "sig" : "function (_self, newSize)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new size (width for east/west, height for north/south)",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "slidehide",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires when this region slides out of view.",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "slideshow",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires when this region is slid into view.",
+ "desc" : "Fires after the component is rendered.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "visibilitychange",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires when this region is shown or hidden",
- "sig" : "function (_self, visibility)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "visibility",
- "type" : "Boolean",
- "desc" : "true or false",
- "isOptional" : false
}
],
"returns" : []
}
],
"methods" : [
- {
- "name" : "add",
- "type" : "function",
- "desc" : "Adds the passed ContentPanel(s) to this region.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "Roo.LayoutRegion",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "ContentPanel...",
- "desc" : "The ContentPanel(s) to add (you can pass more than one)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel added (if only one was added; null otherwise)"
- }
- ]
- },
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "collapse",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Collapses this region.",
- "sig" : "(skipAnim)",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "skipAnim",
- "type" : "Boolean",
- "desc" : "(optional) true to collapse the element without animation (if animate is true)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "expand",
+ "name" : "disable",
"type" : "function",
- "desc" : "Expands this region if it was previously collapsed.",
- "sig" : "(e, skipAnim)",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event that triggered the expand (or null if calling manually)",
- "isOptional" : false
- },
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "skipAnim",
- "type" : "Boolean",
- "desc" : "(optional) true to expand the element without animation (if animate is true)",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
"name" : "fireEvent",
]
},
{
- "name" : "getActivePanel",
+ "name" : "focus",
"type" : "function",
- "desc" : "Get the active panel for this region.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The active panel or null"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getEl",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Returns the container element for this region.",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Roo.Element",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getPanel",
- "type" : "function",
- "desc" : "Returns the panel specified or null if it's not in this region.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "Roo.BasicLayoutRegion",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : ""
+ "desc" : "defaults to this.el"
}
]
},
{
- "name" : "getPosition",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns this regions position (north/south/east/west/center).",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "getSplitBar",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns the {@link Roo.SplitBar} for this region.",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.SplitBar",
+ "type" : "String",
"desc" : ""
}
]
},
{
- "name" : "getTabs",
+ "name" : "getVisibilityEl",
"type" : "function",
- "desc" : "Returns the TabPanel component used by this region",
+ "desc" : "Get the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.TabPanel",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
"name" : "hasListener",
}
]
},
- {
- "name" : "hasPanel",
- "type" : "function",
- "desc" : "Returns true if the panel is in this region.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "Roo.BasicLayoutRegion",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
- },
{
"name" : "hide",
"type" : "function",
- "desc" : "Hides this region.",
+ "desc" : "Hide a component - adds 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "hidePanel",
+ "name" : "initEvents",
"type" : "function",
- "desc" : "Hides the tab for the specified panel.",
- "sig" : "(panel)",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
"name" : "isVisible",
"type" : "function",
- "desc" : "Returns true if this region is currently visible.",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
"name" : "on",
],
"returns" : []
},
- {
- "name" : "remove",
- "type" : "function",
- "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
- "sig" : "(panel, preservePanel)",
- "static" : false,
- "memberOf" : "Roo.LayoutRegion",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
- "isOptional" : false
- },
- {
- "name" : "preservePanel",
- "type" : "Boolean",
- "desc" : "Overrides the config preservePanel option",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel that was removed"
- }
- ]
- },
{
"name" : "removeListener",
"type" : "function",
"returns" : []
},
{
- "name" : "resizeTo",
+ "name" : "render",
"type" : "function",
- "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
- "sig" : "(newSize)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new width or height",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setCollapsedTitle",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)",
- "sig" : "(title)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "title",
- "type" : "String",
- "desc" : "(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, \"&#160;\")",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Shows this region if it was previously hidden.",
+ "desc" : "Set the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "showPanel",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Shows the specified panel.",
- "sig" : "(panelId)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panelId",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The shown panel, or null if a panel could not be found from panelId"
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
}
],
"returns" : []
- },
- {
- "name" : "unhidePanel",
- "type" : "function",
- "desc" : "Unhides the tab for a previously hidden panel.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "Roo.LayoutRegion",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
- "isOptional" : false
- }
- ],
- "returns" : []
}
]
},
- "Roo.bootstrap.menu" : {
- "props" : [],
- "events" : [],
- "methods" : []
- },
- "Roo.bootstrap.menu.Item" : {
+ "Roo.bootstrap.nav.ProgressBarItem" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "active",
+ "type" : "Boolean",
+ "desc" : "e) Is item active default false",
+ "memberOf" : ""
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "disable",
- "type" : "Boolean",
- "desc" : "e) default false",
- "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" : "disabled",
+ "type" : "Boolean",
+ "desc" : "e) Is item active default false",
+ "memberOf" : ""
+ },
{
"name" : "hideMode",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
- {
- "name" : "href",
- "type" : "String",
- "desc" : "the link",
- "memberOf" : ""
- },
{
"name" : "html",
"type" : "String",
- "desc" : "text of the item",
+ "desc" : "",
"memberOf" : ""
},
{
"name" : "icon",
"type" : "String",
- "desc" : "Font awesome icon",
+ "desc" : "show icon instead of number",
"memberOf" : ""
},
{
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "pos",
+ "name" : "position",
"type" : "String",
- "desc" : "Submenu align to (left | right) default right",
+ "desc" : "m) text position default bottom",
"memberOf" : ""
},
{
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "e) default true",
+ "name" : "rid",
+ "type" : "String",
+ "desc" : "the reference id",
"memberOf" : ""
},
{
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "submenu",
- "type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
- },
{
"name" : "tooltip",
"type" : "string",
"name" : "click",
"type" : "function",
"desc" : "The raw click event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
+ "sig" : "function (_self, e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.nav.ProgressBarItem",
+ "desc" : "",
+ "isOptional" : false
+ },
{
"name" : "e",
"type" : "Roo.EventObject",
],
"returns" : []
},
- {
- "name" : "mouseout",
- "type" : "function",
- "desc" : "Fires when the mouse exits this menu",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.menu.Item",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "mouseover",
- "type" : "function",
- "desc" : "Fires when the mouse is hovering over this menu",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.menu.Item",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
}
]
},
- "Roo.bootstrap.menu.Menu" : {
+ "Roo.bootstrap.nav.Sidebar" : {
+ "props" : [],
+ "events" : [],
+ "methods" : []
+ },
+ "Roo.bootstrap.nav.SidebarItem" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "active",
+ "type" : "Boolean",
+ "desc" : "Is item active",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "animateRef",
+ "type" : "Boolean",
+ "desc" : "e) link to element default false",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
+ {
+ "name" : "badge",
+ "type" : "String",
+ "desc" : "text inside badge",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
+ {
+ "name" : "badgecls",
+ "type" : "String",
+ "desc" : "w)the extra classes for the badge",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
+ {
+ "name" : "button_outline",
+ "type" : "Boolean",
+ "desc" : "show and outlined button",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
+ {
+ "name" : "button_weight",
+ "type" : "String",
+ "desc" : "k) default none",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "Is item disabled",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
+ {
+ "name" : "fa",
+ "type" : "String",
+ "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
+ {
+ "name" : "glyphicon",
+ "type" : "String",
+ "desc" : "DEPRICATED - use fa",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
{
"name" : "hideMode",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "href",
+ "type" : "String",
+ "desc" : "link to",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
{
"name" : "html",
"type" : "String",
- "desc" : "Text of the menu",
- "memberOf" : ""
+ "desc" : "content of button",
+ "memberOf" : "Roo.bootstrap.nav.Item"
},
{
"name" : "icon",
"type" : "String",
- "desc" : "Font awesome icon",
- "memberOf" : ""
+ "desc" : "DEPRICATED - use fa",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
+ {
+ "name" : "linkcls",
+ "type" : "String",
+ "desc" : "Link Class",
+ "memberOf" : "Roo.bootstrap.nav.Item"
},
{
"name" : "listeners",
"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" : "menu",
+ "type" : "Roo.bootstrap.menu.Menu",
+ "desc" : "a Menu",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
{
"name" : "name",
"type" : "string",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "pos",
- "type" : "String",
- "desc" : "Menu align to (top | bottom) default bottom",
- "memberOf" : ""
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.nav.Item"
},
{
"name" : "style",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "tabId",
+ "type" : "String",
+ "desc" : "the tab that this item activates.",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
+ {
+ "name" : "tagtype",
+ "type" : "String",
+ "desc" : "n) render as a href or span?",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
{
"name" : "tooltip",
"type" : "string",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "weight",
- "type" : "String",
- "desc" : "e)",
- "memberOf" : ""
- },
{
"name" : "xattr",
"type" : "Object",
{
"name" : "beforehide",
"type" : "function",
- "desc" : "Fires before this menu is hidden",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.menu.Menu",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
{
"name" : "beforeshow",
"type" : "function",
- "desc" : "Fires before this menu is displayed",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
"sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "changed",
+ "type" : "function",
+ "desc" : "Fires when the active item active state changes",
+ "sig" : "function (_self, state)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.menu.Menu",
+ "type" : "Roo.bootstrap.nav.SidebarItem",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "state",
+ "type" : "boolean",
+ "desc" : "the new state",
+ "isOptional" : false
}
],
"returns" : []
{
"name" : "click",
"type" : "function",
- "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)",
- "sig" : "function (_self, e)\n{\n\n}",
+ "desc" : "The raw click event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.menu.Menu",
- "desc" : "",
- "isOptional" : false
- },
{
"name" : "e",
"type" : "Roo.EventObject",
{
"name" : "hide",
"type" : "function",
- "desc" : "Fires after this menu is hidden",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.menu.Menu",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "scrollto",
+ "type" : "function",
+ "desc" : "Fires when scroll to element",
+ "sig" : "function (_self, options, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.nav.Item",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
- "desc" : "Fires after this menu is displayed",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.menu.Menu",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "setHtml",
+ "type" : "function",
+ "desc" : "Set the HTML (text content) of the item",
+ "sig" : "(html)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "html",
+ "type" : "string",
+ "desc" : "content for the nav item",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
"desc" : "Fetch the element to display the tooltip on.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.nav.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
- "Roo.bootstrap.menu.Separator" : {
+ "Roo.bootstrap.nav.Simplebar" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) alignment",
+ "memberOf" : ""
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "arrangement",
+ "type" : "Boolean",
+ "desc" : "stacked | justified",
+ "memberOf" : ""
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "is inverted color",
+ "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" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "e) loadMask on the bar",
+ "memberOf" : ""
+ },
+ {
+ "name" : "main",
+ "type" : "Boolean",
+ "desc" : "e) main nav bar? default false",
+ "memberOf" : ""
+ },
{
"name" : "name",
"type" : "string",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "v) default is nav",
+ "memberOf" : ""
+ },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "type",
+ "type" : "String",
+ "desc" : "s)",
+ "memberOf" : ""
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "e) default is light.",
+ "memberOf" : ""
+ },
{
"name" : "xattr",
"type" : "Object",
],
"returns" : []
},
+ {
+ "name" : "beforetoggle",
+ "type" : "function",
+ "desc" : "Fire before toggle the menu",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Collapse the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expand the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
{
"name" : "region",
"type" : "String",
- "desc" : "t) which region to put this panel on (when used with xtype constructors)",
+ "desc" : "[required] (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
"memberOf" : ""
},
{
{
"name" : "region",
"type" : "String",
- "desc" : "t) which region to put this panel on (when used with xtype constructors)",
+ "desc" : "[required] (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
"memberOf" : "Roo.bootstrap.panel.Content"
},
{
},
{
"name" : "toolbar",
- "type" : "Toolbar",
- "desc" : "A toolbar for this panel",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "type" : "Roo.bootstrap.nav.Simplebar",
+ "desc" : "the toolbar at the top of the grid.",
+ "memberOf" : ""
},
{
"name" : "url",
"desc" : "contents are an iframe - makes showing remote sources/CSS feasible..",
"memberOf" : "Roo.bootstrap.panel.Content"
},
+ {
+ "name" : "layout",
+ "type" : "Roo.BorderLayout",
+ "desc" : "The layout for this panel",
+ "memberOf" : ""
+ },
{
"name" : "listeners",
"type" : "Object",
{
"name" : "region",
"type" : "String",
- "desc" : "t) which region to put this panel on (when used with xtype constructors)",
+ "desc" : "[required] (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
"memberOf" : "Roo.bootstrap.panel.Content"
},
{
projects / roojs1 / blobdiff