{
- "name" : "Roo.bootstrap.Form",
+ "name" : "Roo.bootstrap.form.Form",
"augments" : [
"Roo.bootstrap.Component",
"Roo.Component",
"Roo.util.Observable"
],
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.layout.Border",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : [],
"desc" : "Bootstrap Form class",
"isSingleton" : false,
"isStatic" : false,
"isBuiltin" : false,
+ "isAbstract" : false,
+ "isBuilderTop" : false,
"memberOf" : "Form",
"example" : "",
"deprecated" : "",
}
],
"returns" : [],
+ "throws" : "",
+ "requires" : "",
"config" : [
{
"name" : "labelAlign",
"type" : "String",
"desc" : "top | left (default top)",
- "memberOf" : "Roo.bootstrap.Form",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.form.Form"
},
{
"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",
- "optvals" : []
+ "memberOf" : "Roo.util.Observable"
},
{
"name" : "fileUpload",
"type" : "Boolean",
"desc" : "Set to true if this form is a file upload.",
- "memberOf" : "Roo.bootstrap.Form",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.form.Form"
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "visibilityEl",
"type" : "string|object",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component",
- "optvals" : [
- "el",
- "parent"
- ]
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "align",
"type" : "String",
"desc" : "left | right - for navbars",
- "memberOf" : "Roo.bootstrap.Form",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.form.Form"
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.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",
- "optvals" : [
- "display",
- "visibility"
- ]
+ "memberOf" : "Roo.Component"
},
{
"name" : "method",
"type" : "String",
"desc" : "GET | POST (default POST)",
- "memberOf" : "Roo.bootstrap.Form",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.form.Form"
},
{
"name" : "errorMask",
"type" : "Boolean",
"desc" : "e) default false",
- "memberOf" : "Roo.bootstrap.Form",
- "optvals" : [
- "true",
- "false"
- ]
+ "memberOf" : "Roo.bootstrap.form.Form"
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "optvals" : []
+ "memberOf" : "Roo.Component"
},
{
"name" : "timeout",
"type" : "Number",
"desc" : "Timeout for form actions in seconds (default is 30 seconds).",
- "memberOf" : "Roo.bootstrap.Form",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.form.Form"
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "loadMask",
"type" : "Boolean",
"desc" : "load mask when submit (default true)",
- "memberOf" : "Roo.bootstrap.Form",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.form.Form"
},
{
"name" : "baseParams",
"type" : "Object",
"desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
- "memberOf" : "Roo.bootstrap.Form",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.form.Form"
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"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",
- "optvals" : []
+ "memberOf" : "Roo.Component"
},
{
"name" : "maskBody",
"type" : "Boolean",
"desc" : "",
- "memberOf" : "Roo.bootstrap.Form",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.form.Form"
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "url",
"type" : "String",
"desc" : "The URL to use for form actions if one isn't supplied in the action options.",
- "memberOf" : "Roo.bootstrap.Form",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.form.Form"
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
- "optvals" : []
+ "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",
- "optvals" : []
+ "memberOf" : "Roo.Component"
},
{
"name" : "maskOffset",
"type" : "Number",
"desc" : "Default 100",
- "memberOf" : "Roo.bootstrap.Form",
- "optvals" : []
+ "memberOf" : "Roo.bootstrap.form.Form"
}
],
"methods" : [
{
- "name" : "doAction",
- "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.",
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark fields in this form invalid in bulk.",
+ "sig" : "(errors)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Form",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "actionName",
- "type" : "String",
- "desc" : "The name of the action type",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) The options to pass to the action. All of the config options listed\nbelow are supported by both the submit and load actions unless otherwise noted (custom actions could also\naccept other config options):\n<pre>\nProperty Type Description\n---------------- --------------- ----------------------------------------------------------------------------------\nurl String The url for the action (defaults to the form's url)\nmethod String The form method to use (defaults to the form's method, or POST if not defined)\nparams String/Object The params to pass (defaults to the form's baseParams, or none if not defined)\nclientValidation Boolean Applies to submit only. Pass true to call form.isValid() prior to posting to\n validate the form on the client (defaults to false)\n</pre>",
+ "name" : "errors",
+ "type" : "Array/Object",
+ "desc" : "Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}",
"isOptional" : false
}
],
]
},
{
- "name" : "setValues",
- "desc" : "Set values for fields in this form in bulk.",
+ "name" : "getFieldValues",
+ "type" : "function",
+ "desc" : "Returns the fields in this form as an object with key/value pairs.\nThis differs from getValues as it calls getValue on each child item, rather than using dom data.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Form",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "values",
- "type" : "Array/Object",
- "desc" : "Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "BasicForm",
- "desc" : "this"
+ "type" : "Object",
+ "desc" : ""
}
]
},
{
- "name" : "getFieldValues",
- "desc" : "Returns the fields in this form as an object with key/value pairs.\nThis differs from getValues as it calls getValue on each child item, rather than using dom data.",
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets this form.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Form",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : ""
+ "type" : "BasicForm",
+ "desc" : "this"
}
]
},
{
- "name" : "markInvalid",
- "desc" : "Mark fields in this form invalid in bulk.",
+ "name" : "getValues",
+ "type" : "function",
+ "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.",
+ "sig" : "(asString)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Form",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "errors",
- "type" : "Array/Object",
- "desc" : "Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}",
+ "name" : "asString",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "BasicForm",
- "desc" : "this"
+ "type" : "Object",
+ "desc" : ""
}
]
},
{
"name" : "clearInvalid",
+ "type" : "function",
"desc" : "Clears all invalid messages in this form.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Form",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
]
},
{
- "name" : "findField",
- "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName",
+ "name" : "isDirty",
+ "type" : "function",
+ "desc" : "Returns true if any fields in this form have changed since their original load.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Form",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The value to search for",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
"type" : "",
- "desc" : "Field"
+ "desc" : "Boolean"
}
]
},
{
- "name" : "isDirty",
- "desc" : "Returns true if any fields in this form have changed since their original load.",
+ "name" : "setValues",
+ "type" : "function",
+ "desc" : "Set values for fields in this form in bulk.",
+ "sig" : "(values)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Form",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "values",
+ "type" : "Array/Object",
+ "desc" : "Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "",
- "desc" : "Boolean"
+ "type" : "BasicForm",
+ "desc" : "this"
}
]
},
{
- "name" : "reset",
- "desc" : "Resets this form.",
+ "name" : "isValid",
+ "type" : "function",
+ "desc" : "Returns true if client-side validation on the form is successful.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Form",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
"name" : "",
- "type" : "BasicForm",
- "desc" : "this"
+ "type" : "",
+ "desc" : "Boolean"
}
]
},
{
- "name" : "getValues",
- "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.",
+ "name" : "doAction",
+ "type" : "function",
+ "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.",
+ "sig" : "(actionName, options)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Form",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "asString",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "actionName",
+ "type" : "String",
+ "desc" : "The name of the action type",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) The options to pass to the action. All of the config options listed\nbelow are supported by both the submit and load actions unless otherwise noted (custom actions could also\naccept other config options):\n<pre>\nProperty Type Description\n---------------- --------------- ----------------------------------------------------------------------------------\nurl String The url for the action (defaults to the form's url)\nmethod String The form method to use (defaults to the form's method, or POST if not defined)\nparams String/Object The params to pass (defaults to the form's baseParams, or none if not defined)\nclientValidation Boolean Applies to submit only. Pass true to call form.isValid() prior to posting to\n validate the form on the client (defaults to false)\n</pre>",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : ""
+ "type" : "BasicForm",
+ "desc" : "this"
}
]
},
{
- "name" : "isValid",
- "desc" : "Returns true if client-side validation on the form is successful.",
+ "name" : "findField",
+ "type" : "function",
+ "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Form",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The value to search for",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
"type" : "",
- "desc" : "Boolean"
+ "desc" : "Field"
}
]
},
{
"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,
- "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
},
{
"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,
- "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
"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,
- "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
"name" : "setVisibilityEl",
+ "type" : "function",
"desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
"name" : "getVisibilityEl",
+ "type" : "function",
"desc" : "Get the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Component",
"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,
- "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
"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,
- "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
},
{
"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,
- "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"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,
- "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "container",
},
{
"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,
- "memberOf" : "Roo.Component",
"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,
- "memberOf" : "Roo.Component",
"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,
- "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "disabled",
},
{
"name" : "focus",
+ "type" : "function",
"desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "selectText",
},
{
"name" : "enable",
+ "type" : "function",
"desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Component",
"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,
- "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "visible",
},
{
"name" : "disable",
+ "type" : "function",
"desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
},
{
"name" : "getEl",
+ "type" : "function",
"desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
},
{
"name" : "purgeListeners",
+ "type" : "function",
"desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"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,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
},
{
"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,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
},
{
"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,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "object",
},
{
"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,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "o",
},
{
"name" : "removeListener",
+ "type" : "function",
"desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
},
{
"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,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
},
{
"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,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
},
{
"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,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "o",
},
{
"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,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
"events" : [
{
"name" : "actionfailed",
+ "type" : "function",
"desc" : "Fires when an action fails.",
- "memberOf" : "Roo.bootstrap.Form",
+ "sig" : "function (_self, action)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"returns" : []
},
{
- "name" : "actioncomplete",
- "desc" : "Fires when an action is completed.",
- "memberOf" : "Roo.bootstrap.Form",
+ "name" : "clientvalidation",
+ "type" : "function",
+ "desc" : "If the monitorValid config option is true, this event fires repetitively to notify of valid state",
+ "sig" : "function (_self, valid)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
},
{
- "name" : "action",
- "type" : "Action",
- "desc" : "The action that completed",
+ "name" : "valid",
+ "type" : "Boolean",
+ "desc" : "true if the form has passed client-side validation",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeaction",
- "desc" : "Fires before any action is performed. Return false to cancel the action.",
- "memberOf" : "Roo.bootstrap.Form",
+ "name" : "actioncomplete",
+ "type" : "function",
+ "desc" : "Fires when an action is completed.",
+ "sig" : "function (_self, action)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
{
"name" : "action",
"type" : "Action",
- "desc" : "The action to be performed",
+ "desc" : "The action that completed",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "clientvalidation",
- "desc" : "If the monitorValid config option is true, this event fires repetitively to notify of valid state",
- "memberOf" : "Roo.bootstrap.Form",
+ "name" : "beforeaction",
+ "type" : "function",
+ "desc" : "Fires before any action is performed. Return false to cancel the action.",
+ "sig" : "function (_self, action)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
},
{
- "name" : "valid",
- "type" : "Boolean",
- "desc" : "true if the form has passed client-side validation",
+ "name" : "action",
+ "type" : "Action",
+ "desc" : "The action to be performed",
"isOptional" : false
}
],
},
{
"name" : "childrenrendered",
+ "type" : "function",
"desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
},
{
"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" : "",
},
{
"name" : "disable",
+ "type" : "function",
"desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
},
{
"name" : "render",
+ "type" : "function",
"desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
},
{
"name" : "destroy",
+ "type" : "function",
"desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
},
{
"name" : "hide",
+ "type" : "function",
"desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
},
{
"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" : "",
},
{
"name" : "show",
+ "type" : "function",
"desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
},
{
"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" : "",
},
{
"name" : "enable",
+ "type" : "function",
"desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
},
{
"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" : "",
projects / roojs1 / blobdiff