"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "width",
"type" : "Number",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [
+ "Roo.dialog.UploadCropbox",
"Roo.form.Checkbox",
"Roo.form.ComboBox",
"Roo.form.ComboBoxArray",
],
"returns" : []
},
+ {
+ "name" : "setPressed",
+ "type" : "function",
+ "desc" : "Similar to toggle, but does not trigger event.",
+ "sig" : "(state)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "[required] Force a particular state",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setText",
"type" : "function",
"memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "value",
"type" : "String",
"memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"Roo.bootstrap.form.FieldLabel",
"Roo.bootstrap.form.Form",
"Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.HtmlEditorToolbarStandard",
+ "Roo.bootstrap.form.HtmlEditorToolbar.Standard",
"Roo.bootstrap.form.Input",
"Roo.bootstrap.form.Markdown",
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"Roo.bootstrap.nav.Sidebar",
"Roo.bootstrap.nav.SidebarItem",
"Roo.bootstrap.nav.Simplebar",
+ "Roo.dialog.UploadCropbox",
"Roo.form.Checkbox",
"Roo.form.Column",
"Roo.form.ComboBox",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "todayText",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "updateEl",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "css",
+ "type" : "String",
+ "desc" : "styling for resizing. (used on bootstrap only)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "disableClass",
"type" : "String",
"optvals" : []
},
{
- "name" : "resizable",
+ "name" : "style",
"type" : "String",
- "desc" : "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.",
- "memberOf" : "",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
],
"returns" : []
},
+ {
+ "name" : "setPressed",
+ "type" : "function",
+ "desc" : "Similar to toggle, but does not trigger event.",
+ "sig" : "(state)",
+ "static" : false,
+ "memberOf" : "Roo.Button",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "[required] Force a particular state",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setText",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setPressed",
+ "type" : "function",
+ "desc" : "Similar to toggle, but does not trigger event.",
+ "sig" : "(state)",
+ "static" : false,
+ "memberOf" : "Roo.Button",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "[required] Force a particular state",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setText",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setPressed",
+ "type" : "function",
+ "desc" : "Similar to toggle, but does not trigger event.",
+ "sig" : "(state)",
+ "static" : false,
+ "memberOf" : "Roo.Button",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "[required] Force a particular state",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setText",
"type" : "function",
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"Roo.bootstrap.form.FieldLabel",
"Roo.bootstrap.form.Form",
"Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.HtmlEditorToolbarStandard",
+ "Roo.bootstrap.form.HtmlEditorToolbar.Standard",
"Roo.bootstrap.form.Input",
"Roo.bootstrap.form.Markdown",
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "disableAutoSize",
+ "type" : "Boolean",
+ "desc" : "disable autoSize() and initCSS()",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "disableClass",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "footerRow",
+ "type" : "Boolean",
+ "desc" : "e) generate tfoot with columns of values, default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "footerShow",
"type" : "Boolean",
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
],
"returns" : []
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "altFormats",
- "type" : "String",
- "desc" : "Multiple date formats separated by \"|\" to try when parsing a user input value and it doesn't match the defined\nformat (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d').",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "autocomplete",
"type" : "String",
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"optvals" : []
},
{
- "name" : "resizable",
+ "name" : "resize",
"type" : "String",
- "desc" : "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.",
+ "desc" : "l) - css resize of eleme",
"memberOf" : "",
"isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "resize",
- "type" : "string",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.form.TextArea",
- "isOptional" : false,
"optvals" : [
"none",
"both",
"horizontal",
- "vertical",
- "inherit",
- "initial"
+ "vertical"
]
},
{
},
{
"name" : "toolbars",
- "type" : "Array",
- "desc" : "Array of toolbars. - defaults to just the Standard one",
+ "type" : "Array|boolean",
+ "desc" : "Array of toolbars, or names of toolbars. - true for standard, and false for none.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
"desc" : "",
"isOptional" : false
}
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
"desc" : "",
"isOptional" : false
}
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
"desc" : "",
"isOptional" : false
},
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
"desc" : "",
"isOptional" : false
},
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
"desc" : "",
"isOptional" : false
},
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
"desc" : "",
"isOptional" : false
}
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "imageadd",
+ "type" : "function",
+ "desc" : "Fires when on any editor when an image is added (excluding paste)",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "imagedelete",
+ "type" : "function",
+ "desc" : "Fires when on any editor when an image is deleted",
+ "sig" : "function (_self, img, oldSrc)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "img",
+ "type" : "HTMLElement",
+ "desc" : "could also be a figure if blocks are enabled",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldSrc",
+ "type" : "HTMLElement",
+ "desc" : "source of image being replaced",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "imageupdated",
+ "type" : "function",
+ "desc" : "Fires when on any editor when an image is changed (excluding paste)",
+ "sig" : "function (_self, img)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "img",
+ "type" : "HTMLElement",
+ "desc" : "could also be a figure if blocks are enabled",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "initialize",
"type" : "function",
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
"desc" : "",
"isOptional" : false
}
{
"name" : "paste",
"type" : "function",
- "desc" : "Fires after the user pastes into input",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Fires when press user pastes into the editor",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.HtmlEditorCore",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
}
],
"returns" : []
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
"desc" : "",
"isOptional" : false
},
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
"desc" : "",
"isOptional" : false
}
"params" : [],
"returns" : []
},
+ {
+ "name" : "stylesheetsclick",
+ "type" : "function",
+ "desc" : "Fires when press the Sytlesheets button",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.HtmlEditorCore",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "sync",
"type" : "function",
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
"desc" : "",
"isOptional" : false
},
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.HtmlEditorToolbarStandard" : {
+ "Roo.bootstrap.form.HtmlEditorToolbar" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.form.HtmlEditorToolbar.Standard" : {
"props" : [
{
"name" : "actionMode",
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.RadioSet",
"Roo.bootstrap.form.SecurePass",
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
"tree_children" : [],
"tree_parent" : []
},
+ "Roo.bootstrap.form.MultiLineTag" : {
+ "props" : [],
+ "events" : [
+ {
+ "name" : "beforeload",
+ "type" : "function",
+ "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.",
+ "sig" : "function (_self, store, options)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.boostrap.form.MultiLineTag",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "store",
+ "type" : "Store",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
"Roo.bootstrap.form.NumberField" : {
"props" : [
{
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.PhoneInput" : {
+ "Roo.bootstrap.form.Password" : {
"props" : [
{
"name" : "accept",
"camera"
]
},
- {
- "name" : "caret",
- "type" : "String",
- "desc" : "r) BS3 only - carat fa na",
- "memberOf" : "Roo.bootstrap.form.TriggerField",
- "isOptional" : false,
- "optvals" : [
- "search",
- "calendar"
- ]
- },
{
"name" : "cls",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "defaultDialCode",
- "type" : "String",
- "desc" : "default '+852'",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "disableClass",
"type" : "String",
"visibility"
]
},
- {
- "name" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.TriggerField",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "indicatorpos",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "preferedCountries",
- "type" : "Array",
- "desc" : "default []",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "preventMark",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "removable",
- "type" : "Boolean",
- "desc" : "e) special filter default fal",
- "memberOf" : "Roo.bootstrap.form.TriggerField",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
{
"name" : "selectOnFocus",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to which this combo is bound (defaults to undefined)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "style",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "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.form.TriggerField",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "validClass",
"type" : "String",
],
"returns" : []
},
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"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.form.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",
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.Radio" : {
+ "Roo.bootstrap.form.PhoneInput" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
+ },
{
"name" : "actionMode",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"optvals" : []
},
{
- "name" : "boxLabel",
+ "name" : "autocomplete",
"type" : "String",
- "desc" : "- the label associated",
- "memberOf" : "",
+ "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "user",
+ "camera"
+ ]
+ },
+ {
+ "name" : "caret",
+ "type" : "String",
+ "desc" : "r) BS3 only - carat fa na",
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : [
+ "search",
+ "calendar"
+ ]
+ },
{
"name" : "cls",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "defaultDialCode",
+ "type" : "String",
+ "desc" : "default '+852'",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "disableClass",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default fal",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default tr",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "hideMode",
"type" : "String",
"visibility"
]
},
+ {
+ "name" : "hideTrigger",
+ "type" : "Boolean",
+ "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "button",
+ "checkbox",
+ "email",
+ "file",
+ "hidden",
+ "image",
+ "number",
+ "password",
+ "radio",
+ "range",
+ "reset",
+ "search",
+ "submit",
+ "text"
+ ]
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "left"
+ ]
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "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.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "placeholder",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "preferedCountries",
+ "type" : "Array",
+ "desc" : "default []",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "removable",
+ "type" : "Boolean",
+ "desc" : "e) special filter default fal",
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "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.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to which this combo is bound (defaults to undefined)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "value",
+ "name" : "triggerClass",
"type" : "String",
- "desc" : "- the value of radio",
- "memberOf" : "",
+ "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.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isOptional" : false,
"optvals" : []
},
"parent"
]
},
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "xattr",
"type" : "Object",
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"returns" : []
},
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.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.form.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.form.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.form.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.form.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.form.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.form.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.form.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.form.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.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "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.form.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.form.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.form.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.form.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.form.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.form.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.form.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.form.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.form.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.form.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" : "tooltipEl",
+ "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}",
}
],
"returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.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.form.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"
+ }
+ ]
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.RadioSet" : {
+ "Roo.bootstrap.form.Radio" : {
"props" : [
- {
- "name" : "accept",
- "type" : "String",
- "desc" : "o) use for file input only. (default empt",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "image",
- "video",
- "audio"
- ]
- },
{
"name" : "actionMode",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "afterButton",
- "type" : "Roo.bootstrap.Button",
- "desc" : "to show before",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) Default le",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "left",
- "center",
- "right"
- ]
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"optvals" : []
},
{
- "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.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "blankText",
+ "name" : "boxLabel",
"type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "- the label associated",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "capture",
- "type" : "String",
- "desc" : "a) use for file input only. (default empt",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "user",
- "camera"
- ]
- },
{
"name" : "cls",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : "e) Default fal",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : "e) default tr",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
{
"name" : "hideMode",
"type" : "String",
"visibility"
]
},
- {
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : "t) default le",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "left",
- "right"
- ]
- },
- {
- "name" : "inline",
- "type" : "Boolean",
- "desc" : "e) inline the element (default tru",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "inputType",
- "type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "button",
- "checkbox",
- "email",
- "file",
- "hidden",
- "image",
- "number",
- "password",
- "radio",
- "range",
- "reset",
- "search",
- "submit",
- "text"
- ]
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelAlign",
- "type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : [
- "top",
- "left"
- ]
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
- {
- "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.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "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.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "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.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "placeholder",
- "type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "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.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "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.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "size",
"type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "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.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "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.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "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.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "value",
- "type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "type" : "String",
+ "desc" : "- the value of radio",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"parent"
]
},
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "weight",
- "type" : "String",
- "desc" : "s) The text that appears beside the rad",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "primary",
- "warning",
- "info",
- "danger",
- "success"
- ]
- },
{
"name" : "xattr",
"type" : "Object",
"memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input",
- "isOptional" : false,
- "optvals" : []
}
],
"events" : [
],
"returns" : []
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.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.form.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.form.RadioSet",
- "desc" : "This radio",
- "isOptional" : false
- },
- {
- "name" : "item",
- "type" : "Roo.bootstrap.form.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.form.RadioSet",
- "desc" : "This radio set",
- "isOptional" : false
- },
- {
- "name" : "item",
- "type" : "Roo.bootstrap.form.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.form.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.form.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.form.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.form.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.form.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.form.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.form.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.form.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.form.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.form.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.form.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.form.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.form.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.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
"returns" : []
},
{
- "name" : "setRawValue",
+ "name" : "setVisibilityEl",
"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" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
+ "params" : [],
"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.form.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",
+ "name" : "setVisible",
"type" : "function",
"desc" : "Convenience function to hide or show this component by boolean.",
"sig" : "(visible)",
}
],
"returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.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.form.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"
- }
- ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.form.Radio"
- ],
+ "tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.SecurePass" : {
+ "Roo.bootstrap.form.RadioSet" : {
"props" : [
- {
- "name" : "Label",
- "type" : "String/Object",
- "desc" : "for the strength meter (defaults to\n'Password strength:')",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "accept",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "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" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "fieldLabel",
"type" : "string",
"name" : "indicatorpos",
"type" : "String",
"desc" : "t) default le",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : [
"left",
"right"
]
},
+ {
+ "name" : "inline",
+ "type" : "Boolean",
+ "desc" : "e) inline the element (default tru",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "inputType",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "pwdStrengths",
- "type" : "String/Object",
- "desc" : "A pwdStrengths spec, or true for a default spec (defaults to\n['Weak', 'Medium', 'Strong'])",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "readOnly",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "s) The text that appears beside the rad",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "primary",
+ "warning",
+ "info",
+ "danger",
+ "success"
+ ]
+ },
{
"name" : "xattr",
"type" : "Object",
],
"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.form.RadioSet",
+ "desc" : "This radio",
+ "isOptional" : false
+ },
+ {
+ "name" : "item",
+ "type" : "Roo.bootstrap.form.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.form.RadioSet",
+ "desc" : "This radio set",
+ "isOptional" : false
+ },
+ {
+ "name" : "item",
+ "type" : "Roo.bootstrap.form.Radio",
+ "desc" : "The checked item",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [],
+ "tree_children" : [
+ "Roo.bootstrap.form.Radio"
+ ],
"tree_parent" : []
},
- "Roo.bootstrap.form.TextArea" : {
+ "Roo.bootstrap.form.SecurePass" : {
"props" : [
{
"name" : "accept",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "cols",
- "type" : "Number",
- "desc" : "Specifies the visible width of a text area",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "container_method",
"type" : "string",
"visibility"
]
},
- {
- "name" : "html",
- "type" : "string",
- "desc" : "text",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "indicatorpos",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "minimumStrength",
+ "type" : "Number",
+ "desc" : "invalid if the strength of the password input is less than the minimum strength (from 0 to 3) (default 2)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "name",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "resize",
- "type" : "string",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "none",
- "both",
- "horizontal",
- "vertical",
- "inherit",
- "initial"
- ]
- },
- {
- "name" : "rows",
- "type" : "Number",
- "desc" : "Specifies the visible number of lines in a text area",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "selectOnFocus",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "wrap",
- "type" : "string",
- "desc" : "d)Specifies how the text in a text area is to be wrapped when submitted in a fo",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "soft",
- "hard"
- ]
- },
{
"name" : "xattr",
"type" : "Object",
"desc" : "Clear any invalid styles/messages for this field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
{
"name" : "inputEl",
"type" : "function",
- "desc" : "return the real textarea element.",
+ "desc" : "return the real input element.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Mark this field as invalid",
"sig" : "(msg)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Mark this field as valid",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.Markdown"
- ],
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.TimeField" : {
+ "Roo.bootstrap.form.TextArea" : {
"props" : [
{
"name" : "accept",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "cols",
+ "type" : "Number",
+ "desc" : "Specifies the visible width of a text area",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "container_method",
"type" : "string",
"false"
]
},
- {
- "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" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "hasFeedback",
"type" : "Boolean",
"visibility"
]
},
+ {
+ "name" : "html",
+ "type" : "string",
+ "desc" : "text",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "indicatorpos",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "resize",
+ "type" : "string",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "none",
+ "both",
+ "horizontal",
+ "vertical",
+ "inherit",
+ "initial"
+ ]
+ },
+ {
+ "name" : "rows",
+ "type" : "Number",
+ "desc" : "Specifies the visible number of lines in a text area",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "selectOnFocus",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "wrap",
+ "type" : "string",
+ "desc" : "d)Specifies how the text in a text area is to be wrapped when submitted in a fo",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "soft",
+ "hard"
+ ]
+ },
{
"name" : "xattr",
"type" : "Object",
],
"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.form.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" : "",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "thisthis",
- "type" : "Roo.bootstrap.form.DateField",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "date",
- "type" : "Mixed",
- "desc" : "The date value",
- "isOptional" : false
}
],
"returns" : []
"desc" : "Clear any invalid styles/messages for this field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
{
"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.form.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Mark this field as invalid",
"sig" : "(msg)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Mark this field as valid",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
+ "implementations" : [
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Markdown"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.TriggerField" : {
+ "Roo.bootstrap.form.TimeField" : {
"props" : [
{
"name" : "accept",
"camera"
]
},
- {
- "name" : "caret",
- "type" : "String",
- "desc" : "r) BS3 only - carat fa na",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "search",
- "calendar"
- ]
- },
{
"name" : "cls",
"type" : "String",
"false"
]
},
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "hasFeedback",
"type" : "Boolean",
"visibility"
]
},
- {
- "name" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "indicatorpos",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "minuteStep",
+ "type" : "Number",
+ "desc" : "the minutes is always the multiple of a fixed number, default 1",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "name",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "removable",
- "type" : "Boolean",
- "desc" : "e) special filter default fal",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
{
"name" : "selectOnFocus",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "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" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "validClass",
"type" : "String",
"returns" : []
},
{
- "name" : "show",
+ "name" : "select",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when select a date.",
+ "sig" : "function (_self, date)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.form.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.form.DateField",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "date",
+ "type" : "Mixed",
+ "desc" : "The date value",
+ "isOptional" : false
}
],
"returns" : []
],
"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",
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
"returns" : []
},
{
- "name" : "onTriggerClick",
+ "name" : "purgeListeners",
"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)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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" : "e",
- "type" : "EventObject",
+ "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.form.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" : "purgeListeners",
+ "name" : "setRawValue",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "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.form.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.form.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.util.Observable",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "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" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "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" : "removeListener",
+ "name" : "tooltipEl",
"type" : "function",
- "desc" : "Removes a listener",
+ "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",
],
"returns" : []
},
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.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.form.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"
+ }
+ ]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.form.TriggerField" : {
+ "props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "user",
+ "camera"
+ ]
+ },
+ {
+ "name" : "caret",
+ "type" : "String",
+ "desc" : "r) BS3 only - carat fa na",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "search",
+ "calendar"
+ ]
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default fal",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default tr",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "hideTrigger",
+ "type" : "Boolean",
+ "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "button",
+ "checkbox",
+ "email",
+ "file",
+ "hidden",
+ "image",
+ "number",
+ "password",
+ "radio",
+ "range",
+ "reset",
+ "search",
+ "submit",
+ "text"
+ ]
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "left"
+ ]
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "placeholder",
+ "type" : "string",
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "removable",
+ "type" : "Boolean",
+ "desc" : "e) special filter default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "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.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "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.form.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.form.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.form.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.form.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.form.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.form.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" : "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" : "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.form.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.form.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" : "",
+ "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.form.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" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "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,
+ "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.form.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.form.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.form.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.form.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.form.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.form.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" : "",
+ "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.form.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.form.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.form.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.form.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.form.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"
+ }
+ ]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.PhoneInput"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.layout" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "mgr",
+ "type" : "Roo.bootstrap.layout.Manager",
+ "desc" : "The manager",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "region",
+ "type" : "string",
+ "desc" : "the region that it inhabits..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "skipConfig",
+ "type" : "bool",
+ "desc" : "skip config?",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "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" : "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" : "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" : "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" : "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" : "getEl",
+ "type" : "function",
+ "desc" : "Returns the container element 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.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" : "",
+ "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" : "",
+ "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,
+ "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" : "hasPanel",
+ "type" : "function",
+ "desc" : "Returns true if the panel is in this region.",
+ "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 panels index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this region is currently visible.",
+ "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" : "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" : "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" : "",
+ "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
+ },
+ {
+ "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",
+ "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" : "resizeTo",
+ "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)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new width or height",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "showPanel",
+ "type" : "function",
+ "desc" : "Show the specified panel.",
+ "sig" : "(panelId)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panelId",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The shown panel or null"
+ }
+ ]
+ },
+ {
+ "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" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.bootstrap.layout.Region"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.layout.Border" : {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "center",
+ "type" : "Roo.bootstrap.layout.Region",
+ "desc" : "region to go in center",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "east",
+ "type" : "Roo.bootstrap.layout.Region",
+ "desc" : "region to go in east",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "north",
+ "type" : "Roo.bootstrap.layout.Region",
+ "desc" : "region to go in north",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "south",
+ "type" : "Roo.bootstrap.layout.Region",
+ "desc" : "region to go in south",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "name" : "west",
+ "type" : "Roo.bootstrap.layout.Region",
+ "desc" : "region to go in west",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "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" : "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" : "layout",
+ "type" : "function",
+ "desc" : "Fires when a layout is performed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.LayoutManager",
+ "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",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "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" : "add",
+ "type" : "function",
+ "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" : "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",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The added panel"
+ }
+ ]
+ },
+ {
+ "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" : "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",
+ "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" : "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" : "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",
+ "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.ContentPanel",
+ "desc" : "The panel or null if it wasn't found"
+ }
+ ]
+ },
+ {
+ "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 Element this layout is bound to.",
+ "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" : "Roo.Element",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "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" : "getRegion",
+ "type" : "function",
+ "desc" : "Returns the specified region.",
+ "sig" : "(target)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.layout.Manager",
+ "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" : "Roo.bootstrap.layout.Manager",
+ "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",
+ "desc" : "Get the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "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,
"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 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" : "reset",
+ "name" : "initEvents",
"type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "desc" : "Initialize Events for the element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "isUpdating",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "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",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
+ "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",
+ "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" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "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" : "setRawValue",
+ "name" : "purgeListeners",
"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" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setValue",
+ "name" : "remove",
"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" : "Remove a ContentPanel (or subclass) to this layout.",
+ "sig" : "(target, panel)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "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",
+ "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
}
],
"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",
}
],
"returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [
+ "Roo.bootstrap.panel.Content",
+ "Roo.bootstrap.panel.Grid",
+ "Roo.bootstrap.panel.Nest",
+ "Roo.bootstrap.panel.Nest",
+ "Roo.bootstrap.panel.Grid"
+ ],
+ "tree_parent" : [
+ "builder",
+ "Roo.bootstrap.panel.Nest",
+ "Roo.bootstrap.panel.Nest",
+ "Roo.bootstrap.Modal"
+ ]
+ },
+ "Roo.bootstrap.layout.Manager" : {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "validate",
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : 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" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "validateValue",
+ "name" : "beforehide",
"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.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "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" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
+ "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" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.bootstrap.form.ComboBox",
- "Roo.bootstrap.form.MoneyField",
- "Roo.bootstrap.form.PhoneInput"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.bootstrap.layout" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.bootstrap.layout.Basic" : {
- "props" : [
+ ],
+ "returns" : []
+ },
{
- "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",
- "isOptional" : false,
- "optvals" : []
+ "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" : "mgr",
- "type" : "Roo.bootstrap.layout.Manager",
- "desc" : "The manager",
+ "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" : "layout",
+ "type" : "function",
+ "desc" : "Fires when a layout is performed.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.LayoutManager",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "region",
- "type" : "string",
- "desc" : "the region that it inhabits..",
+ "name" : "regioncollapsed",
+ "type" : "function",
+ "desc" : "Fires when a region is collapsed.",
+ "sig" : "function (region)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "region",
+ "type" : "Roo.LayoutRegion",
+ "desc" : "The collapsed region",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "skipConfig",
- "type" : "bool",
- "desc" : "skip config?",
+ "name" : "regionexpanded",
+ "type" : "function",
+ "desc" : "Fires when a region is expanded.",
+ "sig" : "function (region)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "region",
+ "type" : "Roo.LayoutRegion",
+ "desc" : "The expanded region",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
- "name" : "add",
+ "name" : "regionresized",
"type" : "function",
- "desc" : "Add the passed ContentPanel(s)",
- "sig" : "(panel)",
- "static" : false,
+ "desc" : "Fires when the user resizes a region.",
+ "sig" : "function (region, newSize)\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" : "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" : [
+ "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" : "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" : "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" : "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",
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "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" : "getActivePanel",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Get the active panel for this region.",
+ "desc" : "Returns the Element this layout is bound to.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The active panel or null"
+ "type" : "Roo.Element",
+ "desc" : ""
}
]
},
{
- "name" : "getEl",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns the container element 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.Element",
+ "type" : "String",
"desc" : ""
}
]
},
{
- "name" : "getPanel",
+ "name" : "getRegion",
"type" : "function",
- "desc" : "Returns the panel specified or null if it's not in this region.",
- "sig" : "(panel)",
+ "desc" : "Returns the specified region.",
+ "sig" : "(target)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
+ "name" : "target",
+ "type" : "String",
+ "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
+ "type" : "Roo.LayoutRegion",
"desc" : ""
}
]
},
{
- "name" : "getPosition",
+ "name" : "getViewSize",
"type" : "function",
- "desc" : "Returns this regions position (north/south/east/west/center).",
+ "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" : "",
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Object",
+ "desc" : "The size as an object {width: (the width), height: (the height)}"
}
]
},
+ {
+ "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" : "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" : "isUpdating",
+ "type" : "function",
+ "desc" : "Returns true if this layout is currently being updated",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : 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" : "",
{
"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"
}
]
},
"returns" : []
}
],
- "isAbstract" : false,
+ "isAbstract" : true,
"isBuilderTop" : false,
"implementations" : [
- "Roo.bootstrap.layout.Region"
+ "Roo.bootstrap.layout.Border"
],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.layout.Border" : {
+ "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" : "",
"isOptional" : false,
"optvals" : []
},
{
- "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" : "",
"isOptional" : false,
"optvals" : []
},
{
- "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" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "center",
- "type" : "Roo.bootstrap.layout.Region",
- "desc" : "region to go in center",
+ "name" : "autoScroll",
+ "type" : "Boolean",
+ "desc" : "True to enable overflow scrolling (defaults to false)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "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" : "",
"isOptional" : false,
"optvals" : []
},
{
- "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" : "",
"isOptional" : false,
"optvals" : []
},
{
- "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" : "",
"isOptional" : false,
"optvals" : []
},
{
- "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" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "east",
- "type" : "Roo.bootstrap.layout.Region",
- "desc" : "region to go in east",
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "For North/South panels",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "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" : "hidden",
+ "type" : "Boolean",
+ "desc" : "True to start the region hidden (defaults to false)",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
+ "optvals" : []
},
{
- "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" : "hideTabs",
+ "type" : "Boolean",
+ "desc" : "True to hide the tab strip (defaults to false)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "hideWhenEmpty",
+ "type" : "Boolean",
+ "desc" : "True to hide the region when it has no panels",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "north",
- "type" : "Roo.bootstrap.layout.Region",
- "desc" : "region to go in north",
- "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",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "south",
- "type" : "Roo.bootstrap.layout.Region",
- "desc" : "region to go in south",
+ "name" : "margins",
+ "type" : "Object",
+ "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "mgr",
+ "type" : "Roo.bootstrap.layout.Manager",
+ "desc" : "The manager",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "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" : "",
"isOptional" : false,
"optvals" : []
},
{
- "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 visibl",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : [
- "el",
- "parent"
+ "hidden",
+ "visible"
]
},
{
- "name" : "west",
- "type" : "Roo.bootstrap.layout.Region",
- "desc" : "region to go in west",
+ "name" : "preferredTabWidth",
+ "type" : "Number",
+ "desc" : "The preferred tab width (defaults to 150)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "preservePanels",
+ "type" : "Boolean",
+ "desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
- }
- ],
- "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" : "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" : "region",
+ "type" : "string",
+ "desc" : "the region that it inhabits..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "skipConfig",
+ "type" : "bool",
+ "desc" : "skip config?",
+ "memberOf" : "Roo.bootstrap.layout.Basic",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "layout",
- "type" : "function",
- "desc" : "Fires when a layout is performed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.layout.Manager",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.LayoutManager",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "split",
+ "type" : "Boolean",
+ "desc" : "To show the splitter",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "tabPosition",
+ "type" : "String",
+ "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "bottom"
+ ]
},
{
- "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" : "title",
+ "type" : "String",
+ "desc" : "The title for the region (overrides panel titles)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "titlebar",
+ "type" : "Boolean",
+ "desc" : "True to display a title bar (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "toolbar",
+ "type" : "Boolean",
+ "desc" : "xtype configuration for a toolbar - shows on right of tabbar",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "width",
+ "type" : "Number",
+ "desc" : "For East/West panels",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
+ "events" : [],
"methods" : [
{
"name" : "add",
"type" : "function",
- "desc" : "Adds a ContentPanel (or subclass) to this layout.",
- "sig" : "(target, panel)",
+ "desc" : "Adds the passed ContentPanel(s) to this region.",
+ "sig" : "(panel)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"exceptions" : "",
"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",
+ "type" : "ContentPanel...",
+ "desc" : "The ContentPanel(s) to add (you can pass more than one)",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Roo.ContentPanel",
- "desc" : "The added panel"
+ "desc" : "The panel added (if only one was added; null otherwise)"
}
]
},
"returns" : []
},
{
- "name" : "addRegion",
+ "name" : "animateCollapse",
"type" : "function",
- "desc" : "Creates and adds a new region if it doesn't already exist.",
- "sig" : "(target, config)",
+ "desc" : "Collapses this region.",
+ "sig" : "(skipAnim)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"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",
+ "name" : "skipAnim",
+ "type" : "Boolean",
+ "desc" : "(optional) true to collapse the element without animation (if animate is true)",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "BorderLayoutRegion",
- "desc" : "The new region"
- }
- ]
+ "returns" : []
},
{
- "name" : "addxtype",
+ "name" : "animateExpand",
"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)",
+ "desc" : "Expands this region if it was previously collapsed.",
+ "sig" : "(e, skipAnim)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "cfg",
- "type" : "Object",
- "desc" : "Xtype definition of item to add.",
+ "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" : "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",
- "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" : "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",
- "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.ContentPanel",
- "desc" : "The panel or null if it wasn't found"
- }
- ]
- },
{
"name" : "fireEvent",
"type" : "function",
"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)",
+ {
+ "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" : "getChildContainer",
+ "name" : "getActivePanel",
"type" : "function",
- "desc" : "Fetch the element to add children to",
+ "desc" : "Get the active panel for this region.",
"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" : "Roo.ContentPanel",
+ "desc" : "The active panel or null"
}
]
},
{
- "name" : "getEl",
+ "name" : "getBox",
"type" : "function",
- "desc" : "Returns the Element this layout is bound to.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)",
+ "sig" : "(title)",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "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" : "getId",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Returns the container element 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.Element",
"desc" : ""
}
]
},
{
- "name" : "getRegion",
+ "name" : "getPanel",
"type" : "function",
- "desc" : "Returns the specified region.",
- "sig" : "(target)",
+ "desc" : "Returns the panel specified or null if it's not in this region.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager",
+ "memberOf" : "Roo.bootstrap.layout.Basic",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "String",
- "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')",
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.ContentPanel",
"desc" : ""
}
]
},
{
- "name" : "getViewSize",
+ "name" : "getPosition",
"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 this regions position (north/south/east/west/center).",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager",
+ "memberOf" : "Roo.bootstrap.layout.Basic",
"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" : ""
}
]
},
{
- "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" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.TabPanel",
+ "desc" : ""
+ }
+ ]
},
{
"name" : "hasListener",
]
},
{
- "name" : "hide",
+ "name" : "hasPanel",
"type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns true if the panel is 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" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "initEvents",
+ "name" : "hide",
"type" : "function",
- "desc" : "Initialize Events for the element",
+ "desc" : "Hides this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "isUpdating",
+ "name" : "hidePanel",
"type" : "function",
- "desc" : "Returns true if this layout is currently being updated",
- "sig" : "()\n{\n\n}",
+ "desc" : "Hides the tab for the specified panel.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
+ "isOptional" : false
}
- ]
- },
- {
- "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" : "layout",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Performs a layout update.",
+ "desc" : "Returns true if this region is currently visible.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
"name" : "on",
{
"name" : "remove",
"type" : "function",
- "desc" : "Remove a ContentPanel (or subclass) to this layout.",
- "sig" : "(target, panel)",
+ "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" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "String",
- "desc" : "The target region key (north, south, east, west or center).",
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
"isOptional" : false
},
{
- "name" : "panel",
- "type" : "Number/String/Roo.ContentPanel",
- "desc" : "The index, id or panel to remove",
+ "name" : "preservePanel",
+ "type" : "Boolean",
+ "desc" : "Overrides the config preservePanel option",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Roo.ContentPanel",
- "desc" : "The removed panel"
+ "desc" : "The panel that was removed"
}
]
},
"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",
+ "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",
- "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",
+ "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,
{
"name" : "showPanel",
"type" : "function",
- "desc" : "Searches all regions for a panel with the specified id and activates (shows) it.",
+ "desc" : "Shows the specified panel.",
"sig" : "(panelId)",
"static" : false,
"memberOf" : "",
"params" : [
{
"name" : "panelId",
- "type" : "String/ContentPanel",
- "desc" : "The panels id or the panel itself",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Roo.ContentPanel",
- "desc" : "The shown panel or null"
- }
- ]
- },
- {
- "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"
+ "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" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.panel.Content",
- "Roo.bootstrap.panel.Grid",
- "Roo.bootstrap.panel.Nest",
- "Roo.bootstrap.panel.Nest",
- "Roo.bootstrap.panel.Grid"
- ],
- "tree_parent" : [
- "builder",
- "Roo.bootstrap.panel.Nest",
- "Roo.bootstrap.panel.Nest",
- "Roo.bootstrap.Modal"
- ]
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.layout.Manager" : {
+ "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",
"isOptional" : false,
"optvals" : []
},
{
- "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",
"isOptional" : false,
"optvals" : []
},
{
- "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",
"isOptional" : false,
"optvals" : []
},
{
- "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",
"isOptional" : false,
"optvals" : []
},
{
- "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",
"isOptional" : false,
"optvals" : []
},
{
- "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",
"isOptional" : false,
"optvals" : []
},
{
- "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",
"isOptional" : false,
"optvals" : []
},
{
- "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",
"isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
+ "optvals" : []
+ },
+ {
+ "name" : "collapsible",
+ "type" : "Boolean",
+ "desc" : "False to disable collapsing (defaults to true)",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableTabTips",
+ "type" : "Boolean",
+ "desc" : "True to disable tab tooltips",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "floatable",
+ "type" : "Boolean",
+ "desc" : "False to disable floating (defaults to true)",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "For North/South panels",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "True to start the region hidden (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideTabs",
+ "type" : "Boolean",
+ "desc" : "True to hide the tab strip (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideWhenEmpty",
+ "type" : "Boolean",
+ "desc" : "True to hide the region when it has no panels",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "listeners",
"optvals" : []
},
{
- "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",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "minTabWidth",
+ "type" : "Number",
+ "desc" : "The minimum tab width (defaults to 40)",
+ "memberOf" : "Roo.LayoutRegion",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "preferredTabWidth",
+ "type" : "Number",
+ "desc" : "The preferred tab width (defaults to 150)",
+ "memberOf" : "Roo.LayoutRegion",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "preservePanels",
+ "type" : "Boolean",
+ "desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "showPin",
+ "type" : "Boolean",
+ "desc" : "True to show a pin button",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "split",
+ "type" : "Boolean",
+ "desc" : "To show the splitter",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tabPosition",
+ "type" : "String",
+ "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom",
+ "memberOf" : "Roo.LayoutRegion",
"isOptional" : false,
"optvals" : [
- "el",
- "parent"
+ "top",
+ "bottom"
]
},
{
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title for the region (overrides panel titles)",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "titlebar",
+ "type" : "Boolean",
+ "desc" : "True to display a title bar (defaults to true)",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "toolbar",
+ "type" : "Boolean",
+ "desc" : "xtype configuration for a toolbar - shows on right of tabbar",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "For East/West panels",
+ "memberOf" : "Roo.LayoutRegion",
"isOptional" : false,
"optvals" : []
}
],
"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
- }
- ],
- "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" : "",
+ "name" : "panel",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "The cancel event object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "collapsed",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "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" : "childrenrendered",
+ "name" : "expanded",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
+ "desc" : "Fires when this region is expanded.",
"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" : "invalidated",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
+ "desc" : "Fires when the layout for this region is changed.",
"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" : "disable",
+ "name" : "panelactivated",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "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" : "enable",
+ "name" : "paneladded",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "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" : "hide",
+ "name" : "panelremoved",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "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" : "layout",
+ "name" : "resized",
"type" : "function",
- "desc" : "Fires when a layout is performed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "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.LayoutManager",
+ "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" : "regioncollapsed",
+ "name" : "slidehide",
"type" : "function",
- "desc" : "Fires when a region is collapsed.",
- "sig" : "function (region)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when this region slides out of view.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "region",
+ "name" : "this",
"type" : "Roo.LayoutRegion",
- "desc" : "The collapsed region",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "regionexpanded",
+ "name" : "slideshow",
"type" : "function",
- "desc" : "Fires when a region is expanded.",
- "sig" : "function (region)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when this region is slid into view.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "region",
+ "name" : "this",
"type" : "Roo.LayoutRegion",
- "desc" : "The expanded region",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "regionresized",
+ "name" : "visibilitychange",
"type" : "function",
- "desc" : "Fires when the user resizes a region.",
- "sig" : "function (region, newSize)\n{\n\n}",
- "memberOf" : "",
+ "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" : "region",
+ "name" : "this",
"type" : "Roo.LayoutRegion",
- "desc" : "The resized region",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new size (width for east/west, height for north/south)",
+ "name" : "visibility",
+ "type" : "Boolean",
+ "desc" : "true or false",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "render",
+ "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" : "Roo.LayoutRegion",
+ "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" : "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" : "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",
+ "name" : "collapse",
"type" : "function",
- "desc" : "Enable 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" : "endUpdate",
+ "name" : "expand",
"type" : "function",
- "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
- "sig" : "(noLayout)",
+ "desc" : "Expands this region if it was previously collapsed.",
+ "sig" : "(e, skipAnim)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "noLayout",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event that triggered the expand (or null if calling manually)",
+ "isOptional" : false
+ },
+ {
+ "name" : "skipAnim",
"type" : "Boolean",
- "desc" : "true to disable a layout update",
+ "desc" : "(optional) true to expand the element without animation (if animate is true)",
"isOptional" : false
}
],
]
},
{
- "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 Element this layout is bound to.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the panel specified or null if it's not in this region.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BasicLayoutRegion",
"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",
+ "type" : "Roo.ContentPanel",
"desc" : ""
}
]
},
{
- "name" : "getId",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "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,
]
},
{
- "name" : "getRegion",
+ "name" : "getSplitBar",
"type" : "function",
- "desc" : "Returns the specified region.",
- "sig" : "(target)",
+ "desc" : "Returns the {@link Roo.SplitBar} for this region.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : 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",
+ "type" : "Roo.SplitBar",
"desc" : ""
}
]
},
{
- "name" : "getViewSize",
+ "name" : "getTabs",
"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 TabPanel component used by this region",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "The size as an object {width: (the width), height: (the height)}"
+ "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.BasicLayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"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" : "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" : "isUpdating",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Returns true if this layout is currently being updated",
+ "desc" : "Returns true if this region is currently visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
- {
- "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",
],
"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" : []
}
],
- "isAbstract" : true,
+ "isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.bootstrap.layout.Border"
- ],
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.layout.Region" : {
+ "Roo.bootstrap.menu" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.menu.Item" : {
"props" : [
{
- "name" : "alwaysShowTabs",
- "type" : "Boolean",
- "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
- "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",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "animate",
+ "name" : "active",
"type" : "Boolean",
- "desc" : "True to animate expand/collapse (defaults to false)",
+ "desc" : "used on sidebars to highlight active itesm",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "autoHide",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
- "memberOf" : "",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "autoScroll",
+ "name" : "can_build_overlaid",
"type" : "Boolean",
- "desc" : "True to enable overflow scrolling (defaults to false)",
- "memberOf" : "",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "closeOnTab",
- "type" : "Boolean",
- "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
- "memberOf" : "",
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "cls",
+ "name" : "container_method",
"type" : "string",
- "desc" : "Extra CSS classes to add to region",
- "memberOf" : "",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "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" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disableTabTips",
- "type" : "Boolean",
- "desc" : "True to disable tab tooltips",
- "memberOf" : "",
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "For North/South panels",
+ "name" : "fa",
+ "type" : "String",
+ "desc" : "favicon to show on left of menu item.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "True to start the region hidden (defaults to false)",
+ "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",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "href",
+ "type" : "String",
+ "desc" : "the link",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hideTabs",
- "type" : "Boolean",
- "desc" : "True to hide the tab strip (defaults to false)",
+ "name" : "html",
+ "type" : "String",
+ "desc" : "the menu label",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hideWhenEmpty",
+ "name" : "isContainer",
"type" : "Boolean",
- "desc" : "True to hide the region when it has no panels",
+ "desc" : "is it a container - just returns a drop down item..",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"optvals" : []
},
{
- "name" : "margins",
- "type" : "Object",
- "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
+ "name" : "menu",
+ "type" : "Roo.bootsrap.Menu",
+ "desc" : "the child menu.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "mgr",
- "type" : "Roo.bootstrap.layout.Manager",
- "desc" : "The manager",
- "memberOf" : "",
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "minTabWidth",
- "type" : "Number",
- "desc" : "The minimum tab width (defaults to 40)",
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "do not trigger A href on clicks (default false).",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "overflow",
+ "name" : "style",
"type" : "String",
- "desc" : "e) if you have menus in the region, then you need to set this to visibl",
- "memberOf" : "",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
- "optvals" : [
- "hidden",
- "visible"
- ]
+ "optvals" : []
},
{
- "name" : "preferredTabWidth",
- "type" : "Number",
- "desc" : "The preferred tab width (defaults to 150)",
- "memberOf" : "",
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "preservePanels",
- "type" : "Boolean",
- "desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
- "memberOf" : "",
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
- "name" : "region",
- "type" : "string",
- "desc" : "the region that it inhabits..",
- "memberOf" : "",
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
+ }
+ ],
+ "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" : "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" : "",
- "isOptional" : false,
- "optvals" : []
+ "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" : "skipConfig",
- "type" : "bool",
- "desc" : "skip config?",
- "memberOf" : "Roo.bootstrap.layout.Basic",
- "isOptional" : false,
- "optvals" : []
+ "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" : "split",
- "type" : "Boolean",
- "desc" : "To show the splitter",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "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" : "tabPosition",
- "type" : "String",
- "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "top",
- "bottom"
- ]
+ "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" : "title",
- "type" : "String",
- "desc" : "The title for the region (overrides panel titles)",
+ "name" : "click",
+ "type" : "function",
+ "desc" : "The raw click event for the entire grid.",
+ "sig" : "function (_self, e)\n{\n\n}",
"memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "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" : "titlebar",
- "type" : "Boolean",
- "desc" : "True to display a title bar (defaults to true)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "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" : "toolbar",
- "type" : "Boolean",
- "desc" : "xtype configuration for a toolbar - shows on right of tabbar",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "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" : "width",
- "type" : "Number",
- "desc" : "For East/West panels",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "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" : "Adds the passed ContentPanel(s) to this region.",
- "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; null otherwise)"
+ "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" : "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" : "fireEvent",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "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.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "getActivePanel",
+ "name" : "disable",
"type" : "function",
- "desc" : "Get the active panel for this region.",
+ "desc" : "Disable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The active panel or null"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getBox",
+ "name" : "enable",
"type" : "function",
- "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)",
- "sig" : "(title)",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "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
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "getEl",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Returns the container element for this region.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "",
+ "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" : ""
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "getPanel",
+ "name" : "focus",
"type" : "function",
- "desc" : "Returns the panel specified or null if it's not in this region.",
- "sig" : "(panel)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Basic",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : ""
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getPosition",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Returns this regions position (north/south/east/west/center).",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Basic",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
{
- "name" : "getTabs",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns the TabPanel component used by this region",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.TabPanel",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "hasListener",
+ "name" : "getId",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "hasPanel",
+ "name" : "getVisibilityEl",
"type" : "function",
- "desc" : "Returns true if the panel is in this region.",
- "sig" : "(panel)",
+ "desc" : "Get the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Basic",
+ "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,
"requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Boolean",
- "desc" : ""
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
"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" : "setVisibilityEl",
"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 element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Basic",
+ "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" : "newSize",
- "type" : "Number",
- "desc" : "The new width or height",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "show",
"type" : "function",
- "desc" : "Shows this region if it was previously hidden.",
+ "desc" : "Show a component - removes 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "showPanel",
+ "name" : "tooltipEl",
"type" : "function",
- "desc" : "Shows the specified panel.",
- "sig" : "(panelId)",
+ "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,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "panelId",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The shown panel, or null if a panel could not be found from panelId"
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
}
],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.TabGroup"
+ ],
+ "tree_parent" : [
+ "Roo.bootstrap.menu.Menu"
+ ]
+ },
+ "Roo.bootstrap.menu.Manager" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "unhidePanel",
+ "name" : "get",
"type" : "function",
- "desc" : "Unhides the tab for a previously hidden panel.",
- "sig" : "(panel)",
+ "desc" : "Returns a {@link Roo.menu.Menu} object",
+ "sig" : "(menu)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
+ "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" : []
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.layout.Split" : {
+ "Roo.bootstrap.menu.Menu" : {
"props" : [
{
- "name" : "alwaysShowTabs",
- "type" : "Boolean",
- "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
- "memberOf" : "Roo.LayoutRegion",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "animate",
- "type" : "Boolean",
- "desc" : "True to animate expand/collapse (defaults to false)",
- "memberOf" : "Roo.LayoutRegion",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoHide",
- "type" : "Boolean",
- "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
- "memberOf" : "Roo.LayoutRegion",
+ "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",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "autoScroll",
- "type" : "Boolean",
- "desc" : "True to enable overflow scrolling (defaults to false)",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "align",
+ "type" : "String",
+ "desc" : "default tl-bl? == below - how the menu should be aligned.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "closeOnTab",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
- "memberOf" : "Roo.LayoutRegion",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "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",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "collapsed",
+ "name" : "can_build_overlaid",
"type" : "Boolean",
- "desc" : "True to set the initial display to collapsed (defaults to false)",
- "memberOf" : "Roo.LayoutRegion",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "collapsedTitle",
+ "name" : "cls",
"type" : "String",
- "desc" : "Optional string message to display in the collapsed block of a north or south region",
- "memberOf" : "Roo.LayoutRegion",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "collapsible",
- "type" : "Boolean",
- "desc" : "False to disable collapsing (defaults to true)",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disableTabTips",
- "type" : "Boolean",
- "desc" : "True to disable tab tooltips",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "floatable",
- "type" : "Boolean",
- "desc" : "False to disable floating (defaults to true)",
- "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",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "For North/South panels",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "hidden",
+ "type" : "bool",
+ "desc" : "if the menu should be hidden when rendered.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "True to start the region hidden (defaults to false)",
- "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",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "hideTabs",
- "type" : "Boolean",
- "desc" : "True to hide the tab strip (defaults to false)",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "hideTrigger",
+ "type" : "bool",
+ "desc" : "e) default false - hide the carret for trigge",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "hideWhenEmpty",
- "type" : "Boolean",
- "desc" : "True to hide the region when it has no panels",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "isLink",
+ "type" : "bool",
+ "desc" : "e) the menu has link disable auto expand and collaspe (default fals",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "listeners",
"optvals" : []
},
{
- "name" : "margins",
- "type" : "Object",
- "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
- "memberOf" : "Roo.LayoutRegion",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "minTabWidth",
- "type" : "Number",
- "desc" : "The minimum tab width (defaults to 40)",
- "memberOf" : "Roo.LayoutRegion",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "preferredTabWidth",
- "type" : "Number",
- "desc" : "The preferred tab width (defaults to 150)",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "preservePanels",
+ "name" : "registerMenu",
"type" : "Boolean",
- "desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
- "memberOf" : "Roo.LayoutRegion",
+ "desc" : "True (default) - means that clicking on screen etc. hides it.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "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" : "stopEvent",
+ "type" : "bool",
+ "desc" : "e) Stop event after trigger press (default tru",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "showPin",
- "type" : "Boolean",
- "desc" : "True to show a pin button",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "split",
- "type" : "Boolean",
- "desc" : "To show the splitter",
- "memberOf" : "Roo.LayoutRegion",
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tabPosition",
+ "name" : "type",
"type" : "String",
- "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom",
- "memberOf" : "Roo.LayoutRegion",
+ "desc" : "u) type of me",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : [
- "top",
- "bottom"
+ "dropdown",
+ "treeview",
+ "submenu"
]
},
{
- "name" : "title",
- "type" : "String",
- "desc" : "The title for the region (overrides panel titles)",
- "memberOf" : "Roo.LayoutRegion",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "titlebar",
- "type" : "Boolean",
- "desc" : "True to display a title bar (defaults to true)",
- "memberOf" : "Roo.LayoutRegion",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "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",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
- "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",
"isOptional" : false,
"optvals" : []
}
],
"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 this menu is hidden (return false to block)",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.menu.Menu",
"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 this menu is displayed (return false to block)",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "invalidated",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires when the layout for this region is changed.",
+ "desc" : "Fires when the children have been rendered..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "panelactivated",
+ "name" : "click",
"type" : "function",
- "desc" : "Fires when a panel is activated.",
- "sig" : "function (_self, panel)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "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" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
},
{
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The activated panel",
+ "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" : "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 this menu is hidden",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "slideshow",
+ "name" : "itemclick",
"type" : "function",
- "desc" : "Fires when this region is slid into view.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "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" : "this",
- "type" : "Roo.LayoutRegion",
+ "name" : "baseItem",
+ "type" : "Roo.menu.BaseItem",
+ "desc" : "The BaseItem that was clicked",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "visibilitychange",
+ "name" : "mouseout",
"type" : "function",
- "desc" : "Fires when this region is shown or hidden",
- "sig" : "function (_self, visibility)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires when the mouse exits this menu",
+ "sig" : "function (_self, e, menuItem)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
},
{
- "name" : "visibility",
- "type" : "Boolean",
- "desc" : "true or 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" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "add",
+ "name" : "mouseover",
"type" : "function",
- "desc" : "Adds the passed ContentPanel(s) to this region.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "Roo.LayoutRegion",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the mouse is hovering over this menu",
+ "sig" : "function (_self, e, menuItem)\n{\n\n}",
+ "memberOf" : "",
"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.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" : [
+ "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; null otherwise)"
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after this menu is displayed",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
{
"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",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns true if the panel is in this region.",
- "sig" : "(panel)",
+ "desc" : "Hides this menu and optionally all parent menus",
+ "sig" : "(deep)",
"static" : false,
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
+ "name" : "deep",
+ "type" : "Boolean",
+ "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "hide",
+ "name" : "initEvents",
"type" : "function",
- "desc" : "Hides this region.",
+ "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,
"params" : [],
"returns" : []
},
- {
- "name" : "hidePanel",
- "type" : "function",
- "desc" : "Hides the tab for the specified 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" : []
- },
{
"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" : "Displays this menu relative to another element",
+ "sig" : "(element, position, parentMenu)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "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" : []
+ },
+ {
+ "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" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.bootstrap.menu" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
+ "tree_children" : [
+ "Roo.bootstrap.menu.Item",
+ "Roo.bootstrap.menu.Separator"
+ ],
+ "tree_parent" : [
+ "none"
+ ]
},
- "Roo.bootstrap.menu.Item" : {
+ "Roo.bootstrap.menu.Separator" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "active",
- "type" : "Boolean",
- "desc" : "used on sidebars to highlight active itesm",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "fa",
- "type" : "String",
- "desc" : "favicon to show on left of menu item.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "hideMode",
"type" : "String",
"visibility"
]
},
- {
- "name" : "href",
- "type" : "String",
- "desc" : "the link",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "html",
- "type" : "String",
- "desc" : "the menu label",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "isContainer",
- "type" : "Boolean",
- "desc" : "is it a container - just returns a drop down item..",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "menu",
- "type" : "Roo.bootsrap.Menu",
- "desc" : "the child menu.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "name",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "do not trigger A href on clicks (default false).",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"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",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.Button",
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.form.CardUploader",
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.Row",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.TabGroup"
- ],
+ "tree_children" : [],
"tree_parent" : [
"Roo.bootstrap.menu.Menu"
]
},
- "Roo.bootstrap.menu.Manager" : {
+ "Roo.bootstrap.nav" : {
"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" : []
- }
- ],
+ "methods" : [],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.menu.Menu" : {
+ "Roo.bootstrap.nav.Bar" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "align",
- "type" : "String",
- "desc" : "default tl-bl? == below - how the menu should be aligned.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "hidden",
- "type" : "bool",
- "desc" : "if the menu should be hidden when rendered.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "hideMode",
"type" : "String",
"visibility"
]
},
- {
- "name" : "hideTrigger",
- "type" : "bool",
- "desc" : "e) default false - hide the carret for trigge",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "isLink",
- "type" : "bool",
- "desc" : "e) the menu has link disable auto expand and collaspe (default fals",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "registerMenu",
- "type" : "Boolean",
- "desc" : "True (default) - means that clicking on screen etc. hides it.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "stopEvent",
- "type" : "bool",
- "desc" : "e) Stop event after trigger press (default tru",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
{
"name" : "style",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "type",
- "type" : "String",
- "desc" : "u) type of me",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "dropdown",
- "treeview",
- "submenu"
- ]
- },
{
"name" : "visibilityEl",
"type" : "string|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" : "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" : "",
"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" : "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" : "",
+ "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.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",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
}
{
"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
}
],
"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",
{
"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)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "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)",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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
- }
- ],
+ "params" : [],
"returns" : []
},
{
"returns" : []
}
],
- "isAbstract" : false,
+ "isAbstract" : true,
"isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.menu.Item",
- "Roo.bootstrap.menu.Separator"
+ "implementations" : [
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.PopoverNav",
+ "Roo.bootstrap.form.HtmlEditorToolbar.Standard",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.Simplebar"
],
- "tree_parent" : [
- "none"
- ]
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.menu.Separator" : {
+ "Roo.bootstrap.nav.Group" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"visibility"
]
},
+ {
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "navId",
+ "type" : "String",
+ "desc" : "- reference Id for navbar.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "pilltype",
+ "type" : "Boolean",
+ "desc" : "default true (turn to off to disable active toggle)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "style",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "type",
+ "type" : "String",
+ "desc" : "b) default n",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "nav",
+ "pills",
+ "tab"
+ ]
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
],
"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.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" : "childrenrendered",
"type" : "function",
],
"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.nav.Item",
+ "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" : "",
+ "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",
+ "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.nav.Item",
+ "desc" : "the current navitem"
+ }
+ ]
+ },
{
"name" : "getChildContainer",
"type" : "function",
"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.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" : "",
+ "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",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [],
- "tree_parent" : [
- "Roo.bootstrap.menu.Menu"
- ]
- },
- "Roo.bootstrap.nav" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
+ "tree_children" : [
+ "Roo.bootstrap.nav.Item",
+ "Roo.bootstrap.nav.SidebarItem"
+ ],
"tree_parent" : []
},
- "Roo.bootstrap.nav.Bar" : {
+ "Roo.bootstrap.nav.Headerbar" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) alignme",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "arrangement",
+ "type" : "Boolean",
+ "desc" : "stacked | justified",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autohide",
+ "type" : "Boolean",
+ "desc" : "a top nav bar header that hides on scroll.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "brand",
+ "type" : "String",
+ "desc" : "what is brand",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "brand_href",
+ "type" : "String",
+ "desc" : "href of the brand",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "desktopCenter",
+ "type" : "Boolean",
+ "desc" : "should the header be centered on desktop using a container class",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "disableClass",
"type" : "String",
"visibility"
]
},
+ {
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "is inverted color",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "e) loadMask on the b",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "main",
+ "type" : "Boolean",
+ "desc" : "e) main nav bar? default fal",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "mobilerow",
+ "type" : "Roo.bootstrap.Row",
+ "desc" : "- a row to display on mobile only..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "name",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "position",
+ "type" : "String",
+ "desc" : "p) positi",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "fixed-top",
+ "fixed-bottom",
+ "static-top"
+ ]
+ },
+ {
+ "name" : "srButton",
+ "type" : "Boolean",
+ "desc" : "generate the (screen reader / mobile) sr-only button default true",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "style",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "v) default is n",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "header",
+ "footer",
+ "nav",
+ "div"
+ ]
+ },
{
"name" : "tooltip",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "type",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "nav",
+ "pills",
+ "tabs"
+ ]
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"parent"
]
},
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "e) default is ligh",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "light",
+ "primary",
+ "secondary",
+ "success",
+ "danger",
+ "warning",
+ "info",
+ "dark",
+ "white"
+ ]
+ },
{
"name" : "xattr",
"type" : "Object",
"type" : "function",
"desc" : "Fire before toggle the menu",
"sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"example" : "",
"deprecated" : "",
"since" : "",
"desc" : "Collapse the navbar pulldown",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Expand the navbar pulldown",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
}
],
- "isAbstract" : true,
+ "isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.bootstrap.PagingToolbar",
- "Roo.bootstrap.PopoverNav",
- "Roo.bootstrap.form.HtmlEditorToolbarStandard",
- "Roo.bootstrap.nav.Headerbar",
- "Roo.bootstrap.nav.Sidebar",
- "Roo.bootstrap.nav.Simplebar"
+ "implementations" : [],
+ "tree_children" : [
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.Link"
],
- "tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.nav.Group" : {
+ "Roo.bootstrap.nav.Item" : {
"props" : [
{
"name" : "actionMode",
"optvals" : []
},
{
- "name" : "align",
- "type" : "String",
- "desc" : "",
+ "name" : "active",
+ "type" : "Boolean",
+ "desc" : "Is item active",
"memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "left",
- "right"
- ]
+ "optvals" : []
},
{
"name" : "allowDomMove",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "animateRef",
+ "type" : "Boolean",
+ "desc" : "e) link to element default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "badge",
+ "type" : "String",
+ "desc" : "text inside badge",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "badgecls",
+ "type" : "String",
+ "desc" : "w)the extra classes for the bad",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "bg-green",
+ "bg-red",
+ "bg-yellow"
+ ]
+ },
+ {
+ "name" : "button_outline",
+ "type" : "Boolean",
+ "desc" : "show and outlined button",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "button_weight",
+ "type" : "String",
+ "desc" : "k) default no",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "default",
+ "primary",
+ "secondary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "link",
+ "light",
+ "dark"
+ ]
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "Is item disabled",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fa",
+ "type" : "String",
+ "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "glyphicon",
+ "type" : "String",
+ "desc" : "DEPRICATED - use fa",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "hideMode",
"type" : "String",
]
},
{
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "href",
+ "type" : "String",
+ "desc" : "link to",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "content of button",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "icon",
+ "type" : "String",
+ "desc" : "DEPRICATED - use fa",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "linkcls",
+ "type" : "String",
+ "desc" : "Link Class",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"optvals" : []
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "menu",
+ "type" : "Roo.bootstrap.menu.Menu",
+ "desc" : "a Menu",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "navId",
- "type" : "String",
- "desc" : "- reference Id for navbar.",
- "memberOf" : "",
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "pilltype",
+ "name" : "preventDefault",
"type" : "Boolean",
- "desc" : "default true (turn to off to disable active toggle)",
+ "desc" : "e) default fal",
"memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "style",
"optvals" : []
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "tabId",
+ "type" : "String",
+ "desc" : "the tab that this item activates.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "type",
+ "name" : "tagtype",
"type" : "String",
- "desc" : "b) default n",
+ "desc" : "n) render as a href or spa",
"memberOf" : "",
"isOptional" : false,
"optvals" : [
- "nav",
- "pills",
- "tab"
+ "a",
+ "span"
]
},
+ {
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
{
"name" : "changed",
"type" : "function",
- "desc" : "Fires when the active item changes",
- "sig" : "function (_self, selected, prev)\n{\n\n}",
+ "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.nav.Group",
+ "type" : "Roo.bootstrap.nav.Item",
"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",
+ "name" : "state",
+ "type" : "boolean",
+ "desc" : "the new state",
"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",
],
"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",
],
"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.nav.Item",
- "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" : "",
- "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",
- "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.nav.Item",
- "desc" : "the current navitem"
- }
- ]
- },
{
"name" : "getChildContainer",
"type" : "function",
"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.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" : "",
- "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",
],
"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" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.nav.Item",
+ "implementations" : [
"Roo.bootstrap.nav.SidebarItem"
],
- "tree_parent" : []
+ "tree_children" : [
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.form.CardUploader"
+ ],
+ "tree_parent" : [
+ "Roo.bootstrap.nav.Group"
+ ]
},
- "Roo.bootstrap.nav.Headerbar" : {
+ "Roo.bootstrap.nav.ProgressBar" : {
"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" : "NavProgressBar:bullets[]",
+ "type" : "Roo.bootstrap.nav.ProgressItem",
+ "desc" : "Bullets for the Nav Progress bar for the toolbar",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "align",
+ "name" : "actionMode",
"type" : "String",
- "desc" : "t) alignme",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "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",
"isOptional" : false,
- "optvals" : [
- "left",
- "right"
- ]
+ "optvals" : []
},
{
"name" : "allowDomMove",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "arrangement",
- "type" : "Boolean",
- "desc" : "stacked | justified",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autohide",
- "type" : "Boolean",
- "desc" : "a top nav bar header that hides on scroll.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "brand",
- "type" : "String",
- "desc" : "what is brand",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "brand_href",
- "type" : "String",
- "desc" : "href of the brand",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "desktopCenter",
- "type" : "Boolean",
- "desc" : "should the header be centered on desktop using a container class",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "disableClass",
"type" : "String",
"visibility"
]
},
- {
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "is inverted color",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "loadMask",
- "type" : "Boolean",
- "desc" : "e) loadMask on the b",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "main",
- "type" : "Boolean",
- "desc" : "e) main nav bar? default fal",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "mobilerow",
- "type" : "Roo.bootstrap.Row",
- "desc" : "- a row to display on mobile only..",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "name",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "position",
- "type" : "String",
- "desc" : "p) positi",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "fixed-top",
- "fixed-bottom",
- "static-top"
- ]
- },
- {
- "name" : "srButton",
- "type" : "Boolean",
- "desc" : "generate the (screen reader / mobile) sr-only button default true",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "style",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "tag",
- "type" : "String",
- "desc" : "v) default is n",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
- "isOptional" : false,
- "optvals" : [
- "header",
- "footer",
- "nav",
- "div"
- ]
- },
{
"name" : "tooltip",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "type",
- "type" : "String",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
- "isOptional" : false,
- "optvals" : [
- "nav",
- "pills",
- "tabs"
- ]
- },
{
"name" : "visibilityEl",
"type" : "string|object",
"parent"
]
},
- {
- "name" : "weight",
- "type" : "String",
- "desc" : "e) default is ligh",
- "memberOf" : "Roo.bootstrap.nav.Simplebar",
- "isOptional" : false,
- "optvals" : [
- "light",
- "primary",
- "secondary",
- "success",
- "danger",
- "warning",
- "info",
- "dark",
- "white"
- ]
- },
{
"name" : "xattr",
"type" : "Object",
"returns" : []
},
{
- "name" : "beforetoggle",
+ "name" : "changed",
"type" : "function",
- "desc" : "Fire before toggle the menu",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.nav.Bar",
+ "desc" : "Fires when the active item changes",
+ "sig" : "function (_self, selected, prev)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "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" : []
],
"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",
"isBuilderTop" : false,
"implementations" : [],
"tree_children" : [
- "Roo.bootstrap.nav.Group",
- "Roo.bootstrap.form.Form",
- "Roo.bootstrap.Row",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.TabGroup",
- "Roo.bootstrap.Link"
+ "Roo.bootstrap.nav.ProgressBarItem"
],
"tree_parent" : []
},
- "Roo.bootstrap.nav.Item" : {
+ "Roo.bootstrap.nav.ProgressBarItem" : {
"props" : [
{
"name" : "actionMode",
{
"name" : "active",
"type" : "Boolean",
- "desc" : "Is item active",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "animateRef",
- "type" : "Boolean",
- "desc" : "e) link to element default fal",
+ "desc" : "e) Is item active default fal",
"memberOf" : "",
"isOptional" : false,
"optvals" : [
]
},
{
- "name" : "badge",
- "type" : "String",
- "desc" : "text inside badge",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "badgecls",
- "type" : "String",
- "desc" : "w)the extra classes for the bad",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "bg-green",
- "bg-red",
- "bg-yellow"
- ]
- },
- {
- "name" : "button_outline",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "show and outlined button",
- "memberOf" : "",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "button_weight",
- "type" : "String",
- "desc" : "k) default no",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "default",
- "primary",
- "secondary",
- "success",
- "info",
- "warning",
- "danger",
- "link",
- "light",
- "dark"
- ]
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
{
"name" : "disabled",
"type" : "Boolean",
- "desc" : "Is item disabled",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fa",
- "type" : "String",
- "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "glyphicon",
- "type" : "String",
- "desc" : "DEPRICATED - use fa",
+ "desc" : "e) Is item active default fal",
"memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hideMode",
"visibility"
]
},
- {
- "name" : "href",
- "type" : "String",
- "desc" : "link to",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "html",
"type" : "String",
- "desc" : "content of button",
+ "desc" : "",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
{
"name" : "icon",
"type" : "String",
- "desc" : "DEPRICATED - use fa",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "linkcls",
- "type" : "String",
- "desc" : "Link Class",
+ "desc" : "show icon instead of number",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "menu",
- "type" : "Roo.bootstrap.menu.Menu",
- "desc" : "a Menu",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "name",
"type" : "string",
"optvals" : []
},
{
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "e) default fal",
+ "name" : "position",
+ "type" : "String",
+ "desc" : "m) text position default bott",
"memberOf" : "",
"isOptional" : false,
"optvals" : [
- "true",
- "false"
+ "top",
+ "bottom"
]
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "tabId",
+ "name" : "rid",
"type" : "String",
- "desc" : "the tab that this item activates.",
+ "desc" : "the reference id",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tagtype",
+ "name" : "style",
"type" : "String",
- "desc" : "n) render as a href or spa",
- "memberOf" : "",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
- "optvals" : [
- "a",
- "span"
- ]
+ "optvals" : []
},
{
"name" : "tooltip",
],
"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.nav.Item",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "state",
- "type" : "boolean",
- "desc" : "the new state",
- "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}",
+ "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" : "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",
{
"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",
+ "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)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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" : "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 release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "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,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "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" : "setHtml",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Set the HTML (text content) of the item",
- "sig" : "(html)",
+ "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" : "html",
- "type" : "string",
- "desc" : "content for the nav item",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"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,
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.bootstrap.nav.SidebarItem"
- ],
- "tree_children" : [
- "Roo.bootstrap.Button",
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.form.CardUploader"
- ],
- "tree_parent" : [
- "Roo.bootstrap.nav.Group"
- ]
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.nav.ProgressBar" : {
+ "Roo.bootstrap.nav.Sidebar" : {
"props" : [
- {
- "name" : "NavProgressBar:bullets[]",
- "type" : "Roo.bootstrap.nav.ProgressItem",
- "desc" : "Bullets for the Nav Progress bar for the toolbar",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "actionMode",
"type" : "String",
"returns" : []
},
{
- "name" : "changed",
+ "name" : "beforetoggle",
"type" : "function",
- "desc" : "Fires when the active item changes",
- "sig" : "function (_self, selected, prev)\n{\n\n}",
- "memberOf" : "",
+ "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.nav.ProgressBar",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"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" : []
],
"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",
"isBuilderTop" : false,
"implementations" : [],
"tree_children" : [
- "Roo.bootstrap.nav.ProgressBarItem"
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.Link"
],
"tree_parent" : []
},
- "Roo.bootstrap.nav.ProgressBarItem" : {
+ "Roo.bootstrap.nav.SidebarItem" : {
"props" : [
{
"name" : "actionMode",
{
"name" : "active",
"type" : "Boolean",
- "desc" : "e) Is item active default fal",
- "memberOf" : "",
+ "desc" : "Is item active",
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "animateRef",
+ "type" : "Boolean",
+ "desc" : "e) link to element default fal",
+ "memberOf" : "Roo.bootstrap.nav.Item",
"isOptional" : false,
"optvals" : [
"true",
]
},
{
- "name" : "allowDomMove",
+ "name" : "badge",
+ "type" : "String",
+ "desc" : "text inside badge",
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "badgecls",
+ "type" : "String",
+ "desc" : "w)the extra classes for the bad",
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : [
+ "bg-green",
+ "bg-red",
+ "bg-yellow"
+ ]
+ },
+ {
+ "name" : "button_outline",
"type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
+ "desc" : "show and outlined button",
+ "memberOf" : "Roo.bootstrap.nav.Item",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "button_weight",
+ "type" : "String",
+ "desc" : "k) default no",
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : [
+ "default",
+ "primary",
+ "secondary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "link",
+ "light",
+ "dark"
+ ]
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
{
"name" : "disabled",
"type" : "Boolean",
- "desc" : "e) Is item active default fal",
- "memberOf" : "",
+ "desc" : "Is item disabled",
+ "memberOf" : "Roo.bootstrap.nav.Item",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
+ "optvals" : []
+ },
+ {
+ "name" : "fa",
+ "type" : "String",
+ "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)",
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "glyphicon",
+ "type" : "String",
+ "desc" : "DEPRICATED - use fa",
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"visibility"
]
},
+ {
+ "name" : "href",
+ "type" : "String",
+ "desc" : "link to",
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "html",
"type" : "String",
- "desc" : "",
- "memberOf" : "",
+ "desc" : "content of button",
+ "memberOf" : "Roo.bootstrap.nav.Item",
"isOptional" : false,
"optvals" : []
},
{
"name" : "icon",
"type" : "String",
- "desc" : "show icon instead of number",
- "memberOf" : "",
+ "desc" : "DEPRICATED - use fa",
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "linkcls",
+ "type" : "String",
+ "desc" : "Link Class",
+ "memberOf" : "Roo.bootstrap.nav.Item",
"isOptional" : false,
"optvals" : []
},
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "menu",
+ "type" : "Roo.bootstrap.menu.Menu",
+ "desc" : "a Menu",
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "name",
"type" : "string",
"optvals" : []
},
{
- "name" : "position",
- "type" : "String",
- "desc" : "m) text position default bott",
- "memberOf" : "",
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
+ "memberOf" : "Roo.bootstrap.nav.Item",
"isOptional" : false,
"optvals" : [
- "top",
- "bottom"
+ "true",
+ "false"
]
},
{
- "name" : "rid",
+ "name" : "style",
"type" : "String",
- "desc" : "the reference id",
- "memberOf" : "",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "style",
+ "name" : "tabId",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "the tab that this item activates.",
+ "memberOf" : "Roo.bootstrap.nav.Item",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "tagtype",
+ "type" : "String",
+ "desc" : "n) render as a href or spa",
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : [
+ "a",
+ "span"
+ ]
+ },
{
"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.nav.SidebarItem",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "state",
+ "type" : "boolean",
+ "desc" : "the new state",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
"name" : "click",
"type" : "function",
"desc" : "The raw click event for the entire grid.",
- "sig" : "function (_self, e)\n{\n\n}",
+ "sig" : "function (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" : "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",
],
"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,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.nav.Sidebar" : {
+ "Roo.bootstrap.nav.Simplebar" : {
"props" : [
{
"name" : "actionMode",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) alignme",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "arrangement",
+ "type" : "Boolean",
+ "desc" : "stacked | justified",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"visibility"
]
},
+ {
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "is inverted color",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "e) loadMask on the b",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "main",
+ "type" : "Boolean",
+ "desc" : "e) main nav bar? default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "name",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "v) default is n",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "header",
+ "footer",
+ "nav",
+ "div"
+ ]
+ },
{
"name" : "tooltip",
"type" : "string",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "type",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "nav",
+ "pills",
+ "tabs"
+ ]
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"parent"
]
},
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "e) default is ligh",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "light",
+ "primary",
+ "secondary",
+ "success",
+ "danger",
+ "warning",
+ "info",
+ "dark",
+ "white"
+ ]
+ },
{
"name" : "xattr",
"type" : "Object",
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
+ "implementations" : [
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.PopoverNav",
+ "Roo.bootstrap.form.HtmlEditorToolbar.Standard",
+ "Roo.bootstrap.nav.Headerbar"
+ ],
"tree_children" : [
"Roo.bootstrap.nav.Group",
"Roo.bootstrap.form.Form",
],
"tree_parent" : []
},
- "Roo.bootstrap.nav.SidebarItem" : {
+ "Roo.bootstrap.panel" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.panel.Content" : {
"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" : "adjustments",
+ "type" : "Array",
+ "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "active",
- "type" : "Boolean",
- "desc" : "Is item active",
- "memberOf" : "Roo.bootstrap.nav.Item",
+ "name" : "autoCreate",
+ "type" : "Boolean/Object",
+ "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "allowDomMove",
+ "name" : "autoScroll",
"type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
+ "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "animateRef",
+ "name" : "background",
"type" : "Boolean",
- "desc" : "e) link to element default fal",
- "memberOf" : "Roo.bootstrap.nav.Item",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "badge",
- "type" : "String",
- "desc" : "text inside badge",
- "memberOf" : "Roo.bootstrap.nav.Item",
+ "desc" : "True if the panel should not be activated when it is added (defaults to false)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "badgecls",
- "type" : "String",
- "desc" : "w)the extra classes for the bad",
- "memberOf" : "Roo.bootstrap.nav.Item",
- "isOptional" : false,
- "optvals" : [
- "bg-green",
- "bg-red",
- "bg-yellow"
- ]
- },
- {
- "name" : "button_outline",
+ "name" : "badges",
"type" : "Boolean",
- "desc" : "show and outlined button",
- "memberOf" : "Roo.bootstrap.nav.Item",
+ "desc" : "render the badges",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "button_weight",
- "type" : "String",
- "desc" : "k) default no",
- "memberOf" : "Roo.bootstrap.nav.Item",
- "isOptional" : false,
- "optvals" : [
- "default",
- "primary",
- "secondary",
- "success",
- "info",
- "warning",
- "danger",
- "link",
- "light",
- "dark"
- ]
- },
- {
- "name" : "can_build_overlaid",
+ "name" : "closable",
"type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "True if the panel can be closed/removed",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "extra classes to use",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disableClass",
+ "name" : "content",
"type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
+ "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disabled",
+ "name" : "fitContainer",
"type" : "Boolean",
- "desc" : "Is item disabled",
- "memberOf" : "Roo.bootstrap.nav.Item",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fa",
- "type" : "String",
- "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)",
- "memberOf" : "Roo.bootstrap.nav.Item",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "glyphicon",
- "type" : "String",
- "desc" : "DEPRICATED - use fa",
- "memberOf" : "Roo.bootstrap.nav.Item",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "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",
- "isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
- },
- {
- "name" : "href",
- "type" : "String",
- "desc" : "link to",
- "memberOf" : "Roo.bootstrap.nav.Item",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "html",
- "type" : "String",
- "desc" : "content of button",
- "memberOf" : "Roo.bootstrap.nav.Item",
+ "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "icon",
- "type" : "String",
- "desc" : "DEPRICATED - use fa",
- "memberOf" : "Roo.bootstrap.nav.Item",
+ "name" : "fitToFrame",
+ "type" : "Boolean",
+ "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "linkcls",
- "type" : "String",
- "desc" : "Link Class",
- "memberOf" : "Roo.bootstrap.nav.Item",
+ "name" : "iframe",
+ "type" : "Boolean",
+ "desc" : "contents are an iframe - makes showing remote sources/CSS feasible..",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "menu",
- "type" : "Roo.bootstrap.menu.Menu",
- "desc" : "a Menu",
- "memberOf" : "Roo.bootstrap.nav.Item",
+ "name" : "loadOnce",
+ "type" : "Boolean",
+ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "e) default fal",
- "memberOf" : "Roo.bootstrap.nav.Item",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "style",
+ "name" : "region",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "(center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tabId",
- "type" : "String",
- "desc" : "the tab that this item activates.",
- "memberOf" : "Roo.bootstrap.nav.Item",
+ "name" : "resizeEl",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tagtype",
+ "name" : "title",
"type" : "String",
- "desc" : "n) render as a href or spa",
- "memberOf" : "Roo.bootstrap.nav.Item",
- "isOptional" : false,
- "optvals" : [
- "a",
- "span"
- ]
- },
- {
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "The title for this panel",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "toolbar",
+ "type" : "Toolbar",
+ "desc" : "A toolbar for this panel",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "el",
- "parent"
- ]
+ "optvals" : []
},
{
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "url",
+ "type" : "String",
+ "desc" : "Calls {@link #setUrl} with this value",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
}
],
"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",
+ "name" : "activate",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "desc" : "Fires when this panel is activated.",
"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.nav.SidebarItem",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "state",
- "type" : "boolean",
- "desc" : "the new state",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "deactivate",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
+ "desc" : "Fires when this panel is activated.",
"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" : "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",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
}
{
"name" : "render",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
+ "desc" : "Fires when this tab is created",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "scrollto",
+ "name" : "resize",
"type" : "function",
- "desc" : "Fires when scroll to element",
- "sig" : "function (_self, options, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.nav.Item",
+ "desc" : "Fires when this panel is resized if fitToFrame is true.",
+ "sig" : "function (_self, width, height)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.nav.Item",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The width after any component adjustments",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The height after any component adjustments",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "scroll",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when this content is scrolled",
+ "sig" : "function (_self, scrollEvent)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "this",
+ "type" : "Roo.ContentPanel",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollEvent",
+ "type" : "Event",
"desc" : "",
"isOptional" : false
}
{
"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}.",
+ "desc" : "Destroys this panel",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : 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" : "",
- "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",
]
},
{
- "name" : "focus",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'Form',\n items: [ .... ]\n }\n);\n\n</code></pre>",
+ "sig" : "(cfg)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "name" : "cfg",
+ "type" : "Object",
+ "desc" : "Xtype definition of item to add.",
"isOptional" : false
}
],
+ "returns" : []
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns this panel's element - used by regiosn to add.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.Element",
+ "desc" : ""
}
]
},
{
- "name" : "getChildContainer",
+ "name" : "getId",
"type" : "function",
- "desc" : "Fetch the element to add children to",
+ "desc" : "Returns this panel's id",
"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" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getEl",
+ "name" : "getTitle",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Returns this panel's title",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getId",
+ "name" : "getToolbar",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Returns the toolbar for this Panel if one was configured.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
+ "type" : "Roo.Toolbar",
"desc" : ""
}
]
},
{
- "name" : "getVisibilityEl",
+ "name" : "getUpdateManager",
"type" : "function",
- "desc" : "Get the element that will be used to show or hide",
+ "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.UpdateManager",
+ "desc" : "The UpdateManager"
+ }
+ ]
},
{
"name" : "hasListener",
]
},
{
- "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",
+ "name" : "isClosable",
"type" : "function",
- "desc" : "Initialize Events for the element",
+ "desc" : "Returns true is this panel was configured to be closable",
"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" : "isVisible",
+ "name" : "load",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.\nDoes not work with IFRAME contents",
+ "sig" : "(url, params, callback, discardUrl)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "url",
+ "type" : "Object/String/Function",
+ "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\npanel.load({\n url: \"your-url.php\",\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n callback: yourFunction,\n scope: yourObject, //(optional scope)\n discardUrl: false,\n nocache: false,\n text: \"Loading...\",\n timeout: 30,\n scripts: false\n});\n</code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
+ "isOptional" : false
+ },
+ {
+ "name" : "discardUrl",
+ "type" : "Boolean",
+ "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "on",
"params" : [],
"returns" : []
},
+ {
+ "name" : "refresh",
+ "type" : "function",
+ "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "releaseCapture",
"type" : "function",
"returns" : []
},
{
- "name" : "render",
+ "name" : "setContent",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Updates this panel's element (not for iframe)",
+ "sig" : "(content, loadScripts)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"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" : "content",
+ "type" : "String",
+ "desc" : "The new content",
"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",
+ "name" : "loadScripts",
"type" : "Boolean",
- "desc" : "",
+ "desc" : "(optional) true to look for and process scripts",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setHtml",
+ "name" : "setTitle",
"type" : "function",
- "desc" : "Set the HTML (text content) of the item",
- "sig" : "(html)",
+ "desc" : "Set this panel's title",
+ "sig" : "(title)",
"static" : false,
- "memberOf" : "Roo.bootstrap.nav.Item",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "html",
- "type" : "string",
- "desc" : "content for the nav item",
+ "name" : "title",
+ "type" : "String",
+ "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",
+ "name" : "setUrl",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
+ "sig" : "(url, params, loadOnce)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
+ "name" : "url",
+ "type" : "String/Function",
+ "desc" : "The URL to load the content from or a function to call to get the URL",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
+ "isOptional" : false
+ },
+ {
+ "name" : "loadOnce",
"type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)",
"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.nav.Item",
- "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.UpdateManager|Boolean",
+ "desc" : "The UpdateManager or false if IFRAME"
}
]
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
+ "implementations" : [
+ "Roo.bootstrap.panel.Grid",
+ "Roo.bootstrap.panel.Nest"
+ ],
+ "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.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.Password",
+ "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.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" : [
+ "builder",
+ "Roo.bootstrap.layout.Border"
+ ]
},
- "Roo.bootstrap.nav.Simplebar" : {
+ "Roo.bootstrap.panel.Grid" : {
"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" : "adjustments",
+ "type" : "Array",
+ "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "align",
- "type" : "String",
- "desc" : "t) alignme",
- "memberOf" : "",
+ "name" : "autoCreate",
+ "type" : "Boolean/Object",
+ "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
- "optvals" : [
- "left",
- "right"
- ]
+ "optvals" : []
},
{
- "name" : "allowDomMove",
+ "name" : "autoScroll",
"type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
+ "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "arrangement",
+ "name" : "background",
"type" : "Boolean",
- "desc" : "stacked | justified",
- "memberOf" : "",
+ "desc" : "True if the panel should not be activated when it is added (defaults to false)",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "can_build_overlaid",
+ "name" : "badges",
"type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "render the badges",
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "closable",
+ "type" : "Boolean",
+ "desc" : "True if the panel can be closed/removed",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "extra classes to use",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "content",
+ "type" : "String",
+ "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "fitContainer",
+ "type" : "Boolean",
+ "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
+ "name" : "fitToFrame",
+ "type" : "Boolean",
+ "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "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" : "grid",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "The grid for this panel",
+ "memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "display",
- "visibility"
- ]
+ "optvals" : []
},
{
- "name" : "inverse",
+ "name" : "iframe",
"type" : "Boolean",
- "desc" : "is inverted color",
- "memberOf" : "",
+ "desc" : "contents are an iframe - makes showing remote sources/CSS feasible..",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "loadMask",
- "type" : "Boolean",
- "desc" : "e) loadMask on the b",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "main",
+ "name" : "loadOnce",
"type" : "Boolean",
- "desc" : "e) main nav bar? default fal",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
- },
- {
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "tag",
+ "name" : "region",
"type" : "String",
- "desc" : "v) default is n",
- "memberOf" : "",
+ "desc" : "(center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
- "optvals" : [
- "header",
- "footer",
- "nav",
- "div"
- ]
+ "optvals" : []
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "resizeEl",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "type",
+ "name" : "title",
"type" : "String",
- "desc" : "",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : [
- "nav",
- "pills",
- "tabs"
- ]
- },
- {
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "The title for this panel",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
- "optvals" : [
- "el",
- "parent"
- ]
+ "optvals" : []
},
{
- "name" : "weight",
- "type" : "String",
- "desc" : "e) default is ligh",
+ "name" : "toolbar",
+ "type" : "Roo.bootstrap.nav.Simplebar",
+ "desc" : "the toolbar at the top of the grid.",
"memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "light",
- "primary",
- "secondary",
- "success",
- "danger",
- "warning",
- "info",
- "dark",
- "white"
- ]
+ "optvals" : []
},
{
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component",
+ "name" : "url",
+ "type" : "String",
+ "desc" : "Calls {@link #setUrl} with this value",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
}
],
"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",
+ "name" : "activate",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "desc" : "Fires when this panel is activated.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"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.nav.Bar",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "deactivate",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
+ "desc" : "Fires when this panel is activated.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
+ "desc" : "Fires when this tab is created",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "disable",
+ "name" : "resize",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when this panel is resized if fitToFrame is true.",
+ "sig" : "function (_self, width, height)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.ContentPanel",
"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" : "",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The width after any component adjustments",
"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" : "",
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The height after any component adjustments",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "scroll",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when this content is scrolled",
+ "sig" : "function (_self, scrollEvent)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.ContentPanel",
"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",
+ "name" : "scrollEvent",
+ "type" : "Event",
"desc" : "",
"isOptional" : false
}
],
"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",
- "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" : "Destroys this panel",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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" : "getChildContainer",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'Form',\n items: [ .... ]\n }\n);\n\n</code></pre>",
+ "sig" : "(cfg)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "cfg",
+ "type" : "Object",
+ "desc" : "Xtype definition of item to add.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "expand",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Expand the navbar pulldown",
+ "desc" : "Returns this panel's element - used by regiosn to add.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.nav.Bar",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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"
+ "type" : "Roo.Element",
+ "desc" : ""
}
]
},
{
- "name" : "focus",
+ "name" : "getGrid",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Returns the grid for this panel",
+ "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.bootstrap.Table",
+ "desc" : ""
}
]
},
{
- "name" : "getChildContainer",
+ "name" : "getId",
"type" : "function",
- "desc" : "Fetch the element to add children to",
+ "desc" : "Returns this panel's id",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getEl",
+ "name" : "getTitle",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Returns this panel's title",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getId",
+ "name" : "getToolbar",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Returns the toolbar for this Panel if one was configured.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
+ "type" : "Roo.Toolbar",
"desc" : ""
}
]
},
{
- "name" : "getVisibilityEl",
+ "name" : "getUpdateManager",
"type" : "function",
- "desc" : "Get the element that will be used to show or hide",
+ "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.UpdateManager",
+ "desc" : "The UpdateManager"
+ }
+ ]
},
{
"name" : "hasListener",
]
},
{
- "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",
+ "name" : "isClosable",
"type" : "function",
- "desc" : "Initialize Events for the element",
+ "desc" : "Returns true is this panel was configured to be closable",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "isVisible",
+ "name" : "load",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.\nDoes not work with IFRAME contents",
+ "sig" : "(url, params, callback, discardUrl)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "url",
+ "type" : "Object/String/Function",
+ "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\npanel.load({\n url: \"your-url.php\",\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n callback: yourFunction,\n scope: yourObject, //(optional scope)\n discardUrl: false,\n nocache: false,\n text: \"Loading...\",\n timeout: 30,\n scripts: false\n});\n</code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
+ "isOptional" : false
+ },
+ {
+ "name" : "discardUrl",
+ "type" : "Boolean",
+ "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "on",
"params" : [],
"returns" : []
},
+ {
+ "name" : "refresh",
+ "type" : "function",
+ "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "releaseCapture",
"type" : "function",
"returns" : []
},
{
- "name" : "render",
+ "name" : "setContent",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Updates this panel's element (not for iframe)",
+ "sig" : "(content, loadScripts)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"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" : "content",
+ "type" : "String",
+ "desc" : "The new content",
+ "isOptional" : false
+ },
+ {
+ "name" : "loadScripts",
+ "type" : "Boolean",
+ "desc" : "(optional) true to look for and process scripts",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "setTitle",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Set this panel's title",
+ "sig" : "(title)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
+ "name" : "title",
+ "type" : "String",
"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",
+ "name" : "setUrl",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
+ "sig" : "(url, params, loadOnce)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
+ "name" : "url",
+ "type" : "String/Function",
+ "desc" : "The URL to load the content from or a function to call to get the URL",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
+ "isOptional" : false
+ },
+ {
+ "name" : "loadOnce",
"type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)",
"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.UpdateManager|Boolean",
+ "desc" : "The UpdateManager or false if IFRAME"
}
]
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.bootstrap.PagingToolbar",
- "Roo.bootstrap.PopoverNav",
- "Roo.bootstrap.form.HtmlEditorToolbarStandard",
- "Roo.bootstrap.nav.Headerbar"
- ],
- "tree_children" : [
- "Roo.bootstrap.nav.Group",
- "Roo.bootstrap.form.Form",
- "Roo.bootstrap.Row",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.TabGroup",
- "Roo.bootstrap.Link"
- ],
- "tree_parent" : []
- },
- "Roo.bootstrap.panel" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
"implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.panel.Content" : {
+ "Roo.bootstrap.panel.Nest" : {
"props" : [
{
"name" : "adjustments",
"type" : "Array",
"desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
"name" : "autoCreate",
"type" : "Boolean/Object",
"desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
"name" : "autoScroll",
"type" : "Boolean",
"desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
"name" : "background",
"type" : "Boolean",
"desc" : "True if the panel should not be activated when it is added (defaults to false)",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
"name" : "badges",
"type" : "Boolean",
"desc" : "render the badges",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
"name" : "closable",
"type" : "Boolean",
"desc" : "True if the panel can be closed/removed",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
"name" : "cls",
"type" : "String",
"desc" : "extra classes to use",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
"name" : "content",
"type" : "String",
"desc" : "Raw content to fill content panel with (uses setContent on construction.)",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
"name" : "fitContainer",
"type" : "Boolean",
"desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
"name" : "fitToFrame",
"type" : "Boolean",
"desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
"name" : "iframe",
"type" : "Boolean",
"desc" : "contents are an iframe - makes showing remote sources/CSS feasible..",
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "layout",
+ "type" : "Roo.BorderLayout",
+ "desc" : "The layout for this panel",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"name" : "loadOnce",
"type" : "Boolean",
"desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
"name" : "params",
"type" : "String/Object",
"desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
"name" : "region",
"type" : "String",
"desc" : "(center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
"name" : "resizeEl",
"type" : "String/HTMLElement/Element",
"desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
"name" : "title",
"type" : "String",
"desc" : "The title for this panel",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
"name" : "toolbar",
"type" : "Toolbar",
"desc" : "A toolbar for this panel",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
},
"name" : "url",
"type" : "String",
"desc" : "Calls {@link #setUrl} with this value",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isOptional" : false,
"optvals" : []
}
"type" : "function",
"desc" : "Fires when this panel is activated.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when this panel is activated.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when this tab is created",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when this panel is resized if fitToFrame is true.",
"sig" : "function (_self, width, height)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when this content is scrolled",
"sig" : "function (_self, scrollEvent)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
],
"returns" : []
},
+ {
+ "name" : "addxtype",
+ "type" : "function",
+ "desc" : "Adds a xtype elements to the layout of the nested panel\n<pre><code>\n\npanel.addxtype({\n xtype : 'ContentPanel',\n region: 'west',\n items: [ .... ]\n }\n);\n\npanel.addxtype({\n xtype : 'NestedLayoutPanel',\n region: 'west',\n layout: {\n center: { },\n west: { } \n },\n items : [ ... list of content panels or nested layout panels.. ]\n }\n);\n</code></pre>",
+ "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" : "capture",
"type" : "function",
"desc" : "Destroys this panel",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'Form',\n items: [ .... ]\n }\n);\n\n</code></pre>",
"sig" : "(cfg)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns this panel's element - used by regiosn to add.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns this panel's id",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
+ {
+ "name" : "getLayout",
+ "type" : "function",
+ "desc" : "Returns the nested BorderLayout for this panel",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.BorderLayout",
+ "desc" : ""
+ }
+ ]
+ },
{
"name" : "getTitle",
"type" : "function",
"desc" : "Returns this panel's title",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns the toolbar for this Panel if one was configured.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns true is this panel was configured to be closable",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.\nDoes not work with IFRAME contents",
"sig" : "(url, params, callback, discardUrl)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Updates this panel's element (not for iframe)",
"sig" : "(content, loadScripts)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Set this panel's title",
"sig" : "(title)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
"sig" : "(url, params, loadOnce)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.bootstrap.panel.Grid",
- "Roo.bootstrap.panel.Nest"
- ],
- "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.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.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" : [
- "builder",
- "Roo.bootstrap.layout.Border"
- ]
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.panel.Grid" : {
+ "Roo.bootstrap.panel.TabItem" : {
"props" : [
- {
- "name" : "adjustments",
- "type" : "Array",
- "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoCreate",
- "type" : "Boolean/Object",
- "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoScroll",
- "type" : "Boolean",
- "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "background",
- "type" : "Boolean",
- "desc" : "True if the panel should not be activated when it is added (defaults to false)",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "badges",
- "type" : "Boolean",
- "desc" : "render the badges",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "closable",
- "type" : "Boolean",
- "desc" : "True if the panel can be closed/removed",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "extra classes to use",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "content",
- "type" : "String",
- "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fitContainer",
- "type" : "Boolean",
- "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fitToFrame",
- "type" : "Boolean",
- "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "grid",
- "type" : "Roo.bootstrap.Table",
- "desc" : "The grid for this panel",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "iframe",
- "type" : "Boolean",
- "desc" : "contents are an iframe - makes showing remote sources/CSS feasible..",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
"memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
- },
- {
- "name" : "loadOnce",
- "type" : "Boolean",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "region",
- "type" : "String",
- "desc" : "(center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "resizeEl",
- "type" : "String/HTMLElement/Element",
- "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "title",
- "type" : "String",
- "desc" : "The title for this panel",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "toolbar",
- "type" : "Roo.bootstrap.nav.Simplebar",
- "desc" : "the toolbar at the top of the grid.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "url",
- "type" : "String",
- "desc" : "Calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
}
],
"events" : [
{
"name" : "activate",
"type" : "function",
- "desc" : "Fires when this panel is activated.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "desc" : "Fires when this tab becomes the active tab.",
+ "sig" : "function (tabPanel, _self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "tabPanel",
+ "type" : "Roo.TabPanel",
+ "desc" : "The parent TabPanel",
+ "isOptional" : false
+ },
{
"name" : "this",
- "type" : "Roo.ContentPanel",
+ "type" : "Roo.TabPanelItem",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "deactivate",
+ "name" : "beforeclose",
"type" : "function",
- "desc" : "Fires when this panel is activated.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "desc" : "Fires before this tab is closed. To cancel the close, set cancel to true on e (e.cancel = true).",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.ContentPanel",
+ "type" : "Roo.TabPanelItem",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "Set cancel to true on this object to cancel the close.",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "close",
"type" : "function",
- "desc" : "Fires when this tab is created",
+ "desc" : "Fires when this tab is closed.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.ContentPanel",
+ "type" : "Roo.TabPanelItem",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "resize",
+ "name" : "deactivate",
"type" : "function",
- "desc" : "Fires when this panel is resized if fitToFrame is true.",
- "sig" : "function (_self, width, height)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "desc" : "Fires when this tab is no longer the active tab.",
+ "sig" : "function (tabPanel, _self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The width after any component adjustments",
+ "name" : "tabPanel",
+ "type" : "Roo.TabPanel",
+ "desc" : "The parent TabPanel",
"isOptional" : false
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "The height after any component adjustments",
+ "name" : "this",
+ "type" : "Roo.TabPanelItem",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "scroll",
+ "name" : "activate",
"type" : "function",
- "desc" : "Fires when this content is scrolled",
- "sig" : "function (_self, scrollEvent)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "desc" : "Activates this TabPanelItem -- this <b>does</b> deactivate the currently active TabPanelItem.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "scrollEvent",
- "type" : "Event",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "disable",
"type" : "function",
- "desc" : "Destroys this panel",
+ "desc" : "Disables this TabPanelItem -- this does nothing if this is the active TabPanelItem.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enables this TabPanelItem if it was previously disabled.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
]
},
{
- "name" : "getChildContainer",
- "type" : "function",
- "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'Form',\n items: [ .... ]\n }\n);\n\n</code></pre>",
- "sig" : "(cfg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
- "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" : "getEl",
- "type" : "function",
- "desc" : "Returns this panel's element - used by regiosn to add.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getGrid",
+ "name" : "getText",
"type" : "function",
- "desc" : "Returns the grid for this panel",
+ "desc" : "Returns the text for this tab",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.bootstrap.Table",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getId",
- "type" : "function",
- "desc" : "Returns this panel's id",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getTitle",
- "type" : "function",
- "desc" : "Returns this panel's title",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
"returns" : [
{
"name" : "",
}
]
},
- {
- "name" : "getToolbar",
- "type" : "function",
- "desc" : "Returns the toolbar for this Panel if one was configured.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Toolbar",
- "desc" : ""
- }
- ]
- },
{
"name" : "getUpdateManager",
"type" : "function",
- "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
+ "desc" : "Gets the {@link Roo.UpdateManager} for the body of this TabPanelItem. Enables you to perform Ajax updates.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
]
},
{
- "name" : "isClosable",
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Hides this TabPanelItem -- if you don't activate another TabPanelItem this could look odd.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isActive",
"type" : "function",
- "desc" : "Returns true is this panel was configured to be closable",
+ "desc" : "Returns true if this tab is the active tab.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
]
},
{
- "name" : "load",
+ "name" : "isHidden",
"type" : "function",
- "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.\nDoes not work with IFRAME contents",
- "sig" : "(url, params, callback, discardUrl)",
+ "desc" : "Returns true if this tab is \"hidden\"",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "url",
- "type" : "Object/String/Function",
- "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\npanel.load({\n url: \"your-url.php\",\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n callback: yourFunction,\n scope: yourObject, //(optional scope)\n discardUrl: false,\n nocache: false,\n text: \"Loading...\",\n timeout: 30,\n scripts: false\n});\n</code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
- "isOptional" : false
- },
- {
- "name" : "discardUrl",
- "type" : "Boolean",
- "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : ""
}
]
},
{
"name" : "refresh",
"type" : "function",
- "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
+ "desc" : "Forces a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the setUrl method has not been called.\n This does not activate the panel, just updates its content.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "setContent",
"type" : "function",
- "desc" : "Updates this panel's element (not for iframe)",
+ "desc" : "Sets the content for this TabPanelItem.",
"sig" : "(content, loadScripts)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "content",
"type" : "String",
- "desc" : "The new content",
+ "desc" : "The content",
"isOptional" : false
},
{
"name" : "loadScripts",
"type" : "Boolean",
- "desc" : "(optional) true to look for and process scripts",
+ "desc" : "true to look for and load scripts",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setTitle",
+ "name" : "setHidden",
"type" : "function",
- "desc" : "Set this panel's title",
- "sig" : "(title)",
+ "desc" : "Show or hide the tab",
+ "sig" : "(hidden)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "title",
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "True to hide or false to show.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setText",
+ "type" : "function",
+ "desc" : "Sets the text for the tab (Note: this also sets the tooltip text)",
+ "sig" : "(text)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "text",
"type" : "String",
- "desc" : "",
+ "desc" : "The tab's text and tooltip",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setTooltip",
+ "type" : "function",
+ "desc" : "Set the tooltip for the tab.",
+ "sig" : "(tooltip)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "tooltip",
+ "type" : "String",
+ "desc" : "The tab's tooltip",
"isOptional" : false
}
],
{
"name" : "setUrl",
"type" : "function",
- "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
+ "desc" : "Set a URL to be used to load the content for this TabPanelItem.",
"sig" : "(url, params, loadOnce)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "url",
"type" : "String/Function",
- "desc" : "The URL to load the content from or a function to call to get the URL",
+ "desc" : "The URL to load the content from, or a function to call to get the URL",
"isOptional" : false
},
{
{
"name" : "loadOnce",
"type" : "Boolean",
- "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)",
+ "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this TabPanelItem is activated. (Defaults to false)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.UpdateManager|Boolean",
- "desc" : "The UpdateManager or false if IFRAME"
+ "type" : "Roo.UpdateManager",
+ "desc" : "The UpdateManager"
}
]
},
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Shows this TabPanelItem -- this <b>does not</b> deactivate the currently active TabPanelItem.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "un",
"type" : "function",
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.panel.Nest" : {
+ "Roo.bootstrap.panel.Tabs" : {
"props" : [
- {
- "name" : "adjustments",
- "type" : "Array",
- "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoCreate",
- "type" : "Boolean/Object",
- "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "autoScroll",
- "type" : "Boolean",
- "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "background",
- "type" : "Boolean",
- "desc" : "True if the panel should not be activated when it is added (defaults to false)",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "badges",
- "type" : "Boolean",
- "desc" : "render the badges",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "closable",
- "type" : "Boolean",
- "desc" : "True if the panel can be closed/removed",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "extra classes to use",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "content",
- "type" : "String",
- "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fitContainer",
- "type" : "Boolean",
- "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "fitToFrame",
- "type" : "Boolean",
- "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "iframe",
- "type" : "Boolean",
- "desc" : "contents are an iframe - makes showing remote sources/CSS feasible..",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "layout",
- "type" : "Roo.BorderLayout",
- "desc" : "The layout for this panel",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
"memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
- },
- {
- "name" : "loadOnce",
- "type" : "Boolean",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "region",
- "type" : "String",
- "desc" : "(center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "resizeEl",
- "type" : "String/HTMLElement/Element",
- "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "title",
- "type" : "String",
- "desc" : "The title for this panel",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "toolbar",
- "type" : "Toolbar",
- "desc" : "A toolbar for this panel",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "url",
- "type" : "String",
- "desc" : "Calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isOptional" : false,
- "optvals" : []
}
],
"events" : [
{
- "name" : "activate",
+ "name" : "beforetabchange",
"type" : "function",
- "desc" : "Fires when this panel is activated.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "desc" : "Fires before the active tab changes, set cancel to true on the \"e\" parameter to cancel the change",
+ "sig" : "function (_self, e, tab)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.ContentPanel",
+ "type" : "Roo.TabPanel",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "deactivate",
- "type" : "function",
- "desc" : "Fires when this panel is activated.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "Set cancel to true on this object to cancel the tab change",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires when this tab is created",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
+ "name" : "tab",
+ "type" : "Roo.TabPanelItem",
+ "desc" : "The tab being changed to",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resize",
+ "name" : "tabchange",
"type" : "function",
- "desc" : "Fires when this panel is resized if fitToFrame is true.",
- "sig" : "function (_self, width, height)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "desc" : "Fires when the active tab changes",
+ "sig" : "function (_self, activePanel)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.ContentPanel",
+ "type" : "Roo.TabPanel",
"desc" : "",
"isOptional" : false
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "The width after any component adjustments",
- "isOptional" : false
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "The height after any component adjustments",
+ "name" : "activePanel",
+ "type" : "Roo.TabPanelItem",
+ "desc" : "The new active tab",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "scroll",
+ "name" : "activate",
"type" : "function",
- "desc" : "Fires when this content is scrolled",
- "sig" : "function (_self, scrollEvent)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "desc" : "Activates a {@link Roo.TabPanelItem}. The currently active one will be deactivated.",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "scrollEvent",
- "type" : "Event",
- "desc" : "",
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to activate.",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "methods" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.TabPanelItem",
+ "desc" : "The TabPanelItem."
+ }
+ ]
+ },
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "addxtype",
+ "name" : "addTab",
"type" : "function",
- "desc" : "Adds a xtype elements to the layout of the nested panel\n<pre><code>\n\npanel.addxtype({\n xtype : 'ContentPanel',\n region: 'west',\n items: [ .... ]\n }\n);\n\npanel.addxtype({\n xtype : 'NestedLayoutPanel',\n region: 'west',\n layout: {\n center: { },\n west: { } \n },\n items : [ ... list of content panels or nested layout panels.. ]\n }\n);\n</code></pre>",
- "sig" : "(cfg)",
+ "desc" : "Creates a new {@link Roo.TabPanelItem} by looking for an existing element with the provided id -- if it's not found it creates one.",
+ "sig" : "(id, text, content, closable)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "cfg",
- "type" : "Object",
- "desc" : "Xtype definition of item to add.",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the div to use <b>or create</b>",
+ "isOptional" : false
+ },
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "The text for the tab",
+ "isOptional" : false
+ },
+ {
+ "name" : "content",
+ "type" : "String",
+ "desc" : "(optional) Content to put in the TabPanelItem body",
+ "isOptional" : false
+ },
+ {
+ "name" : "closable",
+ "type" : "Boolean",
+ "desc" : "(optional) True to create a close icon on the tab",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.TabPanelItem",
+ "desc" : "The created TabPanelItem"
+ }
+ ]
},
{
- "name" : "capture",
+ "name" : "addTabItem",
"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" : "Adds an existing {@link Roo.TabPanelItem}.",
+ "sig" : "(item)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"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",
+ "name" : "item",
+ "type" : "Roo.TabPanelItem",
+ "desc" : "The TabPanelItem to add",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "autoSizeTabs",
"type" : "function",
- "desc" : "Destroys this panel",
+ "desc" : "Manual call to resize the tabs (if {@link #resizeTabs} is false this does nothing)",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "beginUpdate",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Disables tab resizing while tabs are being added (if {@link #resizeTabs} is false this does nothing)",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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" : "eventName",
- "type" : "String",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getChildContainer",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'Form',\n items: [ .... ]\n }\n);\n\n</code></pre>",
- "sig" : "(cfg)",
+ "desc" : "Destroys this TabPanel",
+ "sig" : "(removeEl)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "cfg",
- "type" : "Object",
- "desc" : "Xtype definition of item to add.",
+ "name" : "removeEl",
+ "type" : "Boolean",
+ "desc" : "(optional) True to remove the element from the DOM as well (defaults to undefined)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "getEl",
+ "name" : "disableTab",
"type" : "function",
- "desc" : "Returns this panel's element - used by regiosn to add.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Disables a {@link Roo.TabPanelItem}. It cannot be the active tab, if it is this call is ignored.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : ""
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to disable.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getId",
+ "name" : "enableTab",
"type" : "function",
- "desc" : "Returns this panel's id",
- "sig" : "()\n{\n\n}",
+ "desc" : "Enables a {@link Roo.TabPanelItem} that is disabled.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : ""
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to enable.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getLayout",
+ "name" : "endUpdate",
"type" : "function",
- "desc" : "Returns the nested BorderLayout for this panel",
+ "desc" : "Stops an update and resizes the tabs (if {@link #resizeTabs} is false this does nothing)",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.BorderLayout",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getTitle",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Returns this panel's title",
- "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.panel.Content",
+ "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" : "String",
- "desc" : ""
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "getToolbar",
+ "name" : "getActiveTab",
"type" : "function",
- "desc" : "Returns the toolbar for this Panel if one was configured.",
+ "desc" : "Gets the active {@link Roo.TabPanelItem}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Toolbar",
- "desc" : ""
+ "type" : "Roo.TabPanelItem",
+ "desc" : "The active TabPanelItem or null if none are active."
}
]
},
{
- "name" : "getUpdateManager",
+ "name" : "getCount",
"type" : "function",
- "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
+ "desc" : "Returns the number of tabs in this TabPanel.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.UpdateManager",
- "desc" : "The UpdateManager"
+ "type" : "Number",
+ "desc" : ""
}
]
},
{
- "name" : "hasListener",
+ "name" : "getTab",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Returns the {@link Roo.TabPanelItem} with the specified id/index",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to fetch.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "Roo.TabPanelItem",
+ "desc" : ""
}
]
},
{
- "name" : "isClosable",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Returns true is this panel was configured to be closable",
- "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.panel.Content",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
"type" : "Boolean",
- "desc" : ""
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "load",
+ "name" : "hideTab",
"type" : "function",
- "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.\nDoes not work with IFRAME contents",
- "sig" : "(url, params, callback, discardUrl)",
+ "desc" : "Hides the {@link Roo.TabPanelItem} with the specified id/index",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "url",
- "type" : "Object/String/Function",
- "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\npanel.load({\n url: \"your-url.php\",\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n callback: yourFunction,\n scope: yourObject, //(optional scope)\n discardUrl: false,\n nocache: false,\n text: \"Loading...\",\n timeout: 30,\n scripts: false\n});\n</code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
- "isOptional" : false
- },
- {
- "name" : "discardUrl",
- "type" : "Boolean",
- "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to hide.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
"name" : "on",
"params" : [],
"returns" : []
},
- {
- "name" : "refresh",
- "type" : "function",
- "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "releaseCapture",
"type" : "function",
"returns" : []
},
{
- "name" : "setContent",
+ "name" : "removeTab",
"type" : "function",
- "desc" : "Updates this panel's element (not for iframe)",
- "sig" : "(content, loadScripts)",
+ "desc" : "Removes a {@link Roo.TabPanelItem}.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "content",
- "type" : "String",
- "desc" : "The new content",
- "isOptional" : false
- },
- {
- "name" : "loadScripts",
- "type" : "Boolean",
- "desc" : "(optional) true to look for and process scripts",
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to remove.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setTitle",
+ "name" : "setTabWidth",
"type" : "function",
- "desc" : "Set this panel's title",
- "sig" : "(title)",
+ "desc" : "Resizes all the tabs to the passed width",
+ "sig" : "(The)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "title",
- "type" : "String",
- "desc" : "",
+ "name" : "The",
+ "type" : "Number",
+ "desc" : "new width",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setUrl",
+ "name" : "syncHeight",
"type" : "function",
- "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
- "sig" : "(url, params, loadOnce)",
+ "desc" : "Updates the tab body element to fit the height of the container element\nfor overflow scrolling",
+ "sig" : "(targetHeight)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "url",
- "type" : "String/Function",
- "desc" : "The URL to load the content from or a function to call to get the URL",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
- "isOptional" : false
- },
- {
- "name" : "loadOnce",
- "type" : "Boolean",
- "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)",
+ "name" : "targetHeight",
+ "type" : "Number",
+ "desc" : "(optional) Override the starting height from the elements height",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.UpdateManager|Boolean",
- "desc" : "The UpdateManager or false if IFRAME"
- }
- ]
+ "returns" : []
},
{
"name" : "un",
}
],
"returns" : []
+ },
+ {
+ "name" : "unhideTab",
+ "type" : "function",
+ "desc" : "\"Unhides\" the {@link Roo.TabPanelItem} with the specified id/index.",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to unhide.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.panel.TabItem" : {
+ "Roo.data" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.ArrayReader" : {
"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" : "fields",
+ "type" : "Array",
+ "desc" : "Array of field definition objects",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "Name of the property within a row object that contains a record identifier value.\nas specified to {@link Roo.data.Record#create},\nor an {@link Roo.data.Record} object\n\n\ncreated using {@link Roo.data.Record#create}.",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
}
],
- "events" : [
+ "events" : [],
+ "methods" : [
{
- "name" : "activate",
+ "name" : "newRow",
"type" : "function",
- "desc" : "Fires when this tab becomes the active tab.",
- "sig" : "function (tabPanel, _self)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Create an empty record",
+ "sig" : "(data)",
+ "static" : false,
+ "memberOf" : "Roo.data.DataReader",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "tabPanel",
- "type" : "Roo.TabPanel",
- "desc" : "The parent TabPanel",
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "(optional) - overlay some values",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.TabPanelItem",
- "desc" : "",
+ "name" : "",
+ "type" : "Roo.data.Record",
+ "desc" : "record created."
+ }
+ ]
+ },
+ {
+ "name" : "readRecords",
+ "type" : "function",
+ "desc" : "Create a data block containing Roo.data.Records from an XML document.",
+ "sig" : "(o)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "An Array of row objects which represents the dataset.",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "A data block which is used by an {@link Roo.data.Store} object as\na cache of Roo.data.Records."
+ }
+ ]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.Connection" : {
+ "props" : [
+ {
+ "name" : "autoAbort",
+ "type" : "Boolean",
+ "desc" : "Whether this request should abort any pending requests. (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "defaultHeaders",
+ "type" : "Object",
+ "desc" : "An object containing request headers which are added\n to each request made by this object. (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableCaching",
+ "type" : "Boolean",
+ "desc" : "True to add a unique cache-buster param to GET requests. (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "extraParams",
+ "type" : "Object",
+ "desc" : "An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "method",
+ "type" : "String",
+ "desc" : "The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "timeout",
+ "type" : "Number",
+ "desc" : "The timeout in milliseconds to be used for requests. (defaults to 30000)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "beforeclose",
+ "name" : "url",
+ "type" : "String",
+ "desc" : "The default URL to be used for requests to the server. (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforerequest",
"type" : "function",
- "desc" : "Fires before this tab is closed. To cancel the close, set cancel to true on e (e.cancel = true).",
- "sig" : "function (_self, e)\n{\n\n}",
+ "desc" : "Fires before a network request is made to retrieve a data object.",
+ "sig" : "function (conn, options)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.TabPanelItem",
- "desc" : "",
+ "name" : "conn",
+ "type" : "Connection",
+ "desc" : "This Connection object.",
"isOptional" : false
},
{
- "name" : "e",
+ "name" : "options",
"type" : "Object",
- "desc" : "Set cancel to true on this object to cancel the close.",
+ "desc" : "The options config object passed to the {@link #request} method.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "close",
+ "name" : "requestcomplete",
"type" : "function",
- "desc" : "Fires when this tab is closed.",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Fires if the request was successfully completed.",
+ "sig" : "function (conn, response, options)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.TabPanelItem",
- "desc" : "",
+ "name" : "conn",
+ "type" : "Connection",
+ "desc" : "This Connection object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "response",
+ "type" : "Object",
+ "desc" : "The XHR object containing the response data.\nSee {@link http://www.w3.org/TR/XMLHttpRequest/} for details.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The options config object passed to the {@link #request} method.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "deactivate",
+ "name" : "requestexception",
"type" : "function",
- "desc" : "Fires when this tab is no longer the active tab.",
- "sig" : "function (tabPanel, _self)\n{\n\n}",
+ "desc" : "Fires if an error HTTP status was returned from the server.\nSee {@link http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html} for details of HTTP status codes.",
+ "sig" : "function (conn, response, options)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "tabPanel",
- "type" : "Roo.TabPanel",
- "desc" : "The parent TabPanel",
+ "name" : "conn",
+ "type" : "Connection",
+ "desc" : "This Connection object.",
"isOptional" : false
},
{
- "name" : "this",
- "type" : "Roo.TabPanelItem",
- "desc" : "",
+ "name" : "response",
+ "type" : "Object",
+ "desc" : "The XHR object containing the response data.\nSee {@link http://www.w3.org/TR/XMLHttpRequest/} for details.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The options config object passed to the {@link #request} method.",
"isOptional" : false
}
],
],
"methods" : [
{
- "name" : "activate",
+ "name" : "abort",
"type" : "function",
- "desc" : "Activates this TabPanelItem -- this <b>does</b> deactivate the currently active TabPanelItem.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Aborts any outstanding request.",
+ "sig" : "(transactionId)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "transactionId",
+ "type" : "Number",
+ "desc" : "defaults to the last transaction",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
],
"returns" : []
},
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disables this TabPanelItem -- this does nothing if this is the active TabPanelItem.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enables this TabPanelItem if it was previously disabled.",
- "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" : "getText",
- "type" : "function",
- "desc" : "Returns the text for this tab",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getUpdateManager",
- "type" : "function",
- "desc" : "Gets the {@link Roo.UpdateManager} for the body of this TabPanelItem. Enables you to perform Ajax updates.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.UpdateManager",
- "desc" : "The UpdateManager"
- }
- ]
- },
{
"name" : "hasListener",
"type" : "function",
]
},
{
- "name" : "hide",
- "type" : "function",
- "desc" : "Hides this TabPanelItem -- if you don't activate another TabPanelItem this could look odd.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isActive",
+ "name" : "isLoading",
"type" : "function",
- "desc" : "Returns true if this tab is the active tab.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Determine whether this object has a request outstanding.",
+ "sig" : "(transactionId)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "name" : "transactionId",
+ "type" : "Number",
+ "desc" : "defaults to the last transaction",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "isHidden",
- "type" : "function",
- "desc" : "Returns true if this tab is \"hidden\"",
- "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" : ""
+ "desc" : "True if there is an outstanding request."
}
]
},
"params" : [],
"returns" : []
},
- {
- "name" : "refresh",
- "type" : "function",
- "desc" : "Forces a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the setUrl method has not been called.\n This does not activate the panel, just updates its content.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "releaseCapture",
"type" : "function",
"returns" : []
},
{
- "name" : "setContent",
- "type" : "function",
- "desc" : "Sets the content for this TabPanelItem.",
- "sig" : "(content, loadScripts)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "content",
- "type" : "String",
- "desc" : "The content",
- "isOptional" : false
- },
- {
- "name" : "loadScripts",
- "type" : "Boolean",
- "desc" : "true to look for and load scripts",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setHidden",
- "type" : "function",
- "desc" : "Show or hide the tab",
- "sig" : "(hidden)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "True to hide or false to show.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setText",
- "type" : "function",
- "desc" : "Sets the text for the tab (Note: this also sets the tooltip text)",
- "sig" : "(text)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "text",
- "type" : "String",
- "desc" : "The tab's text and tooltip",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setTooltip",
- "type" : "function",
- "desc" : "Set the tooltip for the tab.",
- "sig" : "(tooltip)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "tooltip",
- "type" : "String",
- "desc" : "The tab's tooltip",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setUrl",
+ "name" : "request",
"type" : "function",
- "desc" : "Set a URL to be used to load the content for this TabPanelItem.",
- "sig" : "(url, params, loadOnce)",
+ "desc" : "Sends an HTTP request to a remote server.",
+ "sig" : "(options)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "url",
- "type" : "String/Function",
- "desc" : "The URL to load the content from, or a function to call to get the URL",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
- "isOptional" : false
- },
- {
- "name" : "loadOnce",
- "type" : "Boolean",
- "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this TabPanelItem is activated. (Defaults to false)",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "An object which may contain the following properties:<ul>\n<li><b>url</b> {String} The URL to which to send the request. Defaults to configured URL</li>\n<li><b>params</b> {Object/String/Function} An object containing properties which are used as parameters to the\nrequest, a url encoded string or a function to call to get either.</li>\n<li><b>method</b> {String} The HTTP method to use for the request. Defaults to the configured method, or\nif no method was configured, \"GET\" if no parameters are being sent, and \"POST\" if parameters are being sent.</li>\n<li><b>callback</b> {Function} The function to be called upon receipt of the HTTP response.\nThe callback is called regardless of success or failure and is passed the following parameters:<ul>\n<li>options {Object} The parameter to the request call.</li>\n<li>success {Boolean} True if the request succeeded.</li>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n</ul></li>\n<li><b>success</b> {Function} The function to be called upon success of the request.\nThe callback is passed the following parameters:<ul>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n<li>options {Object} The parameter to the request call.</li>\n</ul></li>\n<li><b>failure</b> {Function} The function to be called upon failure of the request.\nThe callback is passed the following parameters:<ul>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n<li>options {Object} The parameter to the request call.</li>\n</ul></li>\n<li><b>scope</b> {Object} The scope in which to execute the callbacks: The \"this\" object\nfor the callback function. Defaults to the browser window.</li>\n<li><b>form</b> {Object/String} A form object or id to pull parameters from.</li>\n<li><b>isUpload</b> {Boolean} True if the form object is a file upload (will usually be automatically detected).</li>\n<li><b>headers</b> {Object} Request headers to set for the request.</li>\n<li><b>xmlData</b> {Object} XML document to use for the post. Note: This will be used instead of\nparams for the post data. Any params will be appended to the URL.</li>\n<li><b>disableCaching</b> {Boolean} True to add a unique cache-buster param to GET requests.</li>\n</ul>",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.UpdateManager",
- "desc" : "The UpdateManager"
+ "type" : "Number",
+ "desc" : "transactionId"
}
]
},
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Shows this TabPanelItem -- this <b>does not</b> deactivate the currently active TabPanelItem.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "un",
"type" : "function",
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
+ "implementations" : [
+ "Roo.Ajax"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.panel.Tabs" : {
+ "Roo.data.DataProxy" : {
"props" : [
{
"name" : "listeners",
],
"events" : [
{
- "name" : "beforetabchange",
+ "name" : "beforeload",
"type" : "function",
- "desc" : "Fires before the active tab changes, set cancel to true on the \"e\" parameter to cancel the change",
- "sig" : "function (_self, e, tab)\n{\n\n}",
+ "desc" : "Fires before a network request is made to retrieve a data object.",
+ "sig" : "function (This, params)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.TabPanel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
+ "name" : "This",
"type" : "Object",
- "desc" : "Set cancel to true on this object to cancel the tab change",
+ "desc" : "DataProxy object.",
"isOptional" : false
},
{
- "name" : "tab",
- "type" : "Roo.TabPanelItem",
- "desc" : "The tab being changed to",
+ "name" : "params",
+ "type" : "Object",
+ "desc" : "The params parameter to the load function.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "tabchange",
+ "name" : "load",
"type" : "function",
- "desc" : "Fires when the active tab changes",
- "sig" : "function (_self, activePanel)\n{\n\n}",
+ "desc" : "Fires before the load method's callback is called.",
+ "sig" : "function (This, o, arg)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.TabPanel",
- "desc" : "",
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "DataProxy object.",
"isOptional" : false
},
{
- "name" : "activePanel",
- "type" : "Roo.TabPanelItem",
- "desc" : "The new active tab",
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The data object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "arg",
+ "type" : "Object",
+ "desc" : "The callback argument object passed to the load function.",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "activate",
+ "name" : "loadexception",
"type" : "function",
- "desc" : "Activates a {@link Roo.TabPanelItem}. The currently active one will be deactivated.",
- "sig" : "(id)",
- "static" : false,
+ "desc" : "Fires if an Exception occurs during data retrieval.",
+ "sig" : "function (This, o, arg, e)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to activate.",
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "DataProxy object.",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.TabPanelItem",
- "desc" : "The TabPanelItem."
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The data object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "arg",
+ "type" : "Object",
+ "desc" : "The callback argument object passed to the load function.",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "The Exception.",
+ "isOptional" : false
}
- ]
- },
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "addTab",
+ "name" : "capture",
"type" : "function",
- "desc" : "Creates a new {@link Roo.TabPanelItem} by looking for an existing element with the provided id -- if it's not found it creates one.",
- "sig" : "(id, text, content, closable)",
- "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" : "id",
- "type" : "String",
- "desc" : "The id of the div to use <b>or create</b>",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "text",
- "type" : "String",
- "desc" : "The text for the tab",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
"isOptional" : false
},
{
- "name" : "content",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "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" : "(optional) Content to put in the TabPanelItem body",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "closable",
- "type" : "Boolean",
- "desc" : "(optional) True to create a close icon on the tab",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.TabPanelItem",
- "desc" : "The created TabPanelItem"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "addTabItem",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Adds an existing {@link Roo.TabPanelItem}.",
- "sig" : "(item)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "item",
- "type" : "Roo.TabPanelItem",
- "desc" : "The TabPanelItem to add",
+ "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" : "autoSizeTabs",
+ "name" : "on",
"type" : "function",
- "desc" : "Manual call to resize the tabs (if {@link #resizeTabs} is false this does nothing)",
- "sig" : "()\n{\n\n}",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "",
+ "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)",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "beginUpdate",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Disables tab resizing while tabs are being added (if {@link #resizeTabs} is false this does nothing)",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "capture",
+ "name" : "releaseCapture",
"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)",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
"static" : true,
"memberOf" : "Roo.util.Observable",
"isStatic" : true,
{
"name" : "o",
"type" : "Observable",
- "desc" : "The Observable to capture",
+ "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" : "fn",
+ "name" : "handler",
"type" : "Function",
- "desc" : "The function to call",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "un",
"type" : "function",
- "desc" : "Destroys this TabPanel",
- "sig" : "(removeEl)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "removeEl",
- "type" : "Boolean",
- "desc" : "(optional) True to remove the element from the DOM as well (defaults to undefined)",
+ "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" : []
- },
+ }
+ ],
+ "isAbstract" : true,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.data.HttpProxy",
+ "Roo.data.MemoryProxy"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.DataReader" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "disableTab",
+ "name" : "newRow",
"type" : "function",
- "desc" : "Disables a {@link Roo.TabPanelItem}. It cannot be the active tab, if it is this call is ignored.",
- "sig" : "(id)",
+ "desc" : "Create an empty record",
+ "sig" : "(data)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to disable.",
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "(optional) - overlay some values",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.data.Record",
+ "desc" : "record created."
+ }
+ ]
+ }
+ ],
+ "isAbstract" : true,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.data.ArrayReader",
+ "Roo.data.JsonReader",
+ "Roo.data.XmlReader"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.HttpProxy" : {
+ "props" : [
+ {
+ "name" : "autoAbort",
+ "type" : "Boolean",
+ "desc" : "Whether this request should abort any pending requests. (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "defaultHeaders",
+ "type" : "Object",
+ "desc" : "An object containing request headers which are added\n to each request made by this object. (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableCaching",
+ "type" : "Boolean",
+ "desc" : "True to add a unique cache-buster param to GET requests. (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "extraParams",
+ "type" : "Object",
+ "desc" : "An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "method",
+ "type" : "String",
+ "desc" : "T) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GE",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "GET",
+ "POST"
+ ]
+ },
+ {
+ "name" : "timeout",
+ "type" : "Number",
+ "desc" : "The timeout in milliseconds to be used for requests. (defaults to 30000)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "url",
+ "type" : "String",
+ "desc" : "The default URL to be used for requests to the server. (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforeload",
+ "type" : "function",
+ "desc" : "Fires before a network request is made to retrieve a data object.",
+ "sig" : "function (This, params)\n{\n\n}",
+ "memberOf" : "Roo.data.DataProxy",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "DataProxy object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "Object",
+ "desc" : "The params parameter to the load function.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enableTab",
+ "name" : "load",
"type" : "function",
- "desc" : "Enables a {@link Roo.TabPanelItem} that is disabled.",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the load method's callback is called.",
+ "sig" : "function (This, o, arg)\n{\n\n}",
+ "memberOf" : "Roo.data.DataProxy",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to enable.",
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "DataProxy object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The data object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "arg",
+ "type" : "Object",
+ "desc" : "The callback argument object passed to the load function.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "endUpdate",
+ "name" : "loadexception",
"type" : "function",
- "desc" : "Stops an update and resizes the tabs (if {@link #resizeTabs} is false this does nothing)",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires if an Exception occurs during data retrieval.",
+ "sig" : "function (This, o, arg, e)\n{\n\n}",
+ "memberOf" : "Roo.data.DataProxy",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "DataProxy object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The data object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "arg",
+ "type" : "Object",
+ "desc" : "The callback argument object passed to the load function.",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "The Exception.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "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" : "getActiveTab",
+ "name" : "capture",
"type" : "function",
- "desc" : "Gets the active {@link Roo.TabPanelItem}.",
- "sig" : "()\n{\n\n}",
- "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" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.TabPanelItem",
- "desc" : "The active TabPanelItem or null if none are active."
+ "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" : "getCount",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Returns the number of tabs in this TabPanel.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "",
+ "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" : "Number",
- "desc" : ""
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "getTab",
+ "name" : "getConnection",
"type" : "function",
- "desc" : "Returns the {@link Roo.TabPanelItem} with the specified id/index",
- "sig" : "(id)",
+ "desc" : "Return the {@link Roo.data.Connection} object being used by this Proxy.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to fetch.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.TabPanelItem",
- "desc" : ""
+ "type" : "Connection",
+ "desc" : "The Connection object. This object may be used to subscribe to events on\na finer-grained basis than the DataProxy events."
}
]
},
]
},
{
- "name" : "hideTab",
+ "name" : "load",
"type" : "function",
- "desc" : "Hides the {@link Roo.TabPanelItem} with the specified id/index",
- "sig" : "(id)",
+ "desc" : "Load data from the configured {@link Roo.data.Connection}, read the data object into\na block of Roo.data.Records using the passed {@link Roo.data.DataReader} implementation, and\nprocess that block using the passed callback.",
+ "sig" : "(params, reader, callback, scope, arg)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to hide.",
+ "name" : "params",
+ "type" : "Object",
+ "desc" : "An object containing properties which are to be used as HTTP parameters\nfor the request to the remote server.",
+ "isOptional" : false
+ },
+ {
+ "name" : "reader",
+ "type" : "Roo.data.DataReader",
+ "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "The function into which to pass the block of Roo.data.Records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "The scope in which to call the callback",
+ "isOptional" : false
+ },
+ {
+ "name" : "arg",
+ "type" : "Object",
+ "desc" : "An optional argument which is passed to the callback as its second parameter.",
"isOptional" : false
}
],
],
"returns" : []
},
- {
- "name" : "removeTab",
- "type" : "function",
- "desc" : "Removes a {@link Roo.TabPanelItem}.",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to remove.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setTabWidth",
- "type" : "function",
- "desc" : "Resizes all the tabs to the passed width",
- "sig" : "(The)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "The",
- "type" : "Number",
- "desc" : "new width",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "syncHeight",
- "type" : "function",
- "desc" : "Updates the tab body element to fit the height of the container element\nfor overflow scrolling",
- "sig" : "(targetHeight)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "targetHeight",
- "type" : "Number",
- "desc" : "(optional) Override the starting height from the elements height",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "un",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "unhideTab",
- "type" : "function",
- "desc" : "\"Unhides\" the {@link Roo.TabPanelItem} with the specified id/index.",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to unhide.",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.data" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.ArrayReader" : {
+ "Roo.data.JsonReader" : {
"props" : [
{
"name" : "fields",
{
"name" : "id",
"type" : "String",
- "desc" : "Name of the property within a row object that contains a record identifier value.\nas specified to {@link Roo.data.Record#create},\nor an {@link Roo.data.Record} object\n\n\ncreated using {@link Roo.data.Record#create}.",
+ "desc" : "Name of the property within a row object that contains a record identifier value.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "root",
+ "type" : "String",
+ "desc" : "name of the property which contains the Array of row objects.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "successProperty",
+ "type" : "String",
+ "desc" : "Name of the property from which to retrieve the success attribute used by forms.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "totalProperty",
+ "type" : "String",
+ "desc" : "Name of the property from which to retrieve the total number of records\nin the dataset. This is only needed if the whole dataset is not passed in one go, but is being\npaged from the remote server.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
}
]
},
+ {
+ "name" : "read",
+ "type" : "function",
+ "desc" : "This method is only used by a DataProxy which has retrieved data from a remote server.",
+ "sig" : "(response)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "response",
+ "type" : "Object",
+ "desc" : "The XHR object which contains the JSON data in its responseText.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "data A data block which is used by an Roo.data.Store object as\na cache of Roo.data.Records."
+ }
+ ]
+ },
{
"name" : "readRecords",
"type" : "function",
{
"name" : "o",
"type" : "Object",
- "desc" : "An Array of row objects which represents the dataset.",
+ "desc" : "An object which contains an Array of row objects in the property specified\nin the config as 'root, and optionally a property, specified in the config as 'totalProperty'\nwhich contains the total size of the dataset.",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Object",
- "desc" : "A data block which is used by an {@link Roo.data.Store} object as\na cache of Roo.data.Records."
+ "desc" : "data A data block which is used by an Roo.data.Store object as\na cache of Roo.data.Records."
}
]
}
"tree_children" : [],
"tree_parent" : []
},
- "Roo.data.Connection" : {
+ "Roo.data.JsonStore" : {
"props" : [
{
- "name" : "autoAbort",
- "type" : "Boolean",
- "desc" : "Whether this request should abort any pending requests. (defaults to false)",
- "memberOf" : "",
+ "name" : "baseParams",
+ "type" : "Object",
+ "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request",
+ "memberOf" : "Roo.data.Store",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "defaultHeaders",
- "type" : "Object",
- "desc" : "An object containing request headers which are added\n to each request made by this object. (defaults to undefined)",
- "memberOf" : "",
+ "name" : "data",
+ "type" : "Array",
+ "desc" : "Inline data to be loaded when the store is initialized.",
+ "memberOf" : "Roo.data.Store",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "disableCaching",
- "type" : "Boolean",
- "desc" : "True to add a unique cache-buster param to GET requests. (defaults to true)",
+ "name" : "fields",
+ "type" : "Array",
+ "desc" : "An array of field definition objects, or field name strings.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "extraParams",
- "type" : "Object",
- "desc" : "An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)",
- "memberOf" : "",
+ "name" : "isLocal",
+ "type" : "boolean",
+ "desc" : "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
+ "memberOf" : "Roo.data.Store",
"isOptional" : false,
"optvals" : []
},
"optvals" : []
},
{
- "name" : "method",
- "type" : "String",
- "desc" : "The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)",
- "memberOf" : "",
+ "name" : "multiSort",
+ "type" : "Boolean",
+ "desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)",
+ "memberOf" : "Roo.data.Store",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "timeout",
- "type" : "Number",
- "desc" : "The timeout in milliseconds to be used for requests. (defaults to 30000)",
- "memberOf" : "",
+ "name" : "proxy",
+ "type" : "Roo.data.DataProxy",
+ "desc" : "The Proxy object which provides access to a data object.",
+ "memberOf" : "Roo.data.Store",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "url",
- "type" : "String",
- "desc" : "The default URL to be used for requests to the server. (defaults to undefined)",
- "memberOf" : "",
+ "name" : "pruneModifiedRecords",
+ "type" : "boolean",
+ "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "reader",
+ "type" : "Roo.data.DataReader",
+ "desc" : "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.",
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "remoteSort",
+ "type" : "boolean",
+ "desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sortInfo",
+ "type" : "Object",
+ "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
+ "memberOf" : "Roo.data.Store",
"isOptional" : false,
"optvals" : []
}
],
"events" : [
{
- "name" : "beforerequest",
+ "name" : "add",
"type" : "function",
- "desc" : "Fires before a network request is made to retrieve a data object.",
- "sig" : "function (conn, options)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when Records have been added to the Store",
+ "sig" : "function (_self, records, index)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "conn",
- "type" : "Connection",
- "desc" : "This Connection object.",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "The array of Records added",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index at which the record(s) were added",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeload",
+ "type" : "function",
+ "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.",
+ "sig" : "function (_self, options)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
"name" : "options",
"type" : "Object",
- "desc" : "The options config object passed to the {@link #request} method.",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "requestcomplete",
+ "name" : "beforeloadadd",
"type" : "function",
- "desc" : "Fires if the request was successfully completed.",
- "sig" : "function (conn, response, options)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after a new set of Records has been loaded.",
+ "sig" : "function (_self, records, options)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "conn",
- "type" : "Connection",
- "desc" : "This Connection object.",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "response",
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "The Records that were loaded",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
"type" : "Object",
- "desc" : "The XHR object containing the response data.\nSee {@link http://www.w3.org/TR/XMLHttpRequest/} for details.",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "clear",
+ "type" : "function",
+ "desc" : "Fires when the data cache has been cleared.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "datachanged",
+ "type" : "function",
+ "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "load",
+ "type" : "function",
+ "desc" : "Fires after a new set of Records has been loaded, before they are added to the store.",
+ "sig" : "function (_self, records, options)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "The Records that were loaded",
"isOptional" : false
},
{
"name" : "options",
"type" : "Object",
- "desc" : "The options config object passed to the {@link #request} method.",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "requestexception",
+ "name" : "loadexception",
"type" : "function",
- "desc" : "Fires if an error HTTP status was returned from the server.\nSee {@link http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html} for details of HTTP status codes.",
- "sig" : "function (conn, response, options)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args",
+ "sig" : "function (, ret, opts, jsonData)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "conn",
- "type" : "Connection",
- "desc" : "This Connection object.",
+ "name" : "",
+ "type" : "Proxy",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "response",
+ "name" : "ret",
"type" : "Object",
- "desc" : "The XHR object containing the response data.\nSee {@link http://www.w3.org/TR/XMLHttpRequest/} for details.",
+ "desc" : "return data from JsonData.reader() - success, totalRecords, records",
"isOptional" : false
},
{
- "name" : "options",
+ "name" : "opts",
"type" : "Object",
- "desc" : "The options config object passed to the {@link #request} method.",
+ "desc" : "- load Options",
+ "isOptional" : false
+ },
+ {
+ "name" : "jsonData",
+ "type" : "Object",
+ "desc" : "from your request (normally this contains the Exception)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "metachange",
+ "type" : "function",
+ "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.",
+ "sig" : "function (_self, meta)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "meta",
+ "type" : "Object",
+ "desc" : "The JSON metadata",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "remove",
+ "type" : "function",
+ "desc" : "Fires when a Record has been removed from the Store",
+ "sig" : "function (_self, record, index)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The Record that was removed",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index at which the record was removed",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "update",
+ "type" : "function",
+ "desc" : "Fires when a Record has been updated",
+ "sig" : "function (_self, record, operation)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The Record that was updated",
+ "isOptional" : false
+ },
+ {
+ "name" : "operation",
+ "type" : "String",
+ "desc" : "The update operation being performed. Value may be one of:\n<pre><code>\n Roo.data.Record.EDIT\n Roo.data.Record.REJECT\n Roo.data.Record.COMMIT\n</code></pre>",
"isOptional" : false
}
],
],
"methods" : [
{
- "name" : "abort",
+ "name" : "add",
"type" : "function",
- "desc" : "Aborts any outstanding request.",
- "sig" : "(transactionId)",
+ "desc" : "Add Records to the Store and fires the add event.",
+ "sig" : "(records)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "transactionId",
- "type" : "Number",
- "desc" : "defaults to the last transaction",
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "An Array of Roo.data.Record objects to add to the cache.",
"isOptional" : false
}
],
],
"returns" : []
},
+ {
+ "name" : "clearFilter",
+ "type" : "function",
+ "desc" : "Revert to a view of the Record cache with no filtering applied.",
+ "sig" : "(suppressEvent)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "suppressEvent",
+ "type" : "Boolean",
+ "desc" : "If true the filter is cleared silently without notifying listeners",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "collect",
+ "type" : "function",
+ "desc" : "Collects unique values for a particular dataIndex from this store.",
+ "sig" : "(dataIndex, allowNull, bypassFilter)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "dataIndex",
+ "type" : "String",
+ "desc" : "The property to collect",
+ "isOptional" : false
+ },
+ {
+ "name" : "allowNull",
+ "type" : "Boolean",
+ "desc" : "(optional) Pass true to allow null, undefined or empty string values",
+ "isOptional" : false
+ },
+ {
+ "name" : "bypassFilter",
+ "type" : "Boolean",
+ "desc" : "(optional) Pass true to collect from all records, even ones which are filtered",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "An array of the unique values"
+ }
+ ]
+ },
+ {
+ "name" : "commitChanges",
+ "type" : "function",
+ "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "each",
+ "type" : "function",
+ "desc" : "Calls the specified function for each of the Records in the cache.",
+ "sig" : "(fn, scope)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call. The Record is passed as the first parameter.\nReturning <em>false</em> aborts and exits the iteration.",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to call the function (defaults to the Record).",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "filter",
+ "type" : "function",
+ "desc" : "Filter the records by a specified property.",
+ "sig" : "(field, value, anyMatch)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "field",
+ "type" : "String",
+ "desc" : "A field on your records",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "String/RegExp",
+ "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
+ "isOptional" : false
+ },
+ {
+ "name" : "anyMatch",
+ "type" : "Boolean",
+ "desc" : "True to match any part not just the beginning",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "filterBy",
+ "type" : "function",
+ "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.",
+ "sig" : "(fn, scope)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to be called, it will receive 2 args (record, id)",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the function (defaults to this)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
]
},
{
- "name" : "hasListener",
+ "name" : "getAt",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Get the Record at the specified index.",
+ "sig" : "(index)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the Record to find.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "Roo.data.Record",
+ "desc" : "The Record at the passed index. Returns undefined if not found."
}
]
},
{
- "name" : "isLoading",
+ "name" : "getById",
"type" : "function",
- "desc" : "Determine whether this object has a request outstanding.",
- "sig" : "(transactionId)",
+ "desc" : "Get the Record with the specified id.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "transactionId",
- "type" : "Number",
- "desc" : "defaults to the last transaction",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the Record to find.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if there is an outstanding request."
+ "type" : "Roo.data.Record",
+ "desc" : "The Record with the passed id. Returns undefined if not found."
}
]
},
{
- "name" : "on",
+ "name" : "getCount",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Gets the number of cached records.\n<p>\n<em>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size</em>",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "getModifiedRecords",
+ "type" : "function",
+ "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
+ "name" : "",
+ "type" : "Roo.data.Record[]",
+ "desc" : "An array of Records containing outstanding modifications."
+ }
+ ]
+ },
+ {
+ "name" : "getRange",
+ "type" : "function",
+ "desc" : "Returns a range of Records between specified indices.",
+ "sig" : "(startIndex, endIndex)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "startIndex",
+ "type" : "Number",
+ "desc" : "(optional) The starting index (defaults to 0)",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "endIndex",
+ "type" : "Number",
+ "desc" : "(optional) The ending index (defaults to the last Record in the Store)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.data.Record[]",
+ "desc" : "An array of Records"
+ }
+ ]
},
{
- "name" : "purgeListeners",
+ "name" : "getSortState",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Returns the sort state of the Store as an object with two properties:\n<pre><code>\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n</code></pre>",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "getTotalCount",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Gets the total number of records in the dataset as returned by the server.\n<p>\n<em>If using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size</em>",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "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" : "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",
+ "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" : "request",
+ "name" : "indexOf",
"type" : "function",
- "desc" : "Sends an HTTP request to a remote server.",
- "sig" : "(options)",
+ "desc" : "Get the index within the cache of the passed Record.",
+ "sig" : "(record)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "An object which may contain the following properties:<ul>\n<li><b>url</b> {String} The URL to which to send the request. Defaults to configured URL</li>\n<li><b>params</b> {Object/String/Function} An object containing properties which are used as parameters to the\nrequest, a url encoded string or a function to call to get either.</li>\n<li><b>method</b> {String} The HTTP method to use for the request. Defaults to the configured method, or\nif no method was configured, \"GET\" if no parameters are being sent, and \"POST\" if parameters are being sent.</li>\n<li><b>callback</b> {Function} The function to be called upon receipt of the HTTP response.\nThe callback is called regardless of success or failure and is passed the following parameters:<ul>\n<li>options {Object} The parameter to the request call.</li>\n<li>success {Boolean} True if the request succeeded.</li>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n</ul></li>\n<li><b>success</b> {Function} The function to be called upon success of the request.\nThe callback is passed the following parameters:<ul>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n<li>options {Object} The parameter to the request call.</li>\n</ul></li>\n<li><b>failure</b> {Function} The function to be called upon failure of the request.\nThe callback is passed the following parameters:<ul>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n<li>options {Object} The parameter to the request call.</li>\n</ul></li>\n<li><b>scope</b> {Object} The scope in which to execute the callbacks: The \"this\" object\nfor the callback function. Defaults to the browser window.</li>\n<li><b>form</b> {Object/String} A form object or id to pull parameters from.</li>\n<li><b>isUpload</b> {Boolean} True if the form object is a file upload (will usually be automatically detected).</li>\n<li><b>headers</b> {Object} Request headers to set for the request.</li>\n<li><b>xmlData</b> {Object} XML document to use for the post. Note: This will be used instead of\nparams for the post data. Any params will be appended to the URL.</li>\n<li><b>disableCaching</b> {Boolean} True to add a unique cache-buster param to GET requests.</li>\n</ul>",
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The Roo.data.Record object to to find.",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Number",
- "desc" : "transactionId"
+ "desc" : "The index of the passed Record. Returns -1 if not found."
}
]
},
{
- "name" : "un",
+ "name" : "indexOfId",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Get the index within the cache of the Record with the passed id.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "id",
"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",
+ "desc" : "The id of the Record to find.",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.Ajax"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.DataProxy" : {
- "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",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The index of the Record. Returns -1 if not found."
+ }
+ ]
+ },
{
- "name" : "beforeload",
+ "name" : "insert",
"type" : "function",
- "desc" : "Fires before a network request is made to retrieve a data object.",
- "sig" : "function (This, params)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Inserts Records to the Store at the given index and fires the add event.",
+ "sig" : "(index, records)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "This",
- "type" : "Object",
- "desc" : "DataProxy object.",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The start index at which to insert the passed Records.",
"isOptional" : false
},
{
- "name" : "params",
- "type" : "Object",
- "desc" : "The params parameter to the load function.",
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "An Array of Roo.data.Record objects to add to the cache.",
"isOptional" : false
}
],
{
"name" : "load",
"type" : "function",
- "desc" : "Fires before the load method's callback is called.",
- "sig" : "function (This, o, arg)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n<p>\nIf using remote paging, then the first load call must specify the <em>start</em>\nand <em>limit</em> properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n<p>\n<strong>It is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.</strong>\n<p>",
+ "sig" : "(options)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "This",
- "type" : "Object",
- "desc" : "DataProxy object.",
- "isOptional" : false
- },
- {
- "name" : "o",
- "type" : "Object",
- "desc" : "The data object.",
- "isOptional" : false
- },
- {
- "name" : "arg",
+ "name" : "options",
"type" : "Object",
- "desc" : "The callback argument object passed to the load function.",
+ "desc" : "An object containing properties which control loading options:<ul>\n<li>params {Object} An object containing properties to pass as HTTP parameters to a remote data source.</li>\n<li>params.data {Object} if you are using a MemoryProxy / JsonReader, use this as the data to load stuff..\n<pre>\n {\n data : data, // array of key=>value data like JsonReader\n total : data.length,\n success : true\n \n }\n </pre>\n }.</li>\n<li>callback {Function} A function to be called after the Records have been loaded. The callback is\npassed the following arguments:<ul>\n<li>r : Roo.data.Record[]</li>\n<li>options: Options object from the load call</li>\n<li>success: Boolean success indicator</li></ul></li>\n<li>scope {Object} Scope with which to call the callback (defaults to the Store object)</li>\n<li>add {Boolean} indicator to append loaded records rather than replace the current cache.</li>\n</ul>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "loadexception",
+ "name" : "loadData",
"type" : "function",
- "desc" : "Fires if an Exception occurs during data retrieval.",
- "sig" : "function (This, o, arg, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.",
+ "sig" : "(data, append)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "This",
- "type" : "Object",
- "desc" : "DataProxy object.",
- "isOptional" : false
- },
- {
- "name" : "o",
- "type" : "Object",
- "desc" : "The data object.",
- "isOptional" : false
- },
- {
- "name" : "arg",
+ "name" : "data",
"type" : "Object",
- "desc" : "The callback argument object passed to the load function.",
+ "desc" : "The data block from which to read the Records. The format of the data expected\nis dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Object",
- "desc" : "The Exception.",
+ "name" : "append",
+ "type" : "Boolean",
+ "desc" : "True to append the new Records rather than replace the existing cache.",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "addEvents",
+ "name" : "loadDataFromChildren",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "using 'cn' the nested child reader read the child array into it's child stores.",
+ "sig" : "(rec)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
+ "name" : "rec",
"type" : "Object",
- "desc" : "The object with the events defined",
+ "desc" : "The record with a 'children array",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "on",
"type" : "function",
- "desc" : "Appends an event handler to this component",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
"sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
{
"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>",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "purgeListeners",
"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,
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "query",
+ "type" : "function",
+ "desc" : "Query the records by a specified property.",
+ "sig" : "(field, value, anyMatch)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
+ "name" : "field",
+ "type" : "String",
+ "desc" : "A field on your records",
"isOptional" : false
},
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "value",
+ "type" : "String/RegExp",
+ "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "anyMatch",
+ "type" : "Boolean",
+ "desc" : "True to match any part not just the beginning",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "MixedCollection",
+ "desc" : "Returns an Roo.util.MixedCollection of the matched records"
+ }
+ ]
},
{
- "name" : "fireEvent",
+ "name" : "queryBy",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.",
+ "sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to be called, it will receive 2 args (record, id)",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the function (defaults to this)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "MixedCollection",
+ "desc" : "Returns an Roo.util.MixedCollection of the matched records"
}
]
},
{
- "name" : "hasListener",
+ "name" : "rejectChanges",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Cancel outstanding changes on all changed records.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "on",
+ "name" : "reload",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.",
+ "sig" : "(options)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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)",
+ "desc" : "(optional) An object containing properties which may override the options\nused in the last load operation. See {@link #load} for details (defaults to null, in which case\nthe most recently used options are reused).",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "remove",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Remove a Record from the Store and fires the remove event.",
+ "sig" : "(record)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "record",
+ "type" : "Ext.data.Record",
+ "desc" : "The Roo.data.Record object to remove from the cache.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "removeAll",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Remove all Records from the Store and fires the clear event.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
"returns" : []
},
{
- "name" : "un",
+ "name" : "setDefaultSort",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Sets the default sort column and order to be used by the next load operation.",
+ "sig" : "(fieldName, dir)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "fieldName",
"type" : "String",
- "desc" : "The type of event to listen for",
+ "desc" : "The name of the field to sort by.",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "dir",
+ "type" : "String",
+ "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "sort",
+ "type" : "function",
+ "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.",
+ "sig" : "(fieldName, dir)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "fieldName",
+ "type" : "String",
+ "desc" : "The name of the field to sort by.",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "dir",
+ "type" : "String",
+ "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "isAbstract" : true,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.data.HttpProxy"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.DataReader" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "newRow",
+ "name" : "sum",
"type" : "function",
- "desc" : "Create an empty record",
- "sig" : "(data)",
+ "desc" : "Sums the value of <i>property</i> for each record between start and end and returns the result.",
+ "sig" : "(property, start, end)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "data",
- "type" : "Object",
- "desc" : "(optional) - overlay some values",
+ "name" : "property",
+ "type" : "String",
+ "desc" : "A field on your records",
+ "isOptional" : false
+ },
+ {
+ "name" : "start",
+ "type" : "Number",
+ "desc" : "The record index to start at (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "end",
+ "type" : "Number",
+ "desc" : "The last record index to include (defaults to length - 1)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.data.Record",
- "desc" : "record created."
+ "type" : "Number",
+ "desc" : "The sum"
}
]
+ },
+ {
+ "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" : []
}
],
- "isAbstract" : true,
+ "isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.data.ArrayReader",
- "Roo.data.JsonReader",
- "Roo.data.XmlReader"
- ],
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.data.HttpProxy" : {
+ "Roo.data.MemoryProxy" : {
"props" : [
{
- "name" : "autoAbort",
- "type" : "Boolean",
- "desc" : "Whether this request should abort any pending requests. (defaults to false)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "defaultHeaders",
- "type" : "Object",
- "desc" : "An object containing request headers which are added\n to each request made by this object. (defaults to undefined)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "disableCaching",
- "type" : "Boolean",
- "desc" : "True to add a unique cache-buster param to GET requests. (defaults to true)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "extraParams",
+ "name" : "data",
"type" : "Object",
- "desc" : "An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)",
+ "desc" : "The data object which the Reader uses to construct a block of Roo.data.Records.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
- },
- {
- "name" : "method",
- "type" : "String",
- "desc" : "The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "timeout",
- "type" : "Number",
- "desc" : "The timeout in milliseconds to be used for requests. (defaults to 30000)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "url",
- "type" : "String",
- "desc" : "The default URL to be used for requests to the server. (defaults to undefined)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
}
],
"events" : [
}
]
},
- {
- "name" : "getConnection",
- "type" : "function",
- "desc" : "Return the {@link Roo.data.Connection} object being used by this Proxy.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Connection",
- "desc" : "The Connection object. This object may be used to subscribe to events on\na finer-grained basis than the DataProxy events."
- }
- ]
- },
{
"name" : "hasListener",
"type" : "function",
{
"name" : "load",
"type" : "function",
- "desc" : "Load data from the configured {@link Roo.data.Connection}, read the data object into\na block of Roo.data.Records using the passed {@link Roo.data.DataReader} implementation, and\nprocess that block using the passed callback.",
+ "desc" : "Load data from the requested source (in this case an in-memory\ndata object passed to the constructor), read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback.",
"sig" : "(params, reader, callback, scope, arg)",
"static" : false,
"memberOf" : "",
{
"name" : "params",
"type" : "Object",
- "desc" : "An object containing properties which are to be used as HTTP parameters\nfor the request to the remote server.",
+ "desc" : "This parameter is not used by the MemoryProxy class.",
"isOptional" : false
},
{
{
"name" : "callback",
"type" : "Function",
- "desc" : "The function into which to pass the block of Roo.data.
Records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
+ "desc" : "The function into which to pass the block of Roo.data.
records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
"isOptional" : false
},
{
"tree_children" : [],
"tree_parent" : []
},
- "Roo.data.JsonReader" : {
+ "Roo.data.Node" : {
"props" : [
- {
- "name" : "fields",
- "type" : "Array",
- "desc" : "Array of field definition objects",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "id",
"type" : "String",
- "desc" : "Name of the property within a row object that contains a record identifier value.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "root",
- "type" : "String",
- "desc" : "name of the property which contains the Array of row objects.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "successProperty",
- "type" : "String",
- "desc" : "Name of the property from which to retrieve the success attribute used by forms.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "totalProperty",
- "type" : "String",
- "desc" : "Name of the property from which to retrieve the total number of records\nin the dataset. This is only needed if the whole dataset is not passed in one go, but is being\npaged from the remote server.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
- {
- "name" : "newRow",
- "type" : "function",
- "desc" : "Create an empty record",
- "sig" : "(data)",
- "static" : false,
- "memberOf" : "Roo.data.DataReader",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "(optional) - overlay some values",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.data.Record",
- "desc" : "record created."
- }
- ]
- },
- {
- "name" : "read",
- "type" : "function",
- "desc" : "This method is only used by a DataProxy which has retrieved data from a remote server.",
- "sig" : "(response)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "response",
- "type" : "Object",
- "desc" : "The XHR object which contains the JSON data in its responseText.",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "data A data block which is used by an Roo.data.Store object as\na cache of Roo.data.Records."
- }
- ]
- },
- {
- "name" : "readRecords",
- "type" : "function",
- "desc" : "Create a data block containing Roo.data.Records from an XML document.",
- "sig" : "(o)",
- "static" : false,
+ "desc" : "The id for this node. If one is not specified, one is generated.",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Object",
- "desc" : "An object which contains an Array of row objects in the property specified\nin the config as 'root, and optionally a property, specified in the config as 'totalProperty'\nwhich contains the total size of the dataset.",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "data A data block which is used by an Roo.data.Store object as\na cache of Roo.data.Records."
- }
- ]
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.JsonStore" : {
- "props" : [
- {
- "name" : "baseParams",
- "type" : "Object",
- "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request",
- "memberOf" : "Roo.data.Store",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "data",
- "type" : "Array",
- "desc" : "Inline data to be loaded when the store is initialized.",
- "memberOf" : "Roo.data.Store",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "fields",
- "type" : "Array",
- "desc" : "An array of field definition objects, or field name strings.",
+ "name" : "leaf",
+ "type" : "Boolean",
+ "desc" : "true if this node is a leaf and does not have children",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
- {
- "name" : "isLocal",
- "type" : "boolean",
- "desc" : "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
- "memberOf" : "Roo.data.Store",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "listeners",
"type" : "Object",
"memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
- },
- {
- "name" : "multiSort",
- "type" : "Boolean",
- "desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)",
- "memberOf" : "Roo.data.Store",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "proxy",
- "type" : "Roo.data.DataProxy",
- "desc" : "The Proxy object which provides access to a data object.",
- "memberOf" : "Roo.data.Store",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "pruneModifiedRecords",
- "type" : "boolean",
- "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
- "memberOf" : "Roo.data.Store",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "reader",
- "type" : "Roo.data.DataReader",
- "desc" : "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.",
- "memberOf" : "Roo.data.Store",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "remoteSort",
- "type" : "boolean",
- "desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
- "memberOf" : "Roo.data.Store",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "sortInfo",
- "type" : "Object",
- "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
- "memberOf" : "Roo.data.Store",
- "isOptional" : false,
- "optvals" : []
}
],
"events" : [
{
- "name" : "add",
+ "name" : "append",
"type" : "function",
- "desc" : "Fires when Records have been added to the Store",
- "sig" : "function (_self, records, index)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Fires when a new child node is appended",
+ "sig" : "function (tree, _self, node, index)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
{
"name" : "this",
- "type" : "Store",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
},
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "The array of Records added",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The newly appended node",
"isOptional" : false
},
{
"name" : "index",
"type" : "Number",
- "desc" : "The index at which the record(s) were added",
+ "desc" : "The index of the newly appended node",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeload",
+ "name" : "beforeappend",
"type" : "function",
- "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.",
- "sig" : "function (_self, options)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Fires before a new child is appended, return false to cancel the append.",
+ "sig" : "function (tree, _self, node)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
{
"name" : "this",
- "type" : "Store",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node to be appended",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeloadadd",
+ "name" : "beforeinsert",
"type" : "function",
- "desc" : "Fires after a new set of Records has been loaded.",
- "sig" : "function (_self, records, options)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Fires before a new child is inserted, return false to cancel the insert.",
+ "sig" : "function (tree, _self, node, refNode)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
{
"name" : "this",
- "type" : "Store",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
},
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "The Records that were loaded",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node to be inserted",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "name" : "refNode",
+ "type" : "Node",
+ "desc" : "The child node the node is being inserted before",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "clear",
+ "name" : "beforemove",
"type" : "function",
- "desc" : "Fires when the data cache has been cleared.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Fires before this node is moved to a new location in the tree. Return false to cancel the move.",
+ "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "datachanged",
- "type" : "function",
- "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
"name" : "this",
- "type" : "Store",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "load",
- "type" : "function",
- "desc" : "Fires after a new set of Records has been loaded, before they are added to the store.",
- "sig" : "function (_self, records, options)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "oldParent",
+ "type" : "Node",
+ "desc" : "The parent of this node",
"isOptional" : false
},
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "The Records that were loaded",
+ "name" : "newParent",
+ "type" : "Node",
+ "desc" : "The new parent this node is moving to",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index it is being moved to",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "loadexception",
+ "name" : "beforeremove",
"type" : "function",
- "desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args",
- "sig" : "function (, return, load, jsonData)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Fires before a child is removed, return false to cancel the remove.",
+ "sig" : "function (tree, _self, node)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "",
- "type" : "Proxy",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "return",
- "type" : "Object",
- "desc" : "from JsonData.reader() - success, totalRecords, records",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
},
{
- "name" : "load",
- "type" : "Object",
- "desc" : "options",
+ "name" : "this",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
},
{
- "name" : "jsonData",
- "type" : "Object",
- "desc" : "from your request (normally this contains the Exception)",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node to be removed",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "metachange",
+ "name" : "insert",
"type" : "function",
- "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.",
- "sig" : "function (_self, meta)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Fires when a new child node is inserted.",
+ "sig" : "function (tree, _self, node, refNode)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
},
- {
- "name" : "meta",
- "type" : "Object",
- "desc" : "The JSON metadata",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "remove",
- "type" : "function",
- "desc" : "Fires when a Record has been removed from the Store",
- "sig" : "function (_self, record, index)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
{
"name" : "this",
- "type" : "Store",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
},
{
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The Record that was removed",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node inserted",
"isOptional" : false
},
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The index at which the record was removed",
+ "name" : "refNode",
+ "type" : "Node",
+ "desc" : "The child node the node was inserted before",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "update",
+ "name" : "move",
"type" : "function",
- "desc" : "Fires when a Record has been updated",
- "sig" : "function (_self, record, operation)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Fires when this node is moved to a new location in the tree",
+ "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
{
"name" : "this",
- "type" : "Store",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
},
{
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The Record that was updated",
+ "name" : "oldParent",
+ "type" : "Node",
+ "desc" : "The old parent of this node",
"isOptional" : false
},
{
- "name" : "operation",
- "type" : "String",
- "desc" : "The update operation being performed. Value may be one of:\n<pre><code>\n Roo.data.Record.EDIT\n Roo.data.Record.REJECT\n Roo.data.Record.COMMIT\n</code></pre>",
+ "name" : "newParent",
+ "type" : "Node",
+ "desc" : "The new parent of this node",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index it was moved to",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "add",
+ "name" : "remove",
"type" : "function",
- "desc" : "Add Records to the Store and fires the add event.",
- "sig" : "(records)",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a child node is removed",
+ "sig" : "function (tree, _self, node)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
+ "see" : "",
"params" : [
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "An Array of Roo.data.Record objects to add to the cache.",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
+ {
+ "name" : "this",
+ "type" : "Node",
+ "desc" : "This node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The removed node",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "capture",
+ "name" : "appendChild",
"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" : "Insert node(s) as the last child node of this node.",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"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",
+ "name" : "node",
+ "type" : "Node/Array",
+ "desc" : "The node or Array of nodes to append",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Node",
+ "desc" : "The appended node if single append, or null if an array was passed"
+ }
+ ]
},
{
- "name" : "clearFilter",
+ "name" : "bubble",
"type" : "function",
- "desc" : "Revert to a view of the Record cache with no filtering applied.",
- "sig" : "(suppressEvent)",
+ "desc" : "Bubbles up the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe bubble is stopped.",
+ "sig" : "(fn, scope, args)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "suppressEvent",
- "type" : "Boolean",
- "desc" : "If true the filter is cleared silently without notifying listeners",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the function (defaults to current node)",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Array",
+ "desc" : "(optional) The args to call the function with (default to passing the current node)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "collect",
+ "name" : "capture",
"type" : "function",
- "desc" : "Collects unique values for a particular dataIndex from this store.",
- "sig" : "(dataIndex, allowNull, bypassFilter)",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "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" : "dataIndex",
- "type" : "String",
- "desc" : "The property to collect",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "allowNull",
- "type" : "Boolean",
- "desc" : "(optional) Pass true to allow null, undefined or empty string values",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
"isOptional" : false
},
{
- "name" : "bypassFilter",
- "type" : "Boolean",
- "desc" : "(optional) Pass true to collect from all records, even ones which are filtered",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Array",
- "desc" : "An array of the unique values"
- }
- ]
- },
- {
- "name" : "commitChanges",
- "type" : "function",
- "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
"returns" : []
},
{
- "name" : "each",
+ "name" : "cascade",
"type" : "function",
- "desc" : "Calls the specified function for each of the Records in the cache.",
- "sig" : "(fn, scope)",
+ "desc" : "Cascades down the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe cascade is stopped on that branch.",
+ "sig" : "(fn, scope, args)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "fn",
"type" : "Function",
- "desc" : "The function to call. The Record is passed as the first parameter.\nReturning <em>false</em> aborts and exits the iteration.",
+ "desc" : "The function to call",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to call the function (defaults to the Record).",
+ "desc" : "(optional) The scope of the function (defaults to current node)",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Array",
+ "desc" : "(optional) The args to call the function with (default to passing the current node)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "filter",
+ "name" : "contains",
"type" : "function",
- "desc" : "Filter the records by a specified property.",
- "sig" : "(field, value, anyMatch)",
+ "desc" : "Returns true if this node is an ancestor (at any point) of the passed node.",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "field",
- "type" : "String",
- "desc" : "A field on your records",
- "isOptional" : false
- },
- {
- "name" : "value",
- "type" : "String/RegExp",
- "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
- "name" : "anyMatch",
+ "name" : "",
"type" : "Boolean",
- "desc" : "True to match any part not just the beginning",
- "isOptional" : false
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "filterBy",
+ "name" : "eachChild",
"type" : "function",
- "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.",
- "sig" : "(fn, scope)",
+ "desc" : "Interates the child nodes of this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe iteration stops.",
+ "sig" : "(fn, scope, args)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "fn",
"type" : "Function",
- "desc" : "The function to be called, it will receive 2 args (record, id)",
+ "desc" : "The function to call",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to this)",
+ "desc" : "(optional) The scope of the function (defaults to current node)",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Array",
+ "desc" : "(optional) The args to call the function with (default to passing the current node)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "findChild",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Finds the first child that has the attribute with the specified value.",
+ "sig" : "(attribute, value)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "attribute",
"type" : "String",
- "desc" : "",
+ "desc" : "The attribute name",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to search for",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "Node",
+ "desc" : "The found child or null if none was found"
}
]
},
{
- "name" : "getAt",
+ "name" : "findChildBy",
"type" : "function",
- "desc" : "Get the Record at the specified index.",
- "sig" : "(index)",
+ "desc" : "Finds the first child by a custom function. The child matches if the function passed\nreturns true.",
+ "sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the Record to find.",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.data.Record",
- "desc" : "The Record at the passed index. Returns undefined if not found."
+ "type" : "Node",
+ "desc" : "The found child or null if none was found"
}
]
},
{
- "name" : "getById",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Get the Record with the specified id.",
- "sig" : "(id)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The id of the Record to find.",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.data.Record",
- "desc" : "The Record with the passed id. Returns undefined if not found."
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "getCount",
+ "name" : "getDepth",
"type" : "function",
- "desc" : "Gets the number of cached records.\n<p>\n<em>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size</em>",
+ "desc" : "Returns depth of this node (the root node has a depth of 0)",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "getModifiedRecords",
+ "name" : "getOwnerTree",
"type" : "function",
- "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).",
+ "desc" : "Returns the tree this node is in.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.data.Record[]",
- "desc" : "An array of Records containing outstanding modifications."
+ "type" : "Tree",
+ "desc" : ""
}
]
},
{
- "name" : "getRange",
+ "name" : "getPath",
"type" : "function",
- "desc" : "Returns a range of Records between specified indices.",
- "sig" : "(startIndex, endIndex)",
+ "desc" : "Returns the path for this node. The path can be used to expand or select this node programmatically.",
+ "sig" : "(attr)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "startIndex",
- "type" : "Number",
- "desc" : "(optional) The starting index (defaults to 0)",
- "isOptional" : false
- },
- {
- "name" : "endIndex",
- "type" : "Number",
- "desc" : "(optional) The ending index (defaults to the last Record in the Store)",
+ "name" : "attr",
+ "type" : "String",
+ "desc" : "(optional) The attr to use for the path (defaults to the node's id)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.data.Record[]",
- "desc" : "An array of Records"
+ "type" : "String",
+ "desc" : "The path"
}
]
},
- {
- "name" : "getSortState",
- "type" : "function",
- "desc" : "Returns the sort state of the Store as an object with two properties:\n<pre><code>\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n</code></pre>",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "getTotalCount",
- "type" : "function",
- "desc" : "Gets the total number of records in the dataset as returned by the server.\n<p>\n<em>If using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size</em>",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "hasListener",
"type" : "function",
{
"name" : "indexOf",
"type" : "function",
- "desc" : "Get the index within the cache of the passed Record.",
- "sig" : "(record)",
+ "desc" : "Returns the index of a child node",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The Roo.data.Record object to to find.",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Number",
- "desc" : "The index of the passed Record. Returns -1 if not found."
+ "desc" : "The index of the node or -1 if it was not found"
}
]
},
{
- "name" : "indexOfId",
+ "name" : "insertBefore",
"type" : "function",
- "desc" : "Get the index within the cache of the Record with the passed id.",
- "sig" : "(id)",
+ "desc" : "Inserts the first node before the second node in this nodes childNodes collection.",
+ "sig" : "(node, refNode)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the Record to find.",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The node to insert",
+ "isOptional" : false
+ },
+ {
+ "name" : "refNode",
+ "type" : "Node",
+ "desc" : "The node to insert before (if null the node is appended)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "The index of the Record. Returns -1 if not found."
+ "type" : "Node",
+ "desc" : "The inserted node"
}
]
},
{
- "name" : "insert",
+ "name" : "isAncestor",
"type" : "function",
- "desc" : "Inserts Records to the Store at the given index and fires the add event.",
- "sig" : "(index, records)",
+ "desc" : "Returns true if the passed node is an ancestor (at any point) of this node.",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The start index at which to insert the passed Records.",
- "isOptional" : false
- },
- {
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "An Array of Roo.data.Record objects to add to the cache.",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "load",
+ "name" : "isFirst",
"type" : "function",
- "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n<p>\nIf using remote paging, then the first load call must specify the <em>start</em>\nand <em>limit</em> properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n<p>\n<strong>It is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.</strong>\n<p>",
- "sig" : "(options)",
+ "desc" : "Returns true if this node is the first child of its parent",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "An object containing properties which control loading options:<ul>\n<li>params {Object} An object containing properties to pass as HTTP parameters to a remote data source.</li>\n<li>params.data {Object} if you are using a MemoryProxy / JsonReader, use this as the data to load stuff..\n<pre>\n {\n data : data, // array of key=>value data like JsonReader\n total : data.length,\n success : true\n \n }\n </pre>\n }.</li>\n<li>callback {Function} A function to be called after the Records have been loaded. The callback is\npassed the following arguments:<ul>\n<li>r : Roo.data.Record[]</li>\n<li>options: Options object from the load call</li>\n<li>success: Boolean success indicator</li></ul></li>\n<li>scope {Object} Scope with which to call the callback (defaults to the Store object)</li>\n<li>add {Boolean} indicator to append loaded records rather than replace the current cache.</li>\n</ul>",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "loadData",
+ "name" : "isLast",
"type" : "function",
- "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.",
- "sig" : "(data, append)",
+ "desc" : "Returns true if this node is the last child of its parent",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "data",
- "type" : "Object",
- "desc" : "The data block from which to read the Records. The format of the data expected\nis dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.",
- "isOptional" : false
- },
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "isLeaf",
+ "type" : "function",
+ "desc" : "Returns true if this node is a leaf",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "append",
+ "name" : "",
"type" : "Boolean",
- "desc" : "True to append the new Records rather than replace the existing cache.",
- "isOptional" : false
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "loadDataFromChildren",
+ "name" : "item",
"type" : "function",
- "desc" : "using 'cn' the nested child reader read the child array into it's child stores.",
- "sig" : "(rec)",
+ "desc" : "Returns the child node at the specified index.",
+ "sig" : "(index)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "rec",
- "type" : "Object",
- "desc" : "The record with a 'children array",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Node",
+ "desc" : ""
+ }
+ ]
},
{
"name" : "on",
"returns" : []
},
{
- "name" : "query",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Query the records by a specified property.",
- "sig" : "(field, value, anyMatch)",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
+ "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" : "",
"requires" : "",
"params" : [
{
- "name" : "field",
- "type" : "String",
- "desc" : "A field on your records",
- "isOptional" : false
- },
- {
- "name" : "value",
- "type" : "String/RegExp",
- "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
- "isOptional" : false
- },
- {
- "name" : "anyMatch",
- "type" : "Boolean",
- "desc" : "True to match any part not just the beginning",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "MixedCollection",
- "desc" : "Returns an Roo.util.MixedCollection of the matched records"
- }
- ]
+ "returns" : []
},
{
- "name" : "queryBy",
+ "name" : "removeChild",
"type" : "function",
- "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.",
- "sig" : "(fn, scope)",
+ "desc" : "Removes a child node from this node.",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to be called, it will receive 2 args (record, id)",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to this)",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The node to remove",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "MixedCollection",
- "desc" : "Returns an Roo.util.MixedCollection of the matched records"
+ "type" : "Node",
+ "desc" : "The removed node"
}
]
},
{
- "name" : "rejectChanges",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Cancel outstanding changes on all changed records.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.data.Store",
- "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,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "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" : "reload",
+ "name" : "replaceChild",
"type" : "function",
- "desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.",
- "sig" : "(options)",
+ "desc" : "Replaces one child node in this node with another.",
+ "sig" : "(newChild, oldChild)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing properties which may override the options\nused in the last load operation. See {@link #load} for details (defaults to null, in which case\nthe most recently used options are reused).",
+ "name" : "newChild",
+ "type" : "Node",
+ "desc" : "The replacement node",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldChild",
+ "type" : "Node",
+ "desc" : "The node to replace",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Node",
+ "desc" : "The replaced node"
+ }
+ ]
},
{
- "name" : "remove",
+ "name" : "sort",
"type" : "function",
- "desc" : "Remove a Record from the Store and fires the remove event.",
- "sig" : "(record)",
+ "desc" : "Sorts this nodes children using the supplied sort function",
+ "sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "record",
- "type" : "Ext.data.Record",
- "desc" : "The Roo.data.Record object to remove from the cache.",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeAll",
- "type" : "function",
- "desc" : "Remove all Records from the Store and fires the clear event.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "removeListener",
+ "name" : "un",
"type" : "function",
- "desc" : "Removes a listener",
+ "desc" : "Removes a listener (shorthand for removeListener)",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
}
],
"returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.tree.AsyncTreeNode",
+ "Roo.tree.TreeNode"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.Record" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "commit",
+ "type" : "function",
+ "desc" : "Usually called by the {@link Roo.data.Store} which owns the Record.\nCommits all changes made to the Record since either creation, or the last commit operation.\n<p>\nDevelopers should subscribe to the {@link Roo.data.Store#update} event to have their code notified\nof commit operations.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
- "name" : "setDefaultSort",
+ "name" : "copy",
"type" : "function",
- "desc" : "Sets the default sort column and order to be used by the next load operation.",
- "sig" : "(fieldName, dir)",
+ "desc" : "Creates a copy of this record.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fieldName",
- "type" : "String",
- "desc" : "The name of the field to sort by.",
- "isOptional" : false
- },
- {
- "name" : "dir",
+ "name" : "id",
"type" : "String",
- "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
+ "desc" : "(optional) A new record id if you don't want to use this record's id",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Record",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "sort",
+ "name" : "create",
"type" : "function",
- "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.",
- "sig" : "(fieldName, dir)",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
+ "desc" : "Generate a constructor for a specific record layout.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "fieldName",
- "type" : "String",
- "desc" : "The name of the field to sort by.",
- "isOptional" : false
- },
- {
- "name" : "dir",
- "type" : "String",
- "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
+ "name" : "o",
+ "type" : "Array",
+ "desc" : "An Array of field definition objects which specify field names, and optionally,\ndata types, and a mapping for an {@link Roo.data.Reader} to extract the field's value from a data object.\nEach field definition object may contain the following properties: <ul>\n<li><b>name</b> : String<p style=\"margin-left:1em\">The name by which the field is referenced within the Record. This is referenced by,\nfor example the <em>dataIndex</em> property in column definition objects passed to {@link Roo.grid.ColumnModel}</p></li>\n<li><b>mapping</b> : String<p style=\"margin-left:1em\"> A path specification for use by the {@link Roo.data.Reader} implementation\nthat is creating the Record to access the data value from the data object. If an {@link Roo.data.JsonReader}\nis being used, then this is a string containing the javascript expression to reference the data relative to \nthe record item's root. If an {@link Roo.data.XmlReader} is being used, this is an {@link Roo.DomQuery} path\nto the data item relative to the record element. If the mapping expression is the same as the field name,\nthis may be omitted.</p></li>\n<li><b>type</b> : String<p style=\"margin-left:1em\"> The data type for conversion to displayable value. Possible values are\n<ul><li>auto (Default, implies no conversion)</li>\n<li>string</li>\n<li>int</li>\n<li>float</li>\n<li>boolean</li>\n<li>date</li></ul></p></li>\n<li><b>sortType</b> : Mixed<p style=\"margin-left:1em\"> A member of {@link Roo.data.SortTypes}.</p></li>\n<li><b>sortDir</b> : String<p style=\"margin-left:1em\"> Initial direction to sort. \"ASC\" or \"DESC\"</p></li>\n<li><b>convert</b> : Function<p style=\"margin-left:1em\"> A function which converts the value provided\nby the Reader into an object that will be stored in the Record. It is passed the\nfollowing parameters:<ul>\n<li><b>v</b> : Mixed<p style=\"margin-left:1em\">The data value as read by the Reader.</p></li>\n</ul></p></li>\n<li><b>dateFormat</b> : String<p style=\"margin-left:1em\"> A format String for the Date.parseDate function.</p></li>\n</ul>\n<br>usage:<br><pre><code>\nvar TopicRecord = Roo.data.Record.create(\n {name: 'title', mapping: 'topic_title'},\n {name: 'author', mapping: 'username'},\n {name: 'totalPosts', mapping: 'topic_replies', type: 'int'},\n {name: 'lastPost', mapping: 'post_time', type: 'date'},\n {name: 'lastPoster', mapping: 'user2'},\n {name: 'excerpt', mapping: 'post_text'}\n);\n\nvar myNewRecord = new TopicRecord({\n title: 'Do my job please',\n author: 'noobie',\n totalPosts: 1,\n lastPost: new Date(),\n lastPoster: 'Animal',\n excerpt: 'No way dude!'\n});\nmyStore.add(myNewRecord);\n</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "sum",
+ "name" : "get",
"type" : "function",
- "desc" : "Sums the value of <i>property</i> for each record between start and end and returns the result.",
- "sig" : "(property, start, end)",
+ "desc" : "Get the value of the named field.",
+ "sig" : "(name)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "property",
+ "name" : "name",
"type" : "String",
- "desc" : "A field on your records",
- "isOptional" : false
- },
- {
- "name" : "start",
- "type" : "Number",
- "desc" : "The record index to start at (defaults to 0)",
- "isOptional" : false
- },
- {
- "name" : "end",
- "type" : "Number",
- "desc" : "The last record index to include (defaults to length - 1)",
+ "desc" : "The name of the field to get the value of.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "The sum"
+ "type" : "Object",
+ "desc" : "The value of the field."
}
]
},
{
- "name" : "un",
+ "name" : "reject",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Usually called by the {@link Roo.data.Store} which owns the Record.\nRejects all changes made to the Record since either creation, or the last commit operation.\nModified fields are reverted to their original values.\n<p>\nDevelopers should subscribe to the {@link Roo.data.Store#update} event to have their code notified\nof reject operations.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "set",
+ "type" : "function",
+ "desc" : "Set the named field to the specified value.",
+ "sig" : "(name, value)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "name",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "The name of the field to set.",
"isOptional" : false
},
{
- "name" : "scope",
+ "name" : "value",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "The value to set the field to.",
"isOptional" : false
}
],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.data.MemoryProxy" : {
- "props" : [],
+ "Roo.data.ScriptTagProxy" : {
+ "props" : [
+ {
+ "name" : "callbackParam",
+ "type" : "String",
+ "desc" : "The name of the parameter to pass to the server which tells\nthe server the name of the callback function set up by the load call to process the returned data object.\nDefaults to \"callback\".<p>The server-side processing must read this parameter value, and generate\njavascript output which calls this named function passing the data object as its only parameter.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "nocache",
+ "type" : "Boolean",
+ "desc" : "Defaults to true. Disable cacheing by adding a unique parameter\nname to the request.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "timeout",
+ "type" : "Number",
+ "desc" : "The number of milliseconds to wait for a response. Defaults to 30 seconds.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "url",
+ "type" : "String",
+ "desc" : "The URL from which to request the data object.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
"events" : [],
"methods" : [
+ {
+ "name" : "abort",
+ "type" : "function",
+ "desc" : "Abort the current server request.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "load",
"type" : "function",
- "desc" : "Load data from the requested source (in this case an in-memory\ndata object passed to the constructor), read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback.",
+ "desc" : "Load data from the configured URL, read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback.",
"sig" : "(params, reader, callback, scope, arg)",
"static" : false,
"memberOf" : "",
{
"name" : "params",
"type" : "Object",
- "desc" : "This parameter is not used by the MemoryProxy class.",
+ "desc" : "An object containing properties which are to be used as HTTP parameters\nfor the request to the remote server.",
"isOptional" : false
},
{
{
"name" : "callback",
"type" : "Function",
- "desc" : "The function into which to pass the block of Roo.data.
records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
+ "desc" : "The function into which to pass the block of Roo.data.
Records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
"isOptional" : false
},
{
"tree_children" : [],
"tree_parent" : []
},
- "Roo.data.Node" : {
+ "Roo.data.SimpleStore" : {
"props" : [
{
- "name" : "id",
- "type" : "String",
- "desc" : "The id for this node. If one is not specified, one is generated.",
+ "name" : "an",
+ "type" : "Object",
+ "desc" : "existing reader (eg. copied from another store)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "leaf",
- "type" : "Boolean",
- "desc" : "true if this node is a leaf and does not have children",
+ "name" : "baseParams",
+ "type" : "Object",
+ "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request",
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "data",
+ "type" : "Array",
+ "desc" : "The multi-dimensional array of data",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fields",
+ "type" : "Array",
+ "desc" : "An array of field definition objects, or field name strings.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "id",
+ "type" : "Number",
+ "desc" : "The array index of the record id. Leave blank to auto generate ids.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "isLocal",
+ "type" : "boolean",
+ "desc" : "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
+ },
+ {
+ "name" : "multiSort",
+ "type" : "Boolean",
+ "desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)",
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "proxy",
+ "type" : "Roo.data.DataProxy",
+ "desc" : "[not-required]",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "pruneModifiedRecords",
+ "type" : "boolean",
+ "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "reader",
+ "type" : "Roo.data.Reader",
+ "desc" : "[not-required]",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "remoteSort",
+ "type" : "boolean",
+ "desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sortInfo",
+ "type" : "Object",
+ "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
- "name" : "append",
+ "name" : "add",
"type" : "function",
- "desc" : "Fires when a new child node is appended",
- "sig" : "function (tree, _self, node, index)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when Records have been added to the Store",
+ "sig" : "function (_self, records, index)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "this",
- "type" : "Node",
- "desc" : "This node",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The newly appended node",
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "The array of Records added",
"isOptional" : false
},
{
"name" : "index",
"type" : "Number",
- "desc" : "The index of the newly appended node",
+ "desc" : "The index at which the record(s) were added",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeappend",
+ "name" : "beforeload",
"type" : "function",
- "desc" : "Fires before a new child is appended, return false to cancel the append.",
- "sig" : "function (tree, _self, node)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.",
+ "sig" : "function (_self, options)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
- {
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
{
"name" : "this",
- "type" : "Node",
- "desc" : "This node",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node to be appended",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeinsert",
+ "name" : "beforeloadadd",
"type" : "function",
- "desc" : "Fires before a new child is inserted, return false to cancel the insert.",
- "sig" : "function (tree, _self, node, refNode)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after a new set of Records has been loaded.",
+ "sig" : "function (_self, records, options)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
- {
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
{
"name" : "this",
- "type" : "Node",
- "desc" : "This node",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node to be inserted",
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "The Records that were loaded",
"isOptional" : false
},
{
- "name" : "refNode",
- "type" : "Node",
- "desc" : "The child node the node is being inserted before",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforemove",
+ "name" : "clear",
"type" : "function",
- "desc" : "Fires before this node is moved to a new location in the tree. Return false to cancel the move.",
- "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when the data cache has been cleared.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
- {
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
{
"name" : "this",
- "type" : "Node",
- "desc" : "This node",
- "isOptional" : false
- },
- {
- "name" : "oldParent",
- "type" : "Node",
- "desc" : "The parent of this node",
- "isOptional" : false
- },
- {
- "name" : "newParent",
- "type" : "Node",
- "desc" : "The new parent this node is moving to",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "datachanged",
+ "type" : "function",
+ "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The index it is being moved to",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeremove",
+ "name" : "load",
"type" : "function",
- "desc" : "Fires before a child is removed, return false to cancel the remove.",
- "sig" : "function (tree, _self, node)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after a new set of Records has been loaded, before they are added to the store.",
+ "sig" : "function (_self, records, options)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "this",
- "type" : "Node",
- "desc" : "This node",
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "The Records that were loaded",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node to be removed",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "insert",
+ "name" : "loadexception",
"type" : "function",
- "desc" : "Fires when a new child node is inserted.",
- "sig" : "function (tree, _self, node, refNode)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args",
+ "sig" : "function (, ret, opts, jsonData)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
+ "name" : "",
+ "type" : "Proxy",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "this",
- "type" : "Node",
- "desc" : "This node",
+ "name" : "ret",
+ "type" : "Object",
+ "desc" : "return data from JsonData.reader() - success, totalRecords, records",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node inserted",
+ "name" : "opts",
+ "type" : "Object",
+ "desc" : "- load Options",
"isOptional" : false
},
{
- "name" : "refNode",
- "type" : "Node",
- "desc" : "The child node the node was inserted before",
+ "name" : "jsonData",
+ "type" : "Object",
+ "desc" : "from your request (normally this contains the Exception)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "move",
+ "name" : "metachange",
"type" : "function",
- "desc" : "Fires when this node is moved to a new location in the tree",
- "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.",
+ "sig" : "function (_self, meta)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "this",
- "type" : "Node",
- "desc" : "This node",
+ "name" : "meta",
+ "type" : "Object",
+ "desc" : "The JSON metadata",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "remove",
+ "type" : "function",
+ "desc" : "Fires when a Record has been removed from the Store",
+ "sig" : "function (_self, record, index)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "oldParent",
- "type" : "Node",
- "desc" : "The old parent of this node",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "newParent",
- "type" : "Node",
- "desc" : "The new parent of this node",
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The Record that was removed",
"isOptional" : false
},
{
"name" : "index",
"type" : "Number",
- "desc" : "The index it was moved to",
+ "desc" : "The index at which the record was removed",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "update",
"type" : "function",
- "desc" : "Fires when a child node is removed",
- "sig" : "function (tree, _self, node)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when a Record has been updated",
+ "sig" : "function (_self, record, operation)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "this",
- "type" : "Node",
- "desc" : "This node",
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The Record that was updated",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The removed node",
+ "name" : "operation",
+ "type" : "String",
+ "desc" : "The update operation being performed. Value may be one of:\n<pre><code>\n Roo.data.Record.EDIT\n Roo.data.Record.REJECT\n Roo.data.Record.COMMIT\n</code></pre>",
"isOptional" : false
}
],
}
],
"methods" : [
+ {
+ "name" : "add",
+ "type" : "function",
+ "desc" : "Add Records to the Store and fires the add event.",
+ "sig" : "(records)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "An Array of Roo.data.Record objects to add to the cache.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "appendChild",
+ "name" : "capture",
"type" : "function",
- "desc" : "Insert node(s) as the last child node of this node.",
- "sig" : "(node)",
- "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" : "node",
- "type" : "Node/Array",
- "desc" : "The node or Array of nodes to append",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Node",
- "desc" : "The appended node if single append, or null if an array was passed"
+ "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" : "bubble",
+ "name" : "clearFilter",
"type" : "function",
- "desc" : "Bubbles up the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe bubble is stopped.",
- "sig" : "(fn, scope, args)",
+ "desc" : "Revert to a view of the Record cache with no filtering applied.",
+ "sig" : "(suppressEvent)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to current node)",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Array",
- "desc" : "(optional) The args to call the function with (default to passing the current node)",
+ "name" : "suppressEvent",
+ "type" : "Boolean",
+ "desc" : "If true the filter is cleared silently without notifying listeners",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "collect",
"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" : "Collects unique values for a particular dataIndex from this store.",
+ "sig" : "(dataIndex, allowNull, bypassFilter)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
+ "name" : "dataIndex",
+ "type" : "String",
+ "desc" : "The property to collect",
"isOptional" : false
},
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "allowNull",
+ "type" : "Boolean",
+ "desc" : "(optional) Pass true to allow null, undefined or empty string values",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "bypassFilter",
+ "type" : "Boolean",
+ "desc" : "(optional) Pass true to collect from all records, even ones which are filtered",
"isOptional" : false
}
],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "An array of the unique values"
+ }
+ ]
+ },
+ {
+ "name" : "commitChanges",
+ "type" : "function",
+ "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "cascade",
+ "name" : "each",
"type" : "function",
- "desc" : "Cascades down the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe cascade is stopped on that branch.",
- "sig" : "(fn, scope, args)",
+ "desc" : "Calls the specified function for each of the Records in the cache.",
+ "sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "fn",
"type" : "Function",
- "desc" : "The function to call",
+ "desc" : "The function to call. The Record is passed as the first parameter.\nReturning <em>false</em> aborts and exits the iteration.",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to current node)",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Array",
- "desc" : "(optional) The args to call the function with (default to passing the current node)",
+ "desc" : "(optional) The scope in which to call the function (defaults to the Record).",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "contains",
+ "name" : "filter",
"type" : "function",
- "desc" : "Returns true if this node is an ancestor (at any point) of the passed node.",
- "sig" : "(node)",
+ "desc" : "Filter the records by a specified property.",
+ "sig" : "(field, value, anyMatch)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "Node",
- "desc" : "",
+ "name" : "field",
+ "type" : "String",
+ "desc" : "A field on your records",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
+ "name" : "value",
+ "type" : "String/RegExp",
+ "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
+ "isOptional" : false
+ },
+ {
+ "name" : "anyMatch",
"type" : "Boolean",
- "desc" : ""
+ "desc" : "True to match any part not just the beginning",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "eachChild",
+ "name" : "filterBy",
"type" : "function",
- "desc" : "Interates the child nodes of this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe iteration stops.",
- "sig" : "(fn, scope, args)",
+ "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.",
+ "sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "fn",
"type" : "Function",
- "desc" : "The function to call",
+ "desc" : "The function to be called, it will receive 2 args (record, id)",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to current node)",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Array",
- "desc" : "(optional) The args to call the function with (default to passing the current node)",
+ "desc" : "(optional) The scope of the function (defaults to this)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "findChild",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Finds the first child that has the attribute with the specified value.",
- "sig" : "(attribute, value)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "attribute",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The attribute name",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to search for",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Node",
- "desc" : "The found child or null if none was found"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "findChildBy",
+ "name" : "getAt",
"type" : "function",
- "desc" : "Finds the first child by a custom function. The child matches if the function passed\nreturns true.",
- "sig" : "(fn, scope)",
+ "desc" : "Get the Record at the specified index.",
+ "sig" : "(index)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the Record to find.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Node",
- "desc" : "The found child or null if none was found"
+ "type" : "Roo.data.Record",
+ "desc" : "The Record at the passed index. Returns undefined if not found."
}
]
},
{
- "name" : "fireEvent",
+ "name" : "getById",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Get the Record with the specified id.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "id",
"type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "desc" : "The id of the Record to find.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "Roo.data.Record",
+ "desc" : "The Record with the passed id. Returns undefined if not found."
}
]
},
{
- "name" : "getDepth",
+ "name" : "getCount",
"type" : "function",
- "desc" : "Returns depth of this node (the root node has a depth of 0)",
+ "desc" : "Gets the number of cached records.\n<p>\n<em>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size</em>",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getOwnerTree",
+ "name" : "getModifiedRecords",
"type" : "function",
- "desc" : "Returns the tree this node is in.",
+ "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Tree",
- "desc" : ""
+ "type" : "Roo.data.Record[]",
+ "desc" : "An array of Records containing outstanding modifications."
}
]
},
{
- "name" : "getPath",
+ "name" : "getRange",
"type" : "function",
- "desc" : "Returns the path for this node. The path can be used to expand or select this node programmatically.",
- "sig" : "(attr)",
+ "desc" : "Returns a range of Records between specified indices.",
+ "sig" : "(startIndex, endIndex)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "attr",
- "type" : "String",
- "desc" : "(optional) The attr to use for the path (defaults to the node's id)",
+ "name" : "startIndex",
+ "type" : "Number",
+ "desc" : "(optional) The starting index (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "endIndex",
+ "type" : "Number",
+ "desc" : "(optional) The ending index (defaults to the last Record in the Store)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "The path"
+ "type" : "Roo.data.Record[]",
+ "desc" : "An array of Records"
}
]
},
+ {
+ "name" : "getSortState",
+ "type" : "function",
+ "desc" : "Returns the sort state of the Store as an object with two properties:\n<pre><code>\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n</code></pre>",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "getTotalCount",
+ "type" : "function",
+ "desc" : "Gets the total number of records in the dataset as returned by the server.\n<p>\n<em>If using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size</em>",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "hasListener",
"type" : "function",
{
"name" : "indexOf",
"type" : "function",
- "desc" : "Returns the index of a child node",
- "sig" : "(node)",
+ "desc" : "Get the index within the cache of the passed Record.",
+ "sig" : "(record)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "Node",
- "desc" : "",
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The Roo.data.Record object to to find.",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Number",
- "desc" : "The index of the node or -1 if it was not found"
+ "desc" : "The index of the passed Record. Returns -1 if not found."
}
]
},
{
- "name" : "insertBefore",
+ "name" : "indexOfId",
"type" : "function",
- "desc" : "Inserts the first node before the second node in this nodes childNodes collection.",
- "sig" : "(node, refNode)",
+ "desc" : "Get the index within the cache of the Record with the passed id.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The node to insert",
- "isOptional" : false
- },
- {
- "name" : "refNode",
- "type" : "Node",
- "desc" : "The node to insert before (if null the node is appended)",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the Record to find.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Node",
- "desc" : "The inserted node"
+ "type" : "Number",
+ "desc" : "The index of the Record. Returns -1 if not found."
}
]
},
{
- "name" : "isAncestor",
+ "name" : "insert",
"type" : "function",
- "desc" : "Returns true if the passed node is an ancestor (at any point) of this node.",
- "sig" : "(node)",
+ "desc" : "Inserts Records to the Store at the given index and fires the add event.",
+ "sig" : "(index, records)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "Node",
- "desc" : "",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The start index at which to insert the passed Records.",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "An Array of Roo.data.Record objects to add to the cache.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "isFirst",
+ "name" : "load",
"type" : "function",
- "desc" : "Returns true if this node is the first child of its parent",
- "sig" : "()\n{\n\n}",
+ "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n<p>\nIf using remote paging, then the first load call must specify the <em>start</em>\nand <em>limit</em> properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n<p>\n<strong>It is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.</strong>\n<p>",
+ "sig" : "(options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "An object containing properties which control loading options:<ul>\n<li>params {Object} An object containing properties to pass as HTTP parameters to a remote data source.</li>\n<li>params.data {Object} if you are using a MemoryProxy / JsonReader, use this as the data to load stuff..\n<pre>\n {\n data : data, // array of key=>value data like JsonReader\n total : data.length,\n success : true\n \n }\n </pre>\n }.</li>\n<li>callback {Function} A function to be called after the Records have been loaded. The callback is\npassed the following arguments:<ul>\n<li>r : Roo.data.Record[]</li>\n<li>options: Options object from the load call</li>\n<li>success: Boolean success indicator</li></ul></li>\n<li>scope {Object} Scope with which to call the callback (defaults to the Store object)</li>\n<li>add {Boolean} indicator to append loaded records rather than replace the current cache.</li>\n</ul>",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "isLast",
+ "name" : "loadData",
"type" : "function",
- "desc" : "Returns true if this node is the last child of its parent",
- "sig" : "()\n{\n\n}",
+ "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.",
+ "sig" : "(data, append)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "isLeaf",
- "type" : "function",
- "desc" : "Returns true if this node is a leaf",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "The data block from which to read the Records. The format of the data expected\nis dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.",
+ "isOptional" : false
+ },
{
- "name" : "",
+ "name" : "append",
"type" : "Boolean",
- "desc" : ""
+ "desc" : "True to append the new Records rather than replace the existing cache.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "item",
+ "name" : "loadDataFromChildren",
"type" : "function",
- "desc" : "Returns the child node at the specified index.",
- "sig" : "(index)",
+ "desc" : "using 'cn' the nested child reader read the child array into it's child stores.",
+ "sig" : "(rec)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "",
+ "name" : "rec",
+ "type" : "Object",
+ "desc" : "The record with a 'children array",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Node",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
"name" : "on",
"params" : [],
"returns" : []
},
+ {
+ "name" : "query",
+ "type" : "function",
+ "desc" : "Query the records by a specified property.",
+ "sig" : "(field, value, anyMatch)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "field",
+ "type" : "String",
+ "desc" : "A field on your records",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "String/RegExp",
+ "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
+ "isOptional" : false
+ },
+ {
+ "name" : "anyMatch",
+ "type" : "Boolean",
+ "desc" : "True to match any part not just the beginning",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "MixedCollection",
+ "desc" : "Returns an Roo.util.MixedCollection of the matched records"
+ }
+ ]
+ },
+ {
+ "name" : "queryBy",
+ "type" : "function",
+ "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.",
+ "sig" : "(fn, scope)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to be called, it will receive 2 args (record, id)",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the function (defaults to this)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "MixedCollection",
+ "desc" : "Returns an Roo.util.MixedCollection of the matched records"
+ }
+ ]
+ },
+ {
+ "name" : "rejectChanges",
+ "type" : "function",
+ "desc" : "Cancel outstanding changes on all changed records.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "releaseCapture",
"type" : "function",
"returns" : []
},
{
- "name" : "removeChild",
+ "name" : "reload",
"type" : "function",
- "desc" : "Removes a child node from this node.",
- "sig" : "(node)",
+ "desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.",
+ "sig" : "(options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The node to remove",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing properties which may override the options\nused in the last load operation. See {@link #load} for details (defaults to null, in which case\nthe most recently used options are reused).",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "remove",
+ "type" : "function",
+ "desc" : "Remove a Record from the Store and fires the remove event.",
+ "sig" : "(record)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Node",
- "desc" : "The removed node"
+ "name" : "record",
+ "type" : "Ext.data.Record",
+ "desc" : "The Roo.data.Record object to remove from the cache.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeAll",
+ "type" : "function",
+ "desc" : "Remove all Records from the Store and fires the clear event.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
"name" : "removeListener",
"returns" : []
},
{
- "name" : "replaceChild",
+ "name" : "setDefaultSort",
"type" : "function",
- "desc" : "Replaces one child node in this node with another.",
- "sig" : "(newChild, oldChild)",
+ "desc" : "Sets the default sort column and order to be used by the next load operation.",
+ "sig" : "(fieldName, dir)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "newChild",
- "type" : "Node",
- "desc" : "The replacement node",
+ "name" : "fieldName",
+ "type" : "String",
+ "desc" : "The name of the field to sort by.",
"isOptional" : false
},
{
- "name" : "oldChild",
- "type" : "Node",
- "desc" : "The node to replace",
+ "name" : "dir",
+ "type" : "String",
+ "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Node",
- "desc" : "The replaced node"
- }
- ]
+ "returns" : []
},
{
"name" : "sort",
"type" : "function",
- "desc" : "Sorts this nodes children using the supplied sort function",
- "sig" : "(fn, scope)",
+ "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.",
+ "sig" : "(fieldName, dir)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "",
+ "name" : "fieldName",
+ "type" : "String",
+ "desc" : "The name of the field to sort by.",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "dir",
+ "type" : "String",
+ "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "sum",
+ "type" : "function",
+ "desc" : "Sums the value of <i>property</i> for each record between start and end and returns the result.",
+ "sig" : "(property, start, end)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "property",
+ "type" : "String",
+ "desc" : "A field on your records",
+ "isOptional" : false
+ },
+ {
+ "name" : "start",
+ "type" : "Number",
+ "desc" : "The record index to start at (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "end",
+ "type" : "Number",
+ "desc" : "The last record index to include (defaults to length - 1)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The sum"
+ }
+ ]
+ },
{
"name" : "un",
"type" : "function",
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.tree.AsyncTreeNode",
- "Roo.tree.TreeNode"
- ],
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.data.Record" : {
+ "Roo.data.SortTypes" : {
"props" : [],
"events" : [],
"methods" : [
{
- "name" : "commit",
- "type" : "function",
- "desc" : "Usually called by the {@link Roo.data.Store} which owns the Record.\nCommits all changes made to the Record since either creation, or the last commit operation.\n<p>\nDevelopers should subscribe to the {@link Roo.data.Store#update} event to have their code notified\nof commit operations.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "copy",
+ "name" : "asDate",
"type" : "function",
- "desc" : "Creates a copy of this record.",
- "sig" : "(id)",
- "static" : false,
+ "desc" : "Date sorting",
+ "sig" : "(s)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String",
- "desc" : "(optional) A new record id if you don't want to use this record's id",
+ "name" : "s",
+ "type" : "Mixed",
+ "desc" : "The value being converted",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Record",
- "desc" : ""
+ "type" : "Number",
+ "desc" : "The comparison value"
}
]
},
{
- "name" : "create",
+ "name" : "asFloat",
"type" : "function",
- "desc" : "Generate a constructor for a specific record layout.",
- "sig" : "(o)",
+ "desc" : "Float sorting",
+ "sig" : "(s)",
"static" : true,
"memberOf" : "",
"isStatic" : true,
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Array",
- "desc" : "An Array of field definition objects which specify field names, and optionally,\ndata types, and a mapping for an {@link Roo.data.Reader} to extract the field's value from a data object.\nEach field definition object may contain the following properties: <ul>\n<li><b>name</b> : String<p style=\"margin-left:1em\">The name by which the field is referenced within the Record. This is referenced by,\nfor example the <em>dataIndex</em> property in column definition objects passed to {@link Roo.grid.ColumnModel}</p></li>\n<li><b>mapping</b> : String<p style=\"margin-left:1em\"> A path specification for use by the {@link Roo.data.Reader} implementation\nthat is creating the Record to access the data value from the data object. If an {@link Roo.data.JsonReader}\nis being used, then this is a string containing the javascript expression to reference the data relative to \nthe record item's root. If an {@link Roo.data.XmlReader} is being used, this is an {@link Roo.DomQuery} path\nto the data item relative to the record element. If the mapping expression is the same as the field name,\nthis may be omitted.</p></li>\n<li><b>type</b> : String<p style=\"margin-left:1em\"> The data type for conversion to displayable value. Possible values are\n<ul><li>auto (Default, implies no conversion)</li>\n<li>string</li>\n<li>int</li>\n<li>float</li>\n<li>boolean</li>\n<li>date</li></ul></p></li>\n<li><b>sortType</b> : Mixed<p style=\"margin-left:1em\"> A member of {@link Roo.data.SortTypes}.</p></li>\n<li><b>sortDir</b> : String<p style=\"margin-left:1em\"> Initial direction to sort. \"ASC\" or \"DESC\"</p></li>\n<li><b>convert</b> : Function<p style=\"margin-left:1em\"> A function which converts the value provided\nby the Reader into an object that will be stored in the Record. It is passed the\nfollowing parameters:<ul>\n<li><b>v</b> : Mixed<p style=\"margin-left:1em\">The data value as read by the Reader.</p></li>\n</ul></p></li>\n<li><b>dateFormat</b> : String<p style=\"margin-left:1em\"> A format String for the Date.parseDate function.</p></li>\n</ul>\n<br>usage:<br><pre><code>\nvar TopicRecord = Roo.data.Record.create(\n {name: 'title', mapping: 'topic_title'},\n {name: 'author', mapping: 'username'},\n {name: 'totalPosts', mapping: 'topic_replies', type: 'int'},\n {name: 'lastPost', mapping: 'post_time', type: 'date'},\n {name: 'lastPoster', mapping: 'user2'},\n {name: 'excerpt', mapping: 'post_text'}\n);\n\nvar myNewRecord = new TopicRecord({\n title: 'Do my job please',\n author: 'noobie',\n totalPosts: 1,\n lastPost: new Date(),\n lastPoster: 'Animal',\n excerpt: 'No way dude!'\n});\nmyStore.add(myNewRecord);\n</code></pre>",
+ "name" : "s",
+ "type" : "Mixed",
+ "desc" : "The value being converted",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Float",
+ "desc" : "The comparison value"
+ }
+ ]
},
{
- "name" : "get",
+ "name" : "asInt",
"type" : "function",
- "desc" : "Get the value of the named field.",
- "sig" : "(name)",
- "static" : false,
+ "desc" : "Integer sorting",
+ "sig" : "(s)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "name",
- "type" : "String",
- "desc" : "The name of the field to get the value of.",
+ "name" : "s",
+ "type" : "Mixed",
+ "desc" : "The value being converted",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "The value of the field."
+ "type" : "Number",
+ "desc" : "The comparison value"
}
]
},
{
- "name" : "reject",
+ "name" : "asText",
"type" : "function",
- "desc" : "Usually called by the {@link Roo.data.Store} which owns the Record.\nRejects all changes made to the Record since either creation, or the last commit operation.\nModified fields are reverted to their original values.\n<p>\nDevelopers should subscribe to the {@link Roo.data.Store#update} event to have their code notified\nof reject operations.",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "desc" : "Strips all HTML tags to sort on text only",
+ "sig" : "(s)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "s",
+ "type" : "Mixed",
+ "desc" : "The value being converted",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "The comparison value"
+ }
+ ]
},
{
- "name" : "set",
+ "name" : "asUCString",
"type" : "function",
- "desc" : "Set the named field to the specified value.",
- "sig" : "(name, value)",
- "static" : false,
+ "desc" : "Case insensitive string",
+ "sig" : "(s)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "name",
- "type" : "String",
- "desc" : "The name of the field to set.",
- "isOptional" : false
- },
- {
- "name" : "value",
- "type" : "Object",
- "desc" : "The value to set the field to.",
+ "name" : "s",
+ "type" : "Mixed",
+ "desc" : "The value being converted",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.ScriptTagProxy" : {
- "props" : [
- {
- "name" : "callbackParam",
- "type" : "String",
- "desc" : "The name of the parameter to pass to the server which tells\nthe server the name of the callback function set up by the load call to process the returned data object.\nDefaults to \"callback\".<p>The server-side processing must read this parameter value, and generate\njavascript output which calls this named function passing the data object as its only parameter.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "nocache",
- "type" : "Boolean",
- "desc" : "Defaults to true. Disable cacheing by adding a unique parameter\nname to the request.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "timeout",
- "type" : "Number",
- "desc" : "The number of milliseconds to wait for a response. Defaults to 30 seconds.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "The comparison value"
+ }
+ ]
},
{
- "name" : "url",
- "type" : "String",
- "desc" : "The URL from which to request the data object.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
- {
- "name" : "abort",
+ "name" : "asUCText",
"type" : "function",
- "desc" : "Abort the current server request.",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "desc" : "Strips all HTML tags to sort on text only - Case insensitive",
+ "sig" : "(s)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "s",
+ "type" : "Mixed",
+ "desc" : "The value being converted",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "The comparison value"
+ }
+ ]
},
{
- "name" : "load",
+ "name" : "none",
"type" : "function",
- "desc" : "Load data from the configured URL, read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback.",
- "sig" : "(params, reader, callback, scope, arg)",
- "static" : false,
+ "desc" : "Default sort that does nothing",
+ "sig" : "(s)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "params",
- "type" : "Object",
- "desc" : "An object containing properties which are to be used as HTTP parameters\nfor the request to the remote server.",
- "isOptional" : false
- },
- {
- "name" : "reader",
- "type" : "Roo.data.DataReader",
- "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "The function into which to pass the block of Roo.data.Records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "The scope in which to call the callback",
- "isOptional" : false
- },
- {
- "name" : "arg",
- "type" : "Object",
- "desc" : "An optional argument which is passed to the callback as its second parameter.",
+ "name" : "s",
+ "type" : "Mixed",
+ "desc" : "The value being converted",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "The comparison value"
+ }
+ ]
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.data.SimpleStore" : {
+ "Roo.data.Store" : {
"props" : [
- {
- "name" : "an",
- "type" : "Object",
- "desc" : "existing reader (eg. copied from another store)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "baseParams",
"type" : "Object",
"desc" : "An object containing properties which are to be sent as parameters\non any HTTP request",
- "memberOf" : "Roo.data.Store",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "data",
- "type" : "Array",
- "desc" : "The multi-dimensional array of data",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
- "name" : "fields",
+ "name" : "data",
"type" : "Array",
- "desc" : "An array of field definition objects, or field name strings.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "id",
- "type" : "Number",
- "desc" : "The array index of the record id. Leave blank to auto generate ids.",
+ "desc" : "Inline data to be loaded when the store is initialized.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"name" : "isLocal",
"type" : "boolean",
"desc" : "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"name" : "multiSort",
"type" : "Boolean",
"desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)",
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
"name" : "proxy",
"type" : "Roo.data.DataProxy",
- "desc" : "[not-required]",
+ "desc" : "The Proxy object which provides access to a data object.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"name" : "pruneModifiedRecords",
"type" : "boolean",
"desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
{
"name" : "reader",
- "type" : "Roo.data.Reader",
- "desc" : "[not-required]",
+ "type" : "Roo.data.DataReader",
+ "desc" : "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"name" : "remoteSort",
"type" : "boolean",
"desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"name" : "sortInfo",
"type" : "Object",
"desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
}
"type" : "function",
"desc" : "Fires when Records have been added to the Store",
"sig" : "function (_self, records, index)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.",
"sig" : "function (_self, options)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after a new set of Records has been loaded.",
"sig" : "function (_self, records, options)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when the data cache has been cleared.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after a new set of Records has been loaded, before they are added to the store.",
"sig" : "function (_self, records, options)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"name" : "loadexception",
"type" : "function",
"desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args",
- "sig" : "function (, return, load, jsonData)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "sig" : "function (, ret, opts, jsonData)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
},
{
- "name" : "return",
+ "name" : "ret",
"type" : "Object",
- "desc" : "from JsonData.reader() - success, totalRecords, records",
+ "desc" : "return data from JsonData.reader() - success, totalRecords, records",
"isOptional" : false
},
{
- "name" : "load",
+ "name" : "opts",
"type" : "Object",
- "desc" : "options",
+ "desc" : "- load Options",
"isOptional" : false
},
{
"type" : "function",
"desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.",
"sig" : "function (_self, meta)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when a Record has been removed from the Store",
"sig" : "function (_self, record, index)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when a Record has been updated",
"sig" : "function (_self, record, operation)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"desc" : "Add Records to the Store and fires the add event.",
"sig" : "(records)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Revert to a view of the Record cache with no filtering applied.",
"sig" : "(suppressEvent)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Collects unique values for a particular dataIndex from this store.",
"sig" : "(dataIndex, allowNull, bypassFilter)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Calls the specified function for each of the Records in the cache.",
"sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Filter the records by a specified property.",
"sig" : "(field, value, anyMatch)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.",
"sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Get the Record at the specified index.",
"sig" : "(index)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Get the Record with the specified id.",
"sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Gets the number of cached records.\n<p>\n<em>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size</em>",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns a range of Records between specified indices.",
"sig" : "(startIndex, endIndex)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns the sort state of the Store as an object with two properties:\n<pre><code>\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n</code></pre>",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Gets the total number of records in the dataset as returned by the server.\n<p>\n<em>If using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size</em>",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Get the index within the cache of the passed Record.",
"sig" : "(record)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Get the index within the cache of the Record with the passed id.",
"sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Inserts Records to the Store at the given index and fires the add event.",
"sig" : "(index, records)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n<p>\nIf using remote paging, then the first load call must specify the <em>start</em>\nand <em>limit</em> properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n<p>\n<strong>It is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.</strong>\n<p>",
"sig" : "(options)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.",
"sig" : "(data, append)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "using 'cn' the nested child reader read the child array into it's child stores.",
"sig" : "(rec)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Query the records by a specified property.",
"sig" : "(field, value, anyMatch)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.",
"sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Cancel outstanding changes on all changed records.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.",
"sig" : "(options)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Remove a Record from the Store and fires the remove event.",
"sig" : "(record)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Remove all Records from the Store and fires the clear event.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Sets the default sort column and order to be used by the next load operation.",
"sig" : "(fieldName, dir)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.",
"sig" : "(fieldName, dir)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Sums the value of <i>property</i> for each record between start and end and returns the result.",
"sig" : "(property, start, end)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
+ "implementations" : [
+ "Roo.data.JsonStore",
+ "Roo.data.SimpleStore"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.data.SortTypes" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ "Roo.data.Tree" : {
+ "props" : [
{
- "name" : "asDate",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "append",
"type" : "function",
- "desc" : "Date sorting",
- "sig" : "(s)",
- "static" : true,
+ "desc" : "Fires when a new child node is appended to a node in this tree.",
+ "sig" : "function (tree, parent, node, index)\n{\n\n}",
"memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "s",
- "type" : "Mixed",
- "desc" : "The value being converted",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Number",
- "desc" : "The comparison value"
- }
- ]
- },
- {
- "name" : "asFloat",
- "type" : "function",
- "desc" : "Float sorting",
- "sig" : "(s)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ "name" : "parent",
+ "type" : "Node",
+ "desc" : "The parent node",
+ "isOptional" : false
+ },
{
- "name" : "s",
- "type" : "Mixed",
- "desc" : "The value being converted",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The newly appended node",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Float",
- "desc" : "The comparison value"
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the newly appended node",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "asInt",
+ "name" : "beforeappend",
"type" : "function",
- "desc" : "Integer sorting",
- "sig" : "(s)",
- "static" : true,
+ "desc" : "Fires before a new child is appended to a node in this tree, return false to cancel the append.",
+ "sig" : "function (tree, parent, node)\n{\n\n}",
"memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "s",
- "type" : "Mixed",
- "desc" : "The value being converted",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Number",
- "desc" : "The comparison value"
- }
- ]
- },
- {
- "name" : "asText",
- "type" : "function",
- "desc" : "Strips all HTML tags to sort on text only",
- "sig" : "(s)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ "name" : "parent",
+ "type" : "Node",
+ "desc" : "The parent node",
+ "isOptional" : false
+ },
{
- "name" : "s",
- "type" : "Mixed",
- "desc" : "The value being converted",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node to be appended",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "The comparison value"
- }
- ]
+ "returns" : []
},
{
- "name" : "asUCString",
+ "name" : "beforeinsert",
"type" : "function",
- "desc" : "Case insensitive string",
- "sig" : "(s)",
- "static" : true,
+ "desc" : "Fires before a new child is inserted in a node in this tree, return false to cancel the insert.",
+ "sig" : "function (tree, parent, node, refNode)\n{\n\n}",
"memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "s",
- "type" : "Mixed",
- "desc" : "The value being converted",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "String",
- "desc" : "The comparison value"
- }
- ]
- },
- {
- "name" : "asUCText",
- "type" : "function",
- "desc" : "Strips all HTML tags to sort on text only - Case insensitive",
- "sig" : "(s)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ "name" : "parent",
+ "type" : "Node",
+ "desc" : "The parent node",
+ "isOptional" : false
+ },
{
- "name" : "s",
- "type" : "Mixed",
- "desc" : "The value being converted",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node to be inserted",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "String",
- "desc" : "The comparison value"
+ "name" : "refNode",
+ "type" : "Node",
+ "desc" : "The child node the node is being inserted before",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "none",
+ "name" : "beforemove",
"type" : "function",
- "desc" : "Default sort that does nothing",
- "sig" : "(s)",
- "static" : true,
+ "desc" : "Fires before a node is moved to a new location in the tree. Return false to cancel the move.",
+ "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}",
"memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "s",
- "type" : "Mixed",
- "desc" : "The value being converted",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Mixed",
- "desc" : "The comparison value"
- }
- ]
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.Store" : {
- "props" : [
- {
- "name" : "baseParams",
- "type" : "Object",
- "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "data",
- "type" : "Array",
- "desc" : "Inline data to be loaded when the store is initialized.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "isLocal",
- "type" : "boolean",
- "desc" : "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "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",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "multiSort",
- "type" : "Boolean",
- "desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "proxy",
- "type" : "Roo.data.DataProxy",
- "desc" : "The Proxy object which provides access to a data object.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "pruneModifiedRecords",
- "type" : "boolean",
- "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "reader",
- "type" : "Roo.data.DataReader",
- "desc" : "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "remoteSort",
- "type" : "boolean",
- "desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "sortInfo",
- "type" : "Object",
- "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
- {
- "name" : "add",
- "type" : "function",
- "desc" : "Fires when Records have been added to the Store",
- "sig" : "function (_self, records, index)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The node being moved",
+ "isOptional" : false
+ },
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "oldParent",
+ "type" : "Node",
+ "desc" : "The parent of the node",
"isOptional" : false
},
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "The array of Records added",
+ "name" : "newParent",
+ "type" : "Node",
+ "desc" : "The new parent the node is moving to",
"isOptional" : false
},
{
"name" : "index",
"type" : "Number",
- "desc" : "The index at which the record(s) were added",
+ "desc" : "The index it is being moved to",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeload",
+ "name" : "beforeremove",
"type" : "function",
- "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.",
- "sig" : "function (_self, options)\n{\n\n}",
+ "desc" : "Fires before a child is removed from a node in this tree, return false to cancel the remove.",
+ "sig" : "function (tree, parent, node)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "name" : "parent",
+ "type" : "Node",
+ "desc" : "The parent node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node to be removed",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeloadadd",
+ "name" : "insert",
"type" : "function",
- "desc" : "Fires after a new set of Records has been loaded.",
- "sig" : "function (_self, records, options)\n{\n\n}",
+ "desc" : "Fires when a new child node is inserted in a node in this tree.",
+ "sig" : "function (tree, parent, node, refNode)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
},
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "The Records that were loaded",
+ "name" : "parent",
+ "type" : "Node",
+ "desc" : "The parent node",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node inserted",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "clear",
- "type" : "function",
- "desc" : "Fires when the data cache has been cleared.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "refNode",
+ "type" : "Node",
+ "desc" : "The child node the node was inserted before",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "datachanged",
+ "name" : "move",
"type" : "function",
- "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Fires when a node is moved to a new location in the tree",
+ "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The node moved",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldParent",
+ "type" : "Node",
+ "desc" : "The old parent of this node",
+ "isOptional" : false
+ },
+ {
+ "name" : "newParent",
+ "type" : "Node",
+ "desc" : "The new parent of this node",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index it was moved to",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "load",
+ "name" : "remove",
"type" : "function",
- "desc" : "Fires after a new set of Records has been loaded, before they are added to the store.",
- "sig" : "function (_self, records, options)\n{\n\n}",
+ "desc" : "Fires when a child node is removed from a node in this tree.",
+ "sig" : "function (tree, parent, node)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
},
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "The Records that were loaded",
+ "name" : "parent",
+ "type" : "Node",
+ "desc" : "The parent node",
"isOptional" : false
},
{
- "name" : "options",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node removed",
+ "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 loading options that were specified (see {@link #load} for details)",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "loadexception",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args",
- "sig" : "function (, return, load, jsonData)\n{\n\n}",
- "memberOf" : "",
+ "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" : "",
- "type" : "Proxy",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "return",
- "type" : "Object",
- "desc" : "from JsonData.reader() - success, totalRecords, records",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "load",
+ "name" : "scope",
"type" : "Object",
- "desc" : "options",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
},
{
- "name" : "jsonData",
+ "name" : "options",
"type" : "Object",
- "desc" : "from your request (normally this contains the Exception)",
+ "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" : "metachange",
+ "name" : "capture",
"type" : "function",
- "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.",
- "sig" : "function (_self, meta)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "meta",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
"type" : "Object",
- "desc" : "The JSON metadata",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Fires when a Record has been removed from the Store",
- "sig" : "function (_self, record, index)\n{\n\n}",
- "memberOf" : "",
+ "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" : "this",
- "type" : "Store",
+ "name" : "eventName",
+ "type" : "String",
"desc" : "",
"isOptional" : false
},
{
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The Record that was removed",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index at which the record was removed",
+ "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" : "update",
+ "name" : "getNodeById",
"type" : "function",
- "desc" : "Fires when a Record has been updated",
- "sig" : "function (_self, record, operation)\n{\n\n}",
+ "desc" : "Gets a node in this tree by its id.",
+ "sig" : "(id)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The Record that was updated",
- "isOptional" : false
- },
- {
- "name" : "operation",
+ "name" : "id",
"type" : "String",
- "desc" : "The update operation being performed. Value may be one of:\n<pre><code>\n Roo.data.Record.EDIT\n Roo.data.Record.REJECT\n Roo.data.Record.COMMIT\n</code></pre>",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "methods" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Node",
+ "desc" : ""
+ }
+ ]
+ },
{
- "name" : "add",
+ "name" : "getRootNode",
"type" : "function",
- "desc" : "Add Records to the Store and fires the add event.",
- "sig" : "(records)",
+ "desc" : "Returns the root node for this tree.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "An Array of Roo.data.Record objects to add to the cache.",
- "isOptional" : false
+ "name" : "",
+ "type" : "Node",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "addEvents",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "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" : "addListener",
+ "name" : "on",
"type" : "function",
- "desc" : "Appends an event handler to this component",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
"sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
{
"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>",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "purgeListeners",
"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)",
+ "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,
{
"name" : "o",
"type" : "Observable",
- "desc" : "The Observable to capture",
+ "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" : "fn",
+ "name" : "handler",
"type" : "Function",
- "desc" : "The function to call",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "clearFilter",
+ "name" : "setRootNode",
"type" : "function",
- "desc" : "Revert to a view of the Record cache with no filtering applied.",
- "sig" : "(suppressEvent)",
+ "desc" : "Sets the root node for this tree.",
+ "sig" : "(node)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "suppressEvent",
- "type" : "Boolean",
- "desc" : "If true the filter is cleared silently without notifying listeners",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Node",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "collect",
+ "name" : "un",
"type" : "function",
- "desc" : "Collects unique values for a particular dataIndex from this store.",
- "sig" : "(dataIndex, allowNull, bypassFilter)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "dataIndex",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The property to collect",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "allowNull",
- "type" : "Boolean",
- "desc" : "(optional) Pass true to allow null, undefined or empty string values",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "bypassFilter",
- "type" : "Boolean",
- "desc" : "(optional) Pass true to collect from all records, even ones which are filtered",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.tree.ColumnTree",
+ "Roo.tree.TreePanel"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.XmlReader" : {
+ "props" : [
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The DomQuery path relative from the record element to the element that contains\na record identifier value.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "record",
+ "type" : "String",
+ "desc" : "The DomQuery path to the repeated element which contains record information.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "success",
+ "type" : "String",
+ "desc" : "The DomQuery path to the success attribute used by forms.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "totalRecords",
+ "type" : "String",
+ "desc" : "The DomQuery path from which to retrieve the total number of records\nin the dataset. This is only needed if the whole dataset is not passed in one go, but is being\npaged from the remote server.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "newRow",
+ "type" : "function",
+ "desc" : "Create an empty record",
+ "sig" : "(data)",
+ "static" : false,
+ "memberOf" : "Roo.data.DataReader",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "(optional) - overlay some values",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Array",
- "desc" : "An array of the unique values"
+ "type" : "Roo.data.Record",
+ "desc" : "record created."
}
]
},
{
- "name" : "commitChanges",
+ "name" : "read",
"type" : "function",
- "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.",
- "sig" : "()\n{\n\n}",
+ "desc" : "This method is only used by a DataProxy which has retrieved data from a remote server.",
+ "sig" : "(response)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "response",
+ "type" : "Object",
+ "desc" : "The XHR object which contains the parsed XML document. The response is expected\nto contain a method called 'responseXML' that returns an XML document object.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "records A data block which is used by an {@link Roo.data.Store} as\na cache of Roo.data.Records."
+ }
+ ]
},
{
- "name" : "each",
+ "name" : "readRecords",
"type" : "function",
- "desc" : "Calls the specified function for each of the Records in the cache.",
- "sig" : "(fn, scope)",
+ "desc" : "Create a data block containing Roo.data.Records from an XML document.",
+ "sig" : "(doc)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call. The Record is passed as the first parameter.\nReturning <em>false</em> aborts and exits the iteration.",
+ "name" : "doc",
+ "type" : "Object",
+ "desc" : "A parsed XML document.",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
- "name" : "scope",
+ "name" : "",
"type" : "Object",
- "desc" : "(optional) The scope in which to call the function (defaults to the Record).",
+ "desc" : "records A data block which is used by an {@link Roo.data.Store} as\na cache of Roo.data.Records."
+ }
+ ]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.dd" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.dd.DD" : {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "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" : "filter",
+ "name" : "addInvalidHandleClass",
"type" : "function",
- "desc" : "Filter the records by a specified property.",
- "sig" : "(field, value, anyMatch)",
+ "desc" : "Lets you specify a css class of elements that will not initiate a drag",
+ "sig" : "(cssClass)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "field",
- "type" : "String",
- "desc" : "A field on your records",
- "isOptional" : false
- },
- {
- "name" : "value",
- "type" : "String/RegExp",
- "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
- "isOptional" : false
- },
- {
- "name" : "anyMatch",
- "type" : "Boolean",
- "desc" : "True to match any part not just the beginning",
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the elements you wish to ignore",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "filterBy",
+ "name" : "addInvalidHandleId",
"type" : "function",
- "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.",
- "sig" : "(fn, scope)",
+ "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to be called, it will receive 2 args (record, id)",
+ "name" : "id",
+ "type" : "string",
+ "desc" : "the element id of the element you wish to ignore",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "addInvalidHandleType",
+ "type" : "function",
+ "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
+ "sig" : "(tagName)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to this)",
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to exclude",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "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" : "getAt",
+ "name" : "addToGroup",
"type" : "function",
- "desc" : "Get the Record at the specified index.",
- "sig" : "(index)",
+ "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
+ "sig" : "(sGroup)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the Record to find.",
+ "name" : "sGroup",
+ "type" : "",
+ "desc" : "{string} the name of the group",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.data.Record",
- "desc" : "The Record at the passed index. Returns undefined if not found."
- }
- ]
+ "returns" : []
},
{
- "name" : "getById",
+ "name" : "alignElWithMouse",
"type" : "function",
- "desc" : "Get the Record with the specified id.",
- "sig" : "(id)",
+ "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
+ "sig" : "(el, iPageX, iPageY)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the Record to find.",
+ "name" : "el",
+ "type" : "HTMLElement",
+ "desc" : "the element to move",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.data.Record",
- "desc" : "The Record with the passed id. Returns undefined if not found."
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the mousedown or drag event",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the mousedown or drag event",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getCount",
+ "name" : "applyConfig",
"type" : "function",
- "desc" : "Gets the number of cached records.\n<p>\n<em>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size</em>",
+ "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "getModifiedRecords",
+ "name" : "autoOffset",
"type" : "function",
- "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked",
+ "sig" : "(iPageX, iPageY)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.data.Record[]",
- "desc" : "An array of Records containing outstanding modifications."
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the click",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the click",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getRange",
+ "name" : "cachePosition",
"type" : "function",
- "desc" : "Returns a range of Records between specified indices.",
- "sig" : "(startIndex, endIndex)",
+ "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.",
+ "sig" : "(iPageX, iPageY)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "startIndex",
- "type" : "Number",
- "desc" : "(optional) The starting index (defaults to 0)",
+ "name" : "iPageX",
+ "type" : "",
+ "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)",
"isOptional" : false
},
{
- "name" : "endIndex",
- "type" : "Number",
- "desc" : "(optional) The ending index (defaults to the last Record in the Store)",
+ "name" : "iPageY",
+ "type" : "",
+ "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)",
"isOptional" : false
}
],
- "returns" : [
+ "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" : "",
- "type" : "Roo.data.Record[]",
- "desc" : "An array of Records"
+ "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" : "getSortState",
+ "name" : "clearConstraints",
"type" : "function",
- "desc" : "Returns the sort state of the Store as an object with two properties:\n<pre><code>\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n</code></pre>",
+ "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "getTotalCount",
+ "name" : "clearTicks",
"type" : "function",
- "desc" : "Gets the total number of records in the dataset as returned by the server.\n<p>\n<em>If using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size</em>",
+ "desc" : "Clears any tick interval defined for this instance",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "hasListener",
+ "name" : "endDrag",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Fired when we are done dragging the object",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "indexOf",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Get the index within the cache of the passed Record.",
- "sig" : "(record)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The Roo.data.Record object to to find.",
+ "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" : "Number",
- "desc" : "The index of the passed Record. Returns -1 if not found."
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "indexOfId",
+ "name" : "getDragEl",
"type" : "function",
- "desc" : "Get the index within the cache of the Record with the passed id.",
- "sig" : "(id)",
+ "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the Record to find.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "The index of the Record. Returns -1 if not found."
+ "type" : "HTMLElement",
+ "desc" : "the html element"
}
]
},
{
- "name" : "insert",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Inserts Records to the Store at the given index and fires the add event.",
- "sig" : "(index, records)",
+ "desc" : "Returns a reference to the linked element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The start index at which to insert the passed Records.",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "An Array of Roo.data.Record objects to add to the cache.",
- "isOptional" : false
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "the html element"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "load",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n<p>\nIf using remote paging, then the first load call must specify the <em>start</em>\nand <em>limit</em> properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n<p>\n<strong>It is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.</strong>\n<p>",
- "sig" : "(options)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "An object containing properties which control loading options:<ul>\n<li>params {Object} An object containing properties to pass as HTTP parameters to a remote data source.</li>\n<li>params.data {Object} if you are using a MemoryProxy / JsonReader, use this as the data to load stuff..\n<pre>\n {\n data : data, // array of key=>value data like JsonReader\n total : data.length,\n success : true\n \n }\n </pre>\n }.</li>\n<li>callback {Function} A function to be called after the Records have been loaded. The callback is\npassed the following arguments:<ul>\n<li>r : Roo.data.Record[]</li>\n<li>options: Options object from the load call</li>\n<li>success: Boolean success indicator</li></ul></li>\n<li>scope {Object} Scope with which to call the callback (defaults to the Store object)</li>\n<li>add {Boolean} indicator to append loaded records rather than replace the current cache.</li>\n</ul>",
+ "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" : "loadData",
+ "name" : "init",
"type" : "function",
- "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.",
- "sig" : "(data, append)",
+ "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
+ "sig" : "(id, sGroup, config)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "data",
- "type" : "Object",
- "desc" : "The data block from which to read the Records. The format of the data expected\nis dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.",
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the linked element",
"isOptional" : false
},
{
- "name" : "append",
- "type" : "Boolean",
- "desc" : "True to append the new Records rather than replace the existing cache.",
+ "name" : "sGroup",
+ "type" : "String",
+ "desc" : "the group of related items",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "object",
+ "desc" : "configuration attributes",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "loadDataFromChildren",
+ "name" : "initTarget",
"type" : "function",
- "desc" : "using 'cn' the nested child reader read the child array into it's child stores.",
- "sig" : "(rec)",
+ "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
+ "sig" : "(id, sGroup, config)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "rec",
- "type" : "Object",
- "desc" : "The record with a 'children array",
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the linked element",
+ "isOptional" : false
+ },
+ {
+ "name" : "sGroup",
+ "type" : "String",
+ "desc" : "the group of related items",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "object",
+ "desc" : "configuration attributes",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "on",
+ "name" : "isLocked",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"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)",
- "isOptional" : false
+ "name" : "",
+ "type" : "boolean",
+ "desc" : "true if this obj or all drag/drop is locked, else\nfalse"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "purgeListeners",
+ "name" : "isTarget",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "query",
+ "name" : "isValidHandleChild",
"type" : "function",
- "desc" : "Query the records by a specified property.",
- "sig" : "(field, value, anyMatch)",
+ "desc" : "Checks the tag exclusion list to see if this click should be ignored",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "field",
- "type" : "String",
- "desc" : "A field on your records",
- "isOptional" : false
- },
- {
- "name" : "value",
- "type" : "String/RegExp",
- "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
- "isOptional" : false
- },
- {
- "name" : "anyMatch",
- "type" : "Boolean",
- "desc" : "True to match any part not just the beginning",
+ "name" : "node",
+ "type" : "HTMLElement",
+ "desc" : "the HTMLElement to evaluate",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "MixedCollection",
- "desc" : "Returns an Roo.util.MixedCollection of the matched records"
+ "type" : "boolean",
+ "desc" : "true if this is a valid tag type, false if not"
}
]
},
{
- "name" : "queryBy",
+ "name" : "lock",
"type" : "function",
- "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.",
- "sig" : "(fn, scope)",
+ "desc" : "Lock this instance",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
+ "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,
"requires" : "",
"params" : [
{
- "name" : "fn",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
"type" : "Function",
- "desc" : "The function to be called, it will receive 2 args (record, id)",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to this)",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "MixedCollection",
- "desc" : "Returns an Roo.util.MixedCollection of the matched records"
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "rejectChanges",
+ "name" : "onAvailable",
"type" : "function",
- "desc" : "Cancel outstanding changes on all changed records.",
+ "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "onDrag",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "reload",
+ "name" : "onDragDrop",
"type" : "function",
- "desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.",
- "sig" : "(options)",
+ "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing properties which may override the options\nused in the last load operation. See {@link #load} for details (defaults to null, in which case\nthe most recently used options are reused).",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "onDragEnter",
"type" : "function",
- "desc" : "Remove a Record from the Store and fires the remove event.",
- "sig" : "(record)",
+ "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "record",
- "type" : "Ext.data.Record",
- "desc" : "The Roo.data.Record object to remove from the cache.",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeAll",
- "type" : "function",
- "desc" : "Remove all Records from the Store and fires the clear event.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "removeListener",
+ "name" : "onDragOut",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Abstract method called when we are no longer hovering over an element",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"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" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDefaultSort",
+ "name" : "onDragOver",
"type" : "function",
- "desc" : "Sets the default sort column and order to be used by the next load operation.",
- "sig" : "(fieldName, dir)",
+ "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fieldName",
- "type" : "String",
- "desc" : "The name of the field to sort by.",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
},
{
- "name" : "dir",
- "type" : "String",
- "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "sort",
+ "name" : "onInvalidDrop",
"type" : "function",
- "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.",
- "sig" : "(fieldName, dir)",
+ "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fieldName",
- "type" : "String",
- "desc" : "The name of the field to sort by.",
- "isOptional" : false
- },
- {
- "name" : "dir",
- "type" : "String",
- "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "sum",
+ "name" : "onMouseDown",
"type" : "function",
- "desc" : "Sums the value of <i>property</i> for each record between start and end and returns the result.",
- "sig" : "(property, start, end)",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "property",
- "type" : "String",
- "desc" : "A field on your records",
- "isOptional" : false
- },
- {
- "name" : "start",
- "type" : "Number",
- "desc" : "The record index to start at (defaults to 0)",
- "isOptional" : false
- },
- {
- "name" : "end",
- "type" : "Number",
- "desc" : "The last record index to include (defaults to length - 1)",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousedown event",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "The sum"
- }
- ]
+ "returns" : []
},
{
- "name" : "un",
+ "name" : "onMouseUp",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"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" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.data.JsonStore",
- "Roo.data.SimpleStore"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.Tree" : {
- "props" : [
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
+ },
{
- "name" : "append",
+ "name" : "padding",
"type" : "function",
- "desc" : "Fires when a new child node is appended to a node in this tree.",
- "sig" : "function (tree, parent, node, index)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "parent",
- "type" : "Node",
- "desc" : "The parent node",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "The newly appended node",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the newly appended node",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "beforeappend",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Fires before a new child is appended to a node in this tree, return false to cancel the append.",
- "sig" : "function (tree, parent, node)\n{\n\n}",
- "memberOf" : "",
+ "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" : "",
- "params" : [
- {
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "parent",
- "type" : "Node",
- "desc" : "The parent node",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node to be appended",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "beforeinsert",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Fires before a new child is inserted in a node in this tree, return false to cancel the insert.",
- "sig" : "function (tree, parent, node, refNode)\n{\n\n}",
- "memberOf" : "",
+ "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" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "parent",
- "type" : "Node",
- "desc" : "The parent node",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node to be inserted",
- "isOptional" : false
- },
- {
- "name" : "refNode",
- "type" : "Node",
- "desc" : "The child node the node is being inserted before",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforemove",
+ "name" : "removeFromGroup",
"type" : "function",
- "desc" : "Fires before a node is moved to a new location in the tree. Return false to cancel the move.",
- "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Remove's this instance from the supplied interaction group",
+ "sig" : "(sGroup)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "The node being moved",
- "isOptional" : false
- },
- {
- "name" : "oldParent",
- "type" : "Node",
- "desc" : "The parent of the node",
- "isOptional" : false
- },
- {
- "name" : "newParent",
- "type" : "Node",
- "desc" : "The new parent the node is moving to",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index it is being moved to",
+ "name" : "sGroup",
+ "type" : "string",
+ "desc" : "The group to drop",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeremove",
+ "name" : "removeInvalidHandleClass",
"type" : "function",
- "desc" : "Fires before a child is removed from a node in this tree, return false to cancel the remove.",
- "sig" : "function (tree, parent, node)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Unsets an invalid css class",
+ "sig" : "(cssClass)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "parent",
- "type" : "Node",
- "desc" : "The parent node",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node to be removed",
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the element(s) you wish to\nre-enable",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "insert",
+ "name" : "removeInvalidHandleId",
"type" : "function",
- "desc" : "Fires when a new child node is inserted in a node in this tree.",
- "sig" : "function (tree, parent, node, refNode)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Unsets an invalid handle id",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "parent",
- "type" : "Node",
- "desc" : "The parent node",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node inserted",
- "isOptional" : false
- },
- {
- "name" : "refNode",
- "type" : "Node",
- "desc" : "The child node the node was inserted before",
+ "name" : "id",
+ "type" : "string",
+ "desc" : "the id of the element to re-enable",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "move",
+ "name" : "removeInvalidHandleType",
"type" : "function",
- "desc" : "Fires when a node is moved to a new location in the tree",
- "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
+ "sig" : "(tagName)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "The node moved",
- "isOptional" : false
- },
- {
- "name" : "oldParent",
- "type" : "Node",
- "desc" : "The old parent of this node",
- "isOptional" : false
- },
- {
- "name" : "newParent",
- "type" : "Node",
- "desc" : "The new parent of this node",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index it was moved to",
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to unexclude",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Fires when a child node is removed from a node in this tree.",
- "sig" : "function (tree, parent, node)\n{\n\n}",
- "memberOf" : "",
+ "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" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "parent",
- "type" : "Node",
- "desc" : "The parent node",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node removed",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "addEvents",
+ "name" : "resetConstraints",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "resetConstraints must be called if you manually reposition a dd element.",
+ "sig" : "(maintainOffset)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "maintainOffset",
+ "type" : "boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "setDelta",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)",
+ "sig" : "(iDeltaX, iDeltaY)",
"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 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" : "iDeltaX",
+ "type" : "int",
+ "desc" : "the distance from the left",
"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" : "iDeltaY",
+ "type" : "int",
+ "desc" : "the distance from the top",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "setDragElId",
"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" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"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",
+ "name" : "id",
+ "type" : "",
+ "desc" : "{string} the id of the element that will be used to initiate the drag",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "setDragElPos",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
+ "sig" : "(iPageX, iPageY)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the mousedown or drag event",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the mousedown or drag event",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
},
{
- "name" : "getNodeById",
+ "name" : "setHandleElId",
"type" : "function",
- "desc" : "Gets a node in this tree by its id.",
+ "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
"sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [
{
"name" : "id",
- "type" : "String",
- "desc" : "",
+ "type" : "",
+ "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Node",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getRootNode",
+ "name" : "setInitPosition",
"type" : "function",
- "desc" : "Returns the root node for this tree.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Stores the initial placement of the linked element.",
+ "sig" : "(diffX, diffY)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Node",
- "desc" : ""
+ "name" : "diffX",
+ "type" : "int",
+ "desc" : "the X offset, default 0",
+ "isOptional" : false
+ },
+ {
+ "name" : "diffY",
+ "type" : "int",
+ "desc" : "the Y offset, default 0",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "setOuterHandleElId",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the element that will be used to initiate the drag",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "on",
+ "name" : "setPadding",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
+ "sig" : "(iTop, iRight, iBot, iLeft)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "iTop",
+ "type" : "int",
+ "desc" : "Top pad",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "Right pad",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "iBot",
+ "type" : "int",
+ "desc" : "Bot pad",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "Left pad",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "setXConstraint",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
+ "sig" : "(iLeft, iRight, iTickSize)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the left",
+ "isOptional" : false
+ },
+ {
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the\nright",
+ "isOptional" : false
+ },
+ {
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "setYConstraint",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
+ "sig" : "(iUp, iDown, iTickSize)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "iUp",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move up",
+ "isOptional" : false
+ },
+ {
+ "name" : "iDown",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move down",
+ "isOptional" : false
+ },
+ {
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "startDrag",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
+ "sig" : "(X, Y)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"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" : "X",
+ "type" : "int",
+ "desc" : "click location",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "Y",
+ "type" : "int",
+ "desc" : "click location",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setRootNode",
+ "name" : "toString",
"type" : "function",
- "desc" : "Sets the root node for this tree.",
- "sig" : "(node)",
+ "desc" : "toString method",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Node",
- "desc" : ""
+ "type" : "string",
+ "desc" : "string representation of the dd obj"
}
]
},
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.tree.ColumnTree",
- "Roo.tree.TreePanel"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.XmlReader" : {
- "props" : [
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The DomQuery path relative from the record element to the element that contains\na record identifier value.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "record",
- "type" : "String",
- "desc" : "The DomQuery path to the repeated element which contains record information.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "success",
- "type" : "String",
- "desc" : "The DomQuery path to the success attribute used by forms.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "totalRecords",
- "type" : "String",
- "desc" : "The DomQuery path from which to retrieve the total number of records\nin the dataset. This is only needed if the whole dataset is not passed in one go, but is being\npaged from the remote server.",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
- {
- "name" : "newRow",
- "type" : "function",
- "desc" : "Create an empty record",
- "sig" : "(data)",
- "static" : false,
- "memberOf" : "Roo.data.DataReader",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "(optional) - overlay some values",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.data.Record",
- "desc" : "record created."
- }
- ]
},
{
- "name" : "read",
+ "name" : "unlock",
"type" : "function",
- "desc" : "This method is only used by a DataProxy which has retrieved data from a remote server.",
- "sig" : "(response)",
+ "desc" : "Unlock this instace",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "response",
- "type" : "Object",
- "desc" : "The XHR object which contains the parsed XML document. The response is expected\nto contain a method called 'responseXML' that returns an XML document object.",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "records A data block which is used by an {@link Roo.data.Store} as\na cache of Roo.data.Records."
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "readRecords",
+ "name" : "unreg",
"type" : "function",
- "desc" : "Create a data block containing Roo.data.Records from an XML document.",
- "sig" : "(doc)",
+ "desc" : "Remove all drag and drop hooks for this element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "doc",
- "type" : "Object",
- "desc" : "A parsed XML document.",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "records A data block which is used by an {@link Roo.data.Store} as\na cache of Roo.data.Records."
- }
- ]
+ "params" : [],
+ "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.dd" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
+ "implementations" : [
+ "Roo.dd.DDProxy",
+ "Roo.dd.DragSource",
+ "Roo.dd.DragZone",
+ "Roo.grid.SplitDragZone"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.dd.DD" : {
+ "Roo.dd.DDProxy" : {
"props" : [
{
"name" : "listeners",
"desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
"sig" : "(el, iPageX, iPageY)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked",
"sig" : "(iPageX, iPageY)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.",
"sig" : "(iPageX, iPageY)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
+ {
+ "name" : "createFrame",
+ "type" : "function",
+ "desc" : "Creates the proxy element if it does not yet exist",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "endDrag",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "initFrame",
+ "type" : "function",
+ "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "initTarget",
"type" : "function",
"desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)",
"sig" : "(iDeltaX, iDeltaY)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
"sig" : "(iPageX, iPageY)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [
- "Roo.dd.DDProxy",
"Roo.dd.DragSource",
"Roo.dd.DragZone",
"Roo.grid.SplitDragZone"
"tree_children" : [],
"tree_parent" : []
},
- "Roo.dd.DDProxy" : {
+ "Roo.dd.DDTarget" : {
"props" : [
{
"name" : "listeners",
],
"returns" : []
},
- {
- "name" : "alignElWithMouse",
- "type" : "function",
- "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
- "sig" : "(el, iPageX, iPageY)",
- "static" : false,
- "memberOf" : "Roo.dd.DD",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "HTMLElement",
- "desc" : "the element to move",
- "isOptional" : false
- },
- {
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the mousedown or drag event",
- "isOptional" : false
- },
- {
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the mousedown or drag event",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "applyConfig",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "autoOffset",
- "type" : "function",
- "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked",
- "sig" : "(iPageX, iPageY)",
- "static" : false,
- "memberOf" : "Roo.dd.DD",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the click",
- "isOptional" : false
- },
- {
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the click",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "cachePosition",
- "type" : "function",
- "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.",
- "sig" : "(iPageX, iPageY)",
- "static" : false,
- "memberOf" : "Roo.dd.DD",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "iPageX",
- "type" : "",
- "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)",
- "isOptional" : false
- },
- {
- "name" : "iPageY",
- "type" : "",
- "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "createFrame",
- "type" : "function",
- "desc" : "Creates the proxy element if it does not yet exist",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "endDrag",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "initFrame",
- "type" : "function",
- "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "initTarget",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setDelta",
- "type" : "function",
- "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)",
- "sig" : "(iDeltaX, iDeltaY)",
- "static" : false,
- "memberOf" : "Roo.dd.DD",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "iDeltaX",
- "type" : "int",
- "desc" : "the distance from the left",
- "isOptional" : false
- },
- {
- "name" : "iDeltaY",
- "type" : "int",
- "desc" : "the distance from the top",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setDragElId",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setDragElPos",
- "type" : "function",
- "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
- "sig" : "(iPageX, iPageY)",
- "static" : false,
- "memberOf" : "Roo.dd.DD",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the mousedown or drag event",
- "isOptional" : false
- },
- {
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the mousedown or drag event",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setHandleElId",
"type" : "function",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [
- "Roo.dd.DragSource",
- "Roo.dd.DragZone",
- "Roo.grid.SplitDragZone"
+ "Roo.dd.DropTarget",
+ "Roo.dd.DropZone"
],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.dd.DDTarget" : {
+ "Roo.dd.DragDrop" : {
"props" : [
{
"name" : "listeners",
"desc" : "Lets you specify a css class of elements that will not initiate a drag",
"sig" : "(cssClass)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
"sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
"sig" : "(tagName)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
"sig" : "(sGroup)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Clears any tick interval defined for this instance",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Fired when we are done dragging the object",
"sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns a reference to the linked element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
"sig" : "(id, sGroup, config)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
"sig" : "(id, sGroup, config)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Checks the tag exclusion list to see if this click should be ignored",
"sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Lock this instance",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
"sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
"sig" : "(e, id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
"sig" : "(e, id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called when we are no longer hovering over an element",
"sig" : "(e, id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
"sig" : "(e, id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
"sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
"sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
"sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Remove's this instance from the supplied interaction group",
"sig" : "(sGroup)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Unsets an invalid css class",
"sig" : "(cssClass)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Unsets an invalid handle id",
"sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Unsets an excluded tag name set by addInvalidHandleType",
"sig" : "(tagName)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "resetConstraints must be called if you manually reposition a dd element.",
"sig" : "(maintainOffset)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
"sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
"sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Stores the initial placement of the linked element.",
"sig" : "(diffX, diffY)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
"sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
"sig" : "(iTop, iRight, iBot, iLeft)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
"sig" : "(iLeft, iRight, iTickSize)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
"sig" : "(iUp, iDown, iTickSize)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
"sig" : "(X, Y)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "toString method",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Unlock this instace",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Remove all drag and drop hooks for this element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [
+ "Roo.dd.DD",
+ "Roo.dd.DDProxy",
+ "Roo.dd.DDTarget",
+ "Roo.dd.DragSource",
+ "Roo.dd.DragZone",
"Roo.dd.DropTarget",
- "Roo.dd.DropZone"
+ "Roo.dd.DropZone",
+ "Roo.grid.SplitDragZone"
],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.dd.DragDrop" : {
+ "Roo.dd.DragSource" : {
"props" : [
+ {
+ "name" : "dropAllowed",
+ "type" : "String",
+ "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dropNotAllowed",
+ "type" : "String",
+ "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"desc" : "Lets you specify a css class of elements that will not initiate a drag",
"sig" : "(cssClass)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
"sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
"sig" : "(tagName)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
"sig" : "(sGroup)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
},
+ {
+ "name" : "afterDragDrop",
+ "type" : "function",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter a valid drag drop has occurred by providing an implementation.",
+ "sig" : "(target, e, id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dropped element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "afterDragEnter",
+ "type" : "function",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhen the dragged item enters the drop target by providing an implementation.",
+ "sig" : "(target, e, id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "afterDragOut",
+ "type" : "function",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter the dragged item is dragged out of the target without dropping.",
+ "sig" : "(target, e, id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "afterDragOver",
+ "type" : "function",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhile the dragged item is over the drop target by providing an implementation.",
+ "sig" : "(target, e, id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "afterInvalidDrop",
+ "type" : "function",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter an invalid drop has occurred by providing an implementation.",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dropped element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "afterValidDrop",
+ "type" : "function",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter a valid drop has occurred by providing an implementation.",
+ "sig" : "(target, e, id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "Object",
+ "desc" : "The target DD",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dropped element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "alignElWithMouse",
+ "type" : "function",
+ "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
+ "sig" : "(el, iPageX, iPageY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DD",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "HTMLElement",
+ "desc" : "the element to move",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the mousedown or drag event",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the mousedown or drag event",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "applyConfig",
"type" : "function",
"desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
+ {
+ "name" : "autoOffset",
+ "type" : "function",
+ "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked",
+ "sig" : "(iPageX, iPageY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DD",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the click",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the click",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeDragDrop",
+ "type" : "function",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dropped onto the target and optionally cancel the onDragDrop.",
+ "sig" : "(target, e, id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "isValid True if the drag drop event is valid, else false to cancel"
+ }
+ ]
+ },
+ {
+ "name" : "beforeDragEnter",
+ "type" : "function",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nbefore the dragged item enters the drop target and optionally cancel the onDragEnter.",
+ "sig" : "(target, e, id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "isValid True if the drag event is valid, else false to cancel"
+ }
+ ]
+ },
+ {
+ "name" : "beforeDragOut",
+ "type" : "function",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dragged out of the target without dropping, and optionally cancel the onDragOut.",
+ "sig" : "(target, e, id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "isValid True if the drag event is valid, else false to cancel"
+ }
+ ]
+ },
+ {
+ "name" : "beforeDragOver",
+ "type" : "function",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhile the dragged item is over the drop target and optionally cancel the onDragOver.",
+ "sig" : "(target, e, id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "isValid True if the drag event is valid, else false to cancel"
+ }
+ ]
+ },
+ {
+ "name" : "beforeInvalidDrop",
+ "type" : "function",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action after an invalid\ndrop has occurred.",
+ "sig" : "(target, e, id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "isValid True if the invalid drop should proceed, else false to cancel"
+ }
+ ]
+ },
+ {
+ "name" : "cachePosition",
+ "type" : "function",
+ "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.",
+ "sig" : "(iPageX, iPageY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DD",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "iPageX",
+ "type" : "",
+ "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageY",
+ "type" : "",
+ "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
"desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Clears any tick interval defined for this instance",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "createFrame",
+ "type" : "function",
+ "desc" : "Creates the proxy element if it does not yet exist",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DDProxy",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Fired when we are done dragging the object",
"sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
+ {
+ "name" : "getDragData",
+ "type" : "function",
+ "desc" : "Returns the data object associated with this drag source",
+ "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" : "data An object containing arbitrary data"
+ }
+ ]
+ },
{
"name" : "getDragEl",
"type" : "function",
"desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns a reference to the linked element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
+ {
+ "name" : "getProxy",
+ "type" : "function",
+ "desc" : "Returns the drag source's underlying {@link Roo.dd.StatusProxy}",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.dd.StatusProxy",
+ "desc" : "proxy The StatusProxy"
+ }
+ ]
+ },
{
"name" : "hasListener",
"type" : "function",
}
]
},
+ {
+ "name" : "hideProxy",
+ "type" : "function",
+ "desc" : "Hides the drag source's {@link Roo.dd.StatusProxy}",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "init",
"type" : "function",
"desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
"sig" : "(id, sGroup, config)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
},
+ {
+ "name" : "initFrame",
+ "type" : "function",
+ "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DDProxy",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "initTarget",
"type" : "function",
"desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
"sig" : "(id, sGroup, config)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Checks the tag exclusion list to see if this click should be ignored",
"sig" : "(node)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Lock this instance",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
+ {
+ "name" : "onBeforeDrag",
+ "type" : "function",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action before the initial\ndrag event begins and optionally cancel it.",
+ "sig" : "(data, e)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data to be shared with drop targets",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "isValid True if the drag event is valid, else false to cancel"
+ }
+ ]
+ },
{
"name" : "onDrag",
"type" : "function",
"desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
"sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
"sig" : "(e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
"sig" : "(e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called when we are no longer hovering over an element",
"sig" : "(e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
"sig" : "(e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
"sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
"sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
"sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
},
+ {
+ "name" : "onStartDrag",
+ "type" : "function",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action once the initial\ndrag event has begun. The drag cannot be canceled from this function.",
+ "sig" : "(x, y)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The x position of the click on the dragged object",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The y position of the click on the dragged object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "padding",
"type" : "function",
"desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Remove's this instance from the supplied interaction group",
"sig" : "(sGroup)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Unsets an invalid css class",
"sig" : "(cssClass)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Unsets an invalid handle id",
"sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Unsets an excluded tag name set by addInvalidHandleType",
"sig" : "(tagName)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "resetConstraints must be called if you manually reposition a dd element.",
"sig" : "(maintainOffset)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
},
+ {
+ "name" : "setDelta",
+ "type" : "function",
+ "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)",
+ "sig" : "(iDeltaX, iDeltaY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DD",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "iDeltaX",
+ "type" : "int",
+ "desc" : "the distance from the left",
+ "isOptional" : false
+ },
+ {
+ "name" : "iDeltaY",
+ "type" : "int",
+ "desc" : "the distance from the top",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setDragElId",
"type" : "function",
"desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
"sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
},
+ {
+ "name" : "setDragElPos",
+ "type" : "function",
+ "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
+ "sig" : "(iPageX, iPageY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DD",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the mousedown or drag event",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the mousedown or drag event",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setHandleElId",
"type" : "function",
"desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
"sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Stores the initial placement of the linked element.",
"sig" : "(diffX, diffY)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
"sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
"sig" : "(iTop, iRight, iBot, iLeft)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
"sig" : "(iLeft, iRight, iTickSize)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
"sig" : "(iUp, iDown, iTickSize)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
"sig" : "(X, Y)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "toString method",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Unlock this instace",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Remove all drag and drop hooks for this element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [
- "Roo.dd.DD",
- "Roo.dd.DDProxy",
- "Roo.dd.DDTarget",
- "Roo.dd.DragSource",
- "Roo.dd.DragZone",
- "Roo.dd.DropTarget",
- "Roo.dd.DropZone",
- "Roo.grid.SplitDragZone"
+ "Roo.dd.DragZone"
],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.dd.DragSource" : {
+ "Roo.dd.DragZone" : {
"props" : [
+ {
+ "name" : "containerScroll",
+ "type" : "Boolean",
+ "desc" : "True to register this container with the Scrollmanager\nfor auto scrolling during drag operations.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "dropAllowed",
"type" : "String",
"desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isOptional" : false,
"optvals" : []
},
"name" : "dropNotAllowed",
"type" : "String",
"desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
+ "memberOf" : "Roo.dd.DragSource",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hlColor",
+ "type" : "String",
+ "desc" : "The color to use when visually highlighting the drag source in the afterRepair\nmethod after a failed drop (defaults to \"c3daf9\" - light blue)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"desc" : "An empty function by default, but provided so that you can perform a custom action\nafter a valid drag drop has occurred by providing an implementation.",
"sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "An empty function by default, but provided so that you can perform a custom action\nwhen the dragged item enters the drop target by providing an implementation.",
"sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "An empty function by default, but provided so that you can perform a custom action\nafter the dragged item is dragged out of the target without dropping.",
"sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "An empty function by default, but provided so that you can perform a custom action\nwhile the dragged item is over the drop target by providing an implementation.",
"sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "An empty function by default, but provided so that you can perform a custom action\nafter an invalid drop has occurred by providing an implementation.",
"sig" : "(e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
},
+ {
+ "name" : "afterRepair",
+ "type" : "function",
+ "desc" : "Called after a repair of an invalid drop. By default, highlights this.dragData.ddel",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "afterValidDrop",
"type" : "function",
"desc" : "An empty function by default, but provided so that you can perform a custom action\nafter a valid drop has occurred by providing an implementation.",
"sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dropped onto the target and optionally cancel the onDragDrop.",
"sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "An empty function by default, but provided so that you can perform a custom action\nbefore the dragged item enters the drop target and optionally cancel the onDragEnter.",
"sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dragged out of the target without dropping, and optionally cancel the onDragOut.",
"sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "An empty function by default, but provided so that you can perform a custom action\nwhile the dragged item is over the drop target and optionally cancel the onDragOver.",
"sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "An empty function by default, but provided so that you can perform a custom action after an invalid\ndrop has occurred.",
"sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "getDragData",
"type" : "function",
- "desc" : "Returns the data object associated with this drag source",
- "sig" : "()\n{\n\n}",
+ "desc" : "Called when a mousedown occurs in this container. Looks in {@link Roo.dd.Registry}\nfor a valid target to drag based on the mouse down. Override this method\nto provide your own lookup logic (e.g. finding a child by class name). Make sure your returned\nobject has a \"ddel\" attribute (with an HTML Element) for other functions to work.",
+ "sig" : "(e)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "The mouse down event",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
"type" : "Object",
- "desc" : "data An object containing arbitrary data"
+ "desc" : "The dragData"
}
]
},
"desc" : "Returns the drag source's underlying {@link Roo.dd.StatusProxy}",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
+ {
+ "name" : "getRepairXY",
+ "type" : "function",
+ "desc" : "Called before a repair of an invalid drop to get the XY to animate to. By default returns\nthe XY of this.dragData.ddel",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "The mouse up event",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "The xy location (e.g. [100, 200])"
+ }
+ ]
+ },
{
"name" : "hasListener",
"type" : "function",
"desc" : "Hides the drag source's {@link Roo.dd.StatusProxy}",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "An empty function by default, but provided so that you can perform a custom action before the initial\ndrag event begins and optionally cancel it.",
"sig" : "(data, e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
},
+ {
+ "name" : "onInitDrag",
+ "type" : "function",
+ "desc" : "Called once drag threshold has been reached to initialize the proxy element. By default, it clones the\nthis.dragData.ddel",
+ "sig" : "(x, y)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The x position of the click on the dragged object",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The y position of the click on the dragged object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "true to continue the drag, false to cancel"
+ }
+ ]
+ },
{
"name" : "onInvalidDrop",
"type" : "function",
"desc" : "An empty function by default, but provided so that you can perform a custom action once the initial\ndrag event has begun. The drag cannot be canceled from this function.",
"sig" : "(x, y)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.dd.DragZone"
- ],
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.dd.DragZone" : {
+ "Roo.dd.DropTarget" : {
"props" : [
{
- "name" : "containerScroll",
- "type" : "Boolean",
- "desc" : "True to register this container with the Scrollmanager\nfor auto scrolling during drag operations.",
+ "name" : "ddGroup",
+ "type" : "String",
+ "desc" : "The drag drop group to handle drop events for",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"name" : "dropAllowed",
"type" : "String",
"desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
- "memberOf" : "Roo.dd.DragSource",
+ "memberOf" : "",
"isOptional" : false,
"optvals" : []
},
"name" : "dropNotAllowed",
"type" : "String",
"desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
- "memberOf" : "Roo.dd.DragSource",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "hlColor",
- "type" : "String",
- "desc" : "The color to use when visually highlighting the drag source in the afterRepair\nmethod after a failed drop (defaults to \"c3daf9\" - light blue)",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
"memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
- }
- ],
- "events" : [],
- "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" : "addInvalidHandleClass",
- "type" : "function",
- "desc" : "Lets you specify a css class of elements that will not initiate a drag",
- "sig" : "(cssClass)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the elements you wish to ignore",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "addInvalidHandleId",
- "type" : "function",
- "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "string",
- "desc" : "the element id of the element you wish to ignore",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "addInvalidHandleType",
- "type" : "function",
- "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
- "sig" : "(tagName)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to exclude",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "overClass",
+ "type" : "String",
+ "desc" : "The CSS class applied to the drop target element while the drag source is over it (defaults to \"\").",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "success",
+ "type" : "boolean",
+ "desc" : "set this after drop listener..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "addToGroup",
- "type" : "function",
- "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
- "sig" : "(sGroup)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "sGroup",
- "type" : "",
- "desc" : "{string} the name of the group",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
+ "name" : "valid",
+ "type" : "boolean|String",
+ "desc" : "true/false or string (ok-add/ok-sub/ok/nodrop)\nif the drop point is valid for over/enter..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
{
- "name" : "afterDragDrop",
+ "name" : "drop",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter a valid drag drop has occurred by providing an implementation.",
- "sig" : "(target, e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the dragged item has\nbeen dropped on it. This method has no default implementation and returns false, so you must provide an\nimplementation that does something to process the drop event and returns true so that the drag source's\nrepair action does not run.\n\nIMPORTANT : it should set this.success",
+ "sig" : "function (source, e, data)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop target",
"isOptional" : false
},
{
"name" : "e",
"type" : "Event",
- "desc" : "The event object",
+ "desc" : "The event",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dropped element",
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "afterDragEnter",
+ "name" : "enter",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhen the dragged item enters the drop target by providing an implementation.",
- "sig" : "(target, e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the\ntarget. This default implementation adds the CSS class specified by overClass (if any) to the drop element\nand returns the dropAllowed config value. This method should be overridden if drop validation is required.\n\nIMPORTANT : it should set this.valid to true|false",
+ "sig" : "function (source, e, data)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop target",
"isOptional" : false
},
{
"name" : "e",
"type" : "Event",
- "desc" : "The event object",
+ "desc" : "The event",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dragged element",
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "afterDragOut",
+ "name" : "out",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter the dragged item is dragged out of the target without dropping.",
- "sig" : "(target, e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged\nout of the target without dropping. This default implementation simply removes the CSS class specified by\noverClass (if any) from the drop element.",
+ "sig" : "function (source, e, data)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop target",
"isOptional" : false
},
{
"name" : "e",
"type" : "Event",
- "desc" : "The event object",
+ "desc" : "The event",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dragged element",
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "afterDragOver",
+ "name" : "over",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhile the dragged item is over the drop target by providing an implementation.",
- "sig" : "(target, e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.\nThis method will be called on every mouse movement while the drag source is over the drop target.\nThis default implementation simply returns the dropAllowed config value.\n\nIMPORTANT : it should set this.valid to true|false",
+ "sig" : "function (source, e, data)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop target",
"isOptional" : false
},
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dragged element",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "afterInvalidDrop",
- "type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter an invalid drop has occurred by providing an implementation.",
- "sig" : "(e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
{
"name" : "e",
"type" : "Event",
- "desc" : "The event object",
+ "desc" : "The event",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dropped element",
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
"isOptional" : false
}
],
"returns" : []
- },
- {
- "name" : "afterRepair",
- "type" : "function",
- "desc" : "Called after a repair of an invalid drop. By default, highlights this.dragData.ddel",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "afterValidDrop",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter a valid drop has occurred by providing an implementation.",
- "sig" : "(target, e, id)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.dd.DragSource",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "target",
+ "name" : "object",
"type" : "Object",
- "desc" : "The target DD",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dropped element",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "alignElWithMouse",
+ "name" : "addInvalidHandleClass",
"type" : "function",
- "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
- "sig" : "(el, iPageX, iPageY)",
+ "desc" : "Lets you specify a css class of elements that will not initiate a drag",
+ "sig" : "(cssClass)",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "HTMLElement",
- "desc" : "the element to move",
- "isOptional" : false
- },
- {
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the mousedown or drag event",
- "isOptional" : false
- },
- {
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the mousedown or drag event",
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the elements you wish to ignore",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "applyConfig",
+ "name" : "addInvalidHandleId",
"type" : "function",
- "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
+ "sig" : "(id)",
"static" : false,
"memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "autoOffset",
- "type" : "function",
- "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked",
- "sig" : "(iPageX, iPageY)",
- "static" : false,
- "memberOf" : "Roo.dd.DD",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the click",
- "isOptional" : false
- },
- {
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the click",
+ "name" : "id",
+ "type" : "string",
+ "desc" : "the element id of the element you wish to ignore",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeDragDrop",
+ "name" : "addInvalidHandleType",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dropped onto the target and optionally cancel the onDragDrop.",
- "sig" : "(target, e, id)",
+ "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
+ "sig" : "(tagName)",
"static" : false,
- "memberOf" : "Roo.dd.DragSource",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dragged element",
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to exclude",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "isValid True if the drag drop event is valid, else false to cancel"
- }
- ]
+ "returns" : []
},
{
- "name" : "beforeDragEnter",
+ "name" : "addListener",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action\nbefore the dragged item enters the drop target and optionally cancel the onDragEnter.",
- "sig" : "(target, e, id)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.dd.DragSource",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
- "isOptional" : false
- },
- {
- "name" : "id",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The id of the dragged element",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "isValid True if the drag event is valid, else false to cancel"
- }
- ]
- },
- {
- "name" : "beforeDragOut",
- "type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dragged out of the target without dropping, and optionally cancel the onDragOut.",
- "sig" : "(target, e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dragged element",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "isValid True if the drag event is valid, else false to cancel"
- }
- ]
- },
- {
- "name" : "beforeDragOver",
- "type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhile the dragged item is over the drop target and optionally cancel the onDragOver.",
- "sig" : "(target, e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dragged element",
+ "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" : "",
- "type" : "Boolean",
- "desc" : "isValid True if the drag event is valid, else false to cancel"
- }
- ]
+ "returns" : []
},
{
- "name" : "beforeInvalidDrop",
+ "name" : "addToGroup",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action after an invalid\ndrop has occurred.",
- "sig" : "(target, e, id)",
+ "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
+ "sig" : "(sGroup)",
"static" : false,
- "memberOf" : "Roo.dd.DragSource",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dragged element",
+ "name" : "sGroup",
+ "type" : "",
+ "desc" : "{string} the name of the group",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "isValid True if the invalid drop should proceed, else false to cancel"
- }
- ]
+ "returns" : []
},
{
- "name" : "cachePosition",
+ "name" : "applyConfig",
"type" : "function",
- "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.",
- "sig" : "(iPageX, iPageY)",
+ "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "iPageX",
- "type" : "",
- "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)",
- "isOptional" : false
- },
- {
- "name" : "iPageY",
- "type" : "",
- "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
"params" : [],
"returns" : []
},
- {
- "name" : "createFrame",
- "type" : "function",
- "desc" : "Creates the proxy element if it does not yet exist",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DDProxy",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "endDrag",
"type" : "function",
}
]
},
- {
- "name" : "getDragData",
- "type" : "function",
- "desc" : "Called when a mousedown occurs in this container. Looks in {@link Roo.dd.Registry}\nfor a valid target to drag based on the mouse down. Override this method\nto provide your own lookup logic (e.g. finding a child by class name). Make sure your returned\nobject has a \"ddel\" attribute (with an HTML Element) for other functions to work.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "EventObject",
- "desc" : "The mouse down event",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "The dragData"
- }
- ]
- },
{
"name" : "getDragEl",
"type" : "function",
}
]
},
- {
- "name" : "getProxy",
- "type" : "function",
- "desc" : "Returns the drag source's underlying {@link Roo.dd.StatusProxy}",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.dd.StatusProxy",
- "desc" : "proxy The StatusProxy"
- }
- ]
- },
- {
- "name" : "getRepairXY",
- "type" : "function",
- "desc" : "Called before a repair of an invalid drop to get the XY to animate to. By default returns\nthe XY of this.dragData.ddel",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "EventObject",
- "desc" : "The mouse up event",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Array",
- "desc" : "The xy location (e.g. [100, 200])"
- }
- ]
- },
{
"name" : "hasListener",
"type" : "function",
}
]
},
- {
- "name" : "hideProxy",
- "type" : "function",
- "desc" : "Hides the drag source's {@link Roo.dd.StatusProxy}",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "init",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "initFrame",
- "type" : "function",
- "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DDProxy",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "initTarget",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "notifyDrop",
+ "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" : "notifyEnter",
+ "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" : "notifyOut",
+ "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" : "notifyOver",
+ "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" : "on",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "onBeforeDrag",
- "type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action before the initial\ndrag event begins and optionally cancel it.",
- "sig" : "(data, e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data to be shared with drop targets",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "isValid True if the drag event is valid, else false to cancel"
- }
- ]
- },
{
"name" : "onDrag",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "onInitDrag",
- "type" : "function",
- "desc" : "Called once drag threshold has been reached to initialize the proxy element. By default, it clones the\nthis.dragData.ddel",
- "sig" : "(x, y)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The x position of the click on the dragged object",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The y position of the click on the dragged object",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "true to continue the drag, false to cancel"
- }
- ]
- },
{
"name" : "onInvalidDrop",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "onStartDrag",
- "type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action once the initial\ndrag event has begun. The drag cannot be canceled from this function.",
- "sig" : "(x, y)",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The x position of the click on the dragged object",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The y position of the click on the dragged object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "padding",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setDelta",
- "type" : "function",
- "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)",
- "sig" : "(iDeltaX, iDeltaY)",
- "static" : false,
- "memberOf" : "Roo.dd.DD",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "iDeltaX",
- "type" : "int",
- "desc" : "the distance from the left",
- "isOptional" : false
- },
- {
- "name" : "iDeltaY",
- "type" : "int",
- "desc" : "the distance from the top",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setDragElId",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setDragElPos",
- "type" : "function",
- "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
- "sig" : "(iPageX, iPageY)",
- "static" : false,
- "memberOf" : "Roo.dd.DD",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the mousedown or drag event",
- "isOptional" : false
- },
- {
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the mousedown or drag event",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setHandleElId",
"type" : "function",
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
+ "implementations" : [
+ "Roo.dd.DropZone"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.dd.DropTarget" : {
+ "Roo.dd.DropZone" : {
"props" : [
{
"name" : "ddGroup",
"type" : "String",
"desc" : "The drag drop group to handle drop events for",
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DropTarget",
"isOptional" : false,
"optvals" : []
},
"name" : "dropAllowed",
"type" : "String",
"desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DropTarget",
"isOptional" : false,
"optvals" : []
},
"name" : "dropNotAllowed",
"type" : "String",
"desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DropTarget",
"isOptional" : false,
"optvals" : []
},
"name" : "overClass",
"type" : "String",
"desc" : "The CSS class applied to the drop target element while the drag source is over it (defaults to \"\").",
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DropTarget",
"isOptional" : false,
"optvals" : []
},
"name" : "success",
"type" : "boolean",
"desc" : "set this after drop listener..",
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DropTarget",
"isOptional" : false,
"optvals" : []
},
"name" : "valid",
"type" : "boolean|String",
"desc" : "true/false or string (ok-add/ok-sub/ok/nodrop)\nif the drop point is valid for over/enter..",
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DropTarget",
"isOptional" : false,
"optvals" : []
}
"type" : "function",
"desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the dragged item has\nbeen dropped on it. This method has no default implementation and returns false, so you must provide an\nimplementation that does something to process the drop event and returns true so that the drag source's\nrepair action does not run.\n\nIMPORTANT : it should set this.success",
"sig" : "function (source, e, data)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DropTarget",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the\ntarget. This default implementation adds the CSS class specified by overClass (if any) to the drop element\nand returns the dropAllowed config value. This method should be overridden if drop validation is required.\n\nIMPORTANT : it should set this.valid to true|false",
"sig" : "function (source, e, data)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DropTarget",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged\nout of the target without dropping. This default implementation simply removes the CSS class specified by\noverClass (if any) from the drop element.",
"sig" : "function (source, e, data)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DropTarget",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.\nThis method will be called on every mouse movement while the drag source is over the drop target.\nThis default implementation simply returns the dropAllowed config value.\n\nIMPORTANT : it should set this.valid to true|false",
"sig" : "function (source, e, data)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DropTarget",
"example" : "",
"deprecated" : "",
"since" : "",
}
]
},
+ {
+ "name" : "getTargetFromEvent",
+ "type" : "function",
+ "desc" : "Returns a custom data object associated with the DOM node that is the target of the event. By default\nthis looks up the event target in the {@link Roo.dd.Registry}, although you can override this method to\nprovide your own custom lookup.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "data The custom data"
+ }
+ ]
+ },
{
"name" : "hasListener",
"type" : "function",
{
"name" : "notifyDrop",
"type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
+ "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the dragged item has\nbeen dropped on it. The drag zone will look up the target node based on the event passed in, and if there\nis a node registered for that event, it will delegate to {@link #onNodeDrop} for node-specific handling,\notherwise it will call {@link #onContainerDrop}.",
+ "sig" : "(source, e, data)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop zone",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the drop was valid, else false"
+ }
+ ]
},
{
"name" : "notifyEnter",
"type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
+ "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the source is now over\nthe zone. The default implementation returns this.dropNotAllowed and expects that only registered drop\nnodes can process drag drop operations, so if you need the drop zone itself to be able to process drops\nyou should override this method and provide a custom implementation.",
+ "sig" : "(source, e, data)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop zone",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated"
+ }
+ ]
},
{
"name" : "notifyOut",
"type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
+ "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the source has been dragged\nout of the zone without dropping. If the drag source is currently over a registered node, the notification\nwill be delegated to {@link #onNodeOut} for node-specific handling, otherwise it will be ignored.",
+ "sig" : "(source, e, data)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop target",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag zone",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
"name" : "notifyOver",
"type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
+ "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the drop zone.\nThis method will be called on every mouse movement while the drag source is over the drop zone.\nIt will call {@link #onNodeOver} while the drag source is over a registered node, and will also automatically\ndelegate to the appropriate node-specific methods as necessary when the drag source enters and exits\nregistered nodes ({@link #onNodeEnter}, {@link #onNodeOut}). If the drag source is not currently over a\nregistered node, it will call {@link #onContainerOver}.",
+ "sig" : "(source, e, data)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop zone",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated"
+ }
+ ]
},
{
"name" : "on",
"params" : [],
"returns" : []
},
+ {
+ "name" : "onContainerDrop",
+ "type" : "function",
+ "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dropped on it,\nbut not on any of its registered drop nodes. The default implementation returns false, so it should be\noverridden to provide the appropriate processing of the drop event if you need the drop zone itself to\nbe able to accept drops. It should return true when valid so that the drag source's repair action does not run.",
+ "sig" : "(source, e, data)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop zone",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the drop was valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "onContainerOver",
+ "type" : "function",
+ "desc" : "Called internally while the DropZone determines that a {@link Roo.dd.DragSource} is being dragged over it,\nbut not over any of its registered drop nodes. The default implementation returns this.dropNotAllowed, so\nit should be overridden to provide the proper feedback if necessary.",
+ "sig" : "(source, e, data)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop zone",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated"
+ }
+ ]
+ },
{
"name" : "onDrag",
"type" : "function",
{
"name" : "onMouseUp",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
- "sig" : "(e)",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "onNodeDrop",
+ "type" : "function",
+ "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dropped onto\nthe drop node. The default implementation returns false, so it should be overridden to provide the\nappropriate processing of the drop event and return true so that the drag source's repair action does not run.",
+ "sig" : "(nodeData, source, e, data)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "nodeData",
+ "type" : "Object",
+ "desc" : "The custom data associated with the drop node (this is the same value returned from\n{@link #getTargetFromEvent} for this node)",
+ "isOptional" : false
+ },
+ {
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop zone",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the drop was valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "onNodeEnter",
+ "type" : "function",
+ "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has entered a drop node\nthat it has registered. This method has no default implementation and should be overridden to provide\nnode-specific processing if necessary.",
+ "sig" : "(nodeData, source, e, data)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "nodeData",
+ "type" : "Object",
+ "desc" : "The custom data associated with the drop node (this is the same value returned from \n{@link #getTargetFromEvent} for this node)",
+ "isOptional" : false
+ },
+ {
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop zone",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "onNodeOut",
+ "type" : "function",
+ "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dragged out of\nthe drop node without dropping. This method has no default implementation and should be overridden to provide\nnode-specific processing if necessary.",
+ "sig" : "(nodeData, source, e, data)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "nodeData",
+ "type" : "Object",
+ "desc" : "The custom data associated with the drop node (this is the same value returned from\n{@link #getTargetFromEvent} for this node)",
+ "isOptional" : false
+ },
+ {
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop zone",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "onNodeOver",
+ "type" : "function",
+ "desc" : "Called internally while the DropZone determines that a {@link Roo.dd.DragSource} is over a drop node\nthat it has registered. The default implementation returns this.dropNotAllowed, so it should be\noverridden to provide the proper feedback.",
+ "sig" : "(nodeData, source, e, data)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [
+ {
+ "name" : "nodeData",
+ "type" : "Object",
+ "desc" : "The custom data associated with the drop node (this is the same value returned from\n{@link #getTargetFromEvent} for this node)",
+ "isOptional" : false
+ },
+ {
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop zone",
+ "isOptional" : false
+ },
{
"name" : "e",
"type" : "Event",
- "desc" : "the mouseup event",
+ "desc" : "The event",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated"
+ }
+ ]
},
{
"name" : "padding",
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.dd.DropZone"
- ],
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.dd.DropZone" : {
- "props" : [
- {
- "name" : "ddGroup",
- "type" : "String",
- "desc" : "The drag drop group to handle drop events for",
- "memberOf" : "Roo.dd.DropTarget",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "dropAllowed",
- "type" : "String",
- "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
- "memberOf" : "Roo.dd.DropTarget",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "dropNotAllowed",
- "type" : "String",
- "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
- "memberOf" : "Roo.dd.DropTarget",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "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",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "overClass",
- "type" : "String",
- "desc" : "The CSS class applied to the drop target element while the drag source is over it (defaults to \"\").",
- "memberOf" : "Roo.dd.DropTarget",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "success",
- "type" : "boolean",
- "desc" : "set this after drop listener..",
- "memberOf" : "Roo.dd.DropTarget",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "valid",
- "type" : "boolean|String",
- "desc" : "true/false or string (ok-add/ok-sub/ok/nodrop)\nif the drop point is valid for over/enter..",
- "memberOf" : "Roo.dd.DropTarget",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [
+ "Roo.dd.Registry" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "drop",
+ "name" : "getHandle",
"type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the dragged item has\nbeen dropped on it. This method has no default implementation and returns false, so you must provide an\nimplementation that does something to process the drop event and returns true so that the drag source's\nrepair action does not run.\n\nIMPORTANT : it should set this.success",
- "sig" : "function (source, e, data)\n{\n\n}",
- "memberOf" : "Roo.dd.DropTarget",
+ "desc" : "Returns the handle registered for a DOM Node by id",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "name" : "id",
+ "type" : "String|HTMLElement",
+ "desc" : "The DOM node or id to look up",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
- "name" : "data",
+ "name" : "",
"type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
- "isOptional" : false
+ "desc" : "handle The custom handle data"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "enter",
+ "name" : "getHandleFromEvent",
"type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the\ntarget. This default implementation adds the CSS class specified by overClass (if any) to the drop element\nand returns the dropAllowed config value. This method should be overridden if drop validation is required.\n\nIMPORTANT : it should set this.valid to true|false",
- "sig" : "function (source, e, data)\n{\n\n}",
- "memberOf" : "Roo.dd.DropTarget",
+ "desc" : "Returns the handle that is registered for the DOM node that is the target of the event",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
- {
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop target",
- "isOptional" : false
- },
{
"name" : "e",
"type" : "Event",
"desc" : "The event",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
- "name" : "data",
+ "name" : "",
"type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
- "isOptional" : false
+ "desc" : "handle The custom handle data"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "out",
+ "name" : "getTarget",
"type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged\nout of the target without dropping. This default implementation simply removes the CSS class specified by\noverClass (if any) from the drop element.",
- "sig" : "function (source, e, data)\n{\n\n}",
- "memberOf" : "Roo.dd.DropTarget",
+ "desc" : "Returns a custom data object that is registered for a DOM node by id",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "name" : "id",
+ "type" : "String|HTMLElement",
+ "desc" : "The DOM node or id to look up",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
- "name" : "data",
+ "name" : "",
"type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
- "isOptional" : false
+ "desc" : "data The custom data"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "over",
+ "name" : "getTargetFromEvent",
"type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.\nThis method will be called on every mouse movement while the drag source is over the drop target.\nThis default implementation simply returns the dropAllowed config value.\n\nIMPORTANT : it should set this.valid to true|false",
- "sig" : "function (source, e, data)\n{\n\n}",
- "memberOf" : "Roo.dd.DropTarget",
+ "desc" : "Returns a custom data object that is registered for the DOM node that is the target of the event",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
- {
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop target",
- "isOptional" : false
- },
{
"name" : "e",
"type" : "Event",
"desc" : "The event",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
- "name" : "data",
+ "name" : "",
"type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
- "isOptional" : false
+ "desc" : "data The custom data"
}
- ],
- "returns" : []
- }
- ],
- "methods" : [
+ ]
+ },
{
- "name" : "addEvents",
+ "name" : "register",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Register a drag drop element",
+ "sig" : "(element, data)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
+ "name" : "element",
+ "type" : "String|HTMLElement",
+ "desc" : "The id or DOM node to register",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
"type" : "Object",
- "desc" : "The object with the events defined",
+ "desc" : "(optional) A custom data object that will be passed between the elements that are involved\nin drag drop operations. You can populate this object with any arbitrary properties that your own code\nknows how to interpret, plus there are some specific properties known to the Registry that should be\npopulated in the data object (if applicable):\n<pre>\nValue Description<br />\n--------- ------------------------------------------<br />\nhandles Array of DOM nodes that trigger dragging<br />\n for the element being registered<br />\nisHandle True if the element passed in triggers<br />\n dragging itself, else false\n</pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addInvalidHandleClass",
+ "name" : "unregister",
"type" : "function",
- "desc" : "Lets you specify a css class of elements that will not initiate a drag",
- "sig" : "(cssClass)",
+ "desc" : "Unregister a drag drop element",
+ "sig" : "(element)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the elements you wish to ignore",
+ "name" : "element",
+ "type" : "String|HTMLElement",
+ "desc" : "The id or DOM node to unregister",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.dd.ScrollManager" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "addInvalidHandleId",
+ "name" : "refreshCache",
"type" : "function",
- "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
- "sig" : "(id)",
+ "desc" : "Manually trigger a cache refresh.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "string",
- "desc" : "the element id of the element you wish to ignore",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "addInvalidHandleType",
+ "name" : "register",
"type" : "function",
- "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
- "sig" : "(tagName)",
+ "desc" : "Registers new overflow element(s) to auto scroll",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to exclude",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element/Array",
+ "desc" : "The id of or the element to be scrolled or an array of either",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "unregister",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Unregisters overflow element(s) so they are no longer scrolled",
+ "sig" : "(el)",
"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 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>",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element/Array",
+ "desc" : "The id of or the element to be removed or an array of either",
"isOptional" : false
}
],
"returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.dd.StatusProxy" : {
+ "props" : [
+ {
+ "name" : "dropAllowed",
+ "type" : "String",
+ "desc" : "The CSS class to apply to the status element when drop is allowed (defaults to \"x-dd-drop-ok\").",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "addToGroup",
+ "name" : "dropNotAllowed",
+ "type" : "String",
+ "desc" : "The CSS class to apply to the status element when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "getEl",
"type" : "function",
- "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
- "sig" : "(sGroup)",
+ "desc" : "Returns the underlying proxy {@link Roo.Layer}",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "sGroup",
- "type" : "",
- "desc" : "{string} the name of the group",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Layer",
+ "desc" : "el"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "applyConfig",
+ "name" : "getGhost",
"type" : "function",
- "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
+ "desc" : "Returns the ghost element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "el"
+ }
+ ]
},
{
- "name" : "capture",
+ "name" : "hide",
"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" : "Hides the proxy",
+ "sig" : "(clear)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"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",
+ "name" : "clear",
+ "type" : "Boolean",
+ "desc" : "True to reset the status and clear the ghost contents, false to preserve them",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "clearConstraints",
+ "name" : "repair",
"type" : "function",
- "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Causes the proxy to return to its position of origin via an animation. Should be called after an\ninvalid drop operation by the item being dragged.",
+ "sig" : "(xy, callback, scope)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "xy",
+ "type" : "Array",
+ "desc" : "The XY position of the element ([x, y])",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "The function to call after the repair is complete",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "The scope in which to execute the callback",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "clearTicks",
+ "name" : "reset",
"type" : "function",
- "desc" : "Clears any tick interval defined for this instance",
- "sig" : "()\n{\n\n}",
+ "desc" : "Resets the status indicator to the default dropNotAllowed value",
+ "sig" : "(clearGhost)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "clearGhost",
+ "type" : "Boolean",
+ "desc" : "True to also remove all content from the ghost, false to preserve it",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "endDrag",
+ "name" : "setStatus",
"type" : "function",
- "desc" : "Fired when we are done dragging the object",
- "sig" : "(e)",
+ "desc" : "Updates the proxy's visual element to indicate the status of whether or not drop is allowed\nover the current target element.",
+ "sig" : "(cssClass)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "cssClass",
+ "type" : "String",
+ "desc" : "The css class for the new drop status indicator image",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Displays this proxy",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "getDragEl",
+ "name" : "stop",
"type" : "function",
- "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
+ "desc" : "Stops the repair animation if it's currently running",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "HTMLElement",
- "desc" : "the html element"
- }
- ]
+ "returns" : []
},
{
- "name" : "getEl",
+ "name" : "sync",
"type" : "function",
- "desc" : "Returns a reference to the linked element",
+ "desc" : "Force the Layer to sync its shadow and shim positions to the element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "HTMLElement",
- "desc" : "the html element"
- }
- ]
+ "returns" : []
},
{
- "name" : "getTargetFromEvent",
+ "name" : "update",
"type" : "function",
- "desc" : "Returns a custom data object associated with the DOM node that is the target of the event. By default\nthis looks up the event target in the {@link Roo.dd.Registry}, although you can override this method to\nprovide your own custom lookup.",
- "sig" : "(e)",
+ "desc" : "Updates the contents of the ghost element",
+ "sig" : "(html)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "name" : "html",
+ "type" : "String",
+ "desc" : "The html that will replace the current innerHTML of the ghost element",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "data The custom data"
- }
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.dialog" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.dialog.UploadCropbox" : {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "buttons",
+ "type" : "Array",
+ "desc" : "default ['rotateLeft', 'pictureBtn', 'rotateRight']",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "emptyText",
+ "type" : "String",
+ "desc" : "show when image has been loaded",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "errorTimeout",
+ "type" : "Number",
+ "desc" : "default 3000",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "height (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
]
},
{
- "name" : "hasListener",
- "type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
+ "name" : "isDocument",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "e) default tr",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "loadingText",
+ "type" : "Boolean",
+ "desc" : "default 'Loading...'",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "method",
+ "type" : "String",
+ "desc" : "default POST",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minHeight",
+ "type" : "Number",
+ "desc" : "default 300",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minWidth",
+ "type" : "Number",
+ "desc" : "default 300",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "outputMaxWidth",
+ "type" : "Number",
+ "desc" : "default 1200",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "paramName",
+ "type" : "String",
+ "desc" : "default 'imageUpload'",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "rotateNotify",
+ "type" : "String",
+ "desc" : "show when image too small to rotate",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "url",
+ "type" : "String",
+ "desc" : "action url",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "width (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "windowSize",
+ "type" : "Number",
+ "desc" : "default 300",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "arrange",
+ "type" : "function",
+ "desc" : "Fire when arrange the file data",
+ "sig" : "function (_self, formData)\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" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "name" : "formData",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "init",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
- "sig" : "(id, sGroup, config)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : 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" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "the id of the linked element",
- "isOptional" : false
- },
- {
- "name" : "sGroup",
- "type" : "String",
- "desc" : "the group of related items",
+ "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" : "config",
- "type" : "object",
- "desc" : "configuration attributes",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "initTarget",
+ "name" : "beforeloadcanvas",
"type" : "function",
- "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
- "sig" : "(id, sGroup, config)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fire before load the canvas",
+ "sig" : "function (_self, src)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "the id of the linked element",
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "sGroup",
+ "name" : "src",
"type" : "String",
- "desc" : "the group of related items",
- "isOptional" : false
- },
- {
- "name" : "config",
- "type" : "object",
- "desc" : "configuration attributes",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "isLocked",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "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" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "boolean",
- "desc" : "true if this obj or all drag/drop is locked, else\nfalse"
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "isTarget",
+ "name" : "beforeselectfile",
"type" : "function",
- "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fire before select file",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "isValidHandleChild",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Checks the tag exclusion list to see if this click should be ignored",
- "sig" : "(node)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "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" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "HTMLElement",
- "desc" : "the HTMLElement to evaluate",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "boolean",
- "desc" : "true if this is a valid tag type, false if not"
- }
- ]
+ "returns" : []
},
{
- "name" : "lock",
+ "name" : "crop",
"type" : "function",
- "desc" : "Lock this instance",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fire after initEvent",
+ "sig" : "function (_self, data)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "notifyDrop",
+ "name" : "destroy",
"type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the dragged item has\nbeen dropped on it. The drag zone will look up the target node based on the event passed in, and if there\nis a node registered for that event, it will delegate to {@link #onNodeDrop} for node-specific handling,\notherwise it will call {@link #onContainerDrop}.",
- "sig" : "(source, e, data)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "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" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop zone",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the drop was valid, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "notifyEnter",
+ "name" : "download",
"type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the source is now over\nthe zone. The default implementation returns this.dropNotAllowed and expects that only registered drop\nnodes can process drag drop operations, so if you need the drop zone itself to be able to process drops\nyou should override this method and provide a custom implementation.",
- "sig" : "(source, e, data)",
- "static" : false,
+ "desc" : "Fire when download the image",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop zone",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated"
- }
- ]
+ "returns" : []
},
{
- "name" : "notifyOut",
+ "name" : "enable",
"type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the source has been dragged\nout of the zone without dropping. If the drag source is currently over a registered node, the notification\nwill be delegated to {@link #onNodeOut} for node-specific handling, otherwise it will be ignored.",
- "sig" : "(source, e, data)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag zone",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "notifyOver",
+ "name" : "exception",
"type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the drop zone.\nThis method will be called on every mouse movement while the drag source is over the drop zone.\nIt will call {@link #onNodeOver} while the drag source is over a registered node, and will also automatically\ndelegate to the appropriate node-specific methods as necessary when the drag source enters and exits\nregistered nodes ({@link #onNodeEnter}, {@link #onNodeOut}). If the drag source is not currently over a\nregistered node, it will call {@link #onContainerOver}.",
- "sig" : "(source, e, data)",
- "static" : false,
+ "desc" : "Fire when get exception",
+ "sig" : "function (_self, xhr)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop zone",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "name" : "xhr",
+ "type" : "XMLHttpRequest",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated"
- }
- ]
+ "returns" : []
},
{
- "name" : "on",
+ "name" : "footerbuttonclick",
"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" : "Fire when footerbuttonclick",
+ "sig" : "function (_self, type)\n{\n\n}",
+ "memberOf" : "",
"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.dialog.UploadCropbox",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "type",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onAvailable",
+ "name" : "hide",
"type" : "function",
- "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "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" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "onContainerDrop",
+ "name" : "initial",
"type" : "function",
- "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dropped on it,\nbut not on any of its registered drop nodes. The default implementation returns false, so it should be\noverridden to provide the appropriate processing of the drop event if you need the drop zone itself to\nbe able to accept drops. It should return true when valid so that the drag source's repair action does not run.",
- "sig" : "(source, e, data)",
- "static" : false,
+ "desc" : "Fire after initEvent",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop zone",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the drop was valid, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "onContainerOver",
+ "name" : "inspect",
"type" : "function",
- "desc" : "Called internally while the DropZone determines that a {@link Roo.dd.DragSource} is being dragged over it,\nbut not over any of its registered drop nodes. The default implementation returns this.dropNotAllowed, so\nit should be overridden to provide the proper feedback if necessary.",
- "sig" : "(source, e, data)",
- "static" : false,
+ "desc" : "Fire when inspect the file",
+ "sig" : "function (_self, file)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop zone",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "data",
+ "name" : "file",
"type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated"
- }
- ]
+ "returns" : []
},
{
- "name" : "onDrag",
+ "name" : "loadcanvas",
"type" : "function",
- "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fire after load the canvas",
+ "sig" : "function (, imgEl)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
+ "name" : "",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "imgEl",
+ "type" : "Object",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onDragDrop",
+ "name" : "move",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
- "sig" : "(e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is moved.",
+ "sig" : "function (_self, x, y)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onDragEnter",
+ "name" : "prepare",
"type" : "function",
- "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
- "sig" : "(e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fire when preparing the file data",
+ "sig" : "function (_self, file)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.",
+ "name" : "file",
+ "type" : "Object",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onDragOut",
+ "name" : "render",
"type" : "function",
- "desc" : "Abstract method called when we are no longer hovering over an element",
- "sig" : "(e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onDragOver",
+ "name" : "resize",
"type" : "function",
- "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
- "sig" : "(e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fire when resize",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.",
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onInvalidDrop",
+ "name" : "rotate",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fire when rotate the image",
+ "sig" : "function (_self, pos)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "pos",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onMouseDown",
+ "name" : "show",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousedown event",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onMouseUp",
+ "name" : "trash",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fire when trash image",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onNodeDrop",
+ "name" : "upload",
"type" : "function",
- "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dropped onto\nthe drop node. The default implementation returns false, so it should be overridden to provide the\nappropriate processing of the drop event and return true so that the drag source's repair action does not run.",
- "sig" : "(nodeData, source, e, data)",
- "static" : false,
+ "desc" : "Fire when xhr upload the file",
+ "sig" : "function (_self, data)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "nodeData",
- "type" : "Object",
- "desc" : "The custom data associated with the drop node (this is the same value returned from\n{@link #getTargetFromEvent} for this node)",
- "isOptional" : false
- },
- {
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop zone",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
"isOptional" : false
},
{
"name" : "data",
"type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the drop was valid, else false"
- }
- ]
- },
+ "returns" : []
+ }
+ ],
+ "methods" : [
{
- "name" : "onNodeEnter",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has entered a drop node\nthat it has registered. This method has no default implementation and should be overridden to provide\nnode-specific processing if necessary.",
- "sig" : "(nodeData, source, e, data)",
+ "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" : "nodeData",
- "type" : "Object",
- "desc" : "The custom data associated with the drop node (this is the same value returned from \n{@link #getTargetFromEvent} for this node)",
- "isOptional" : false
- },
- {
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop zone",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
- "isOptional" : false
- },
- {
- "name" : "data",
+ "name" : "object",
"type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onNodeOut",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dragged out of\nthe drop node without dropping. This method has no default implementation and should be overridden to provide\nnode-specific processing if necessary.",
- "sig" : "(nodeData, source, e, data)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "nodeData",
- "type" : "Object",
- "desc" : "The custom data associated with the drop node (this is the same value returned from\n{@link #getTargetFromEvent} for this node)",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop zone",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
},
{
- "name" : "data",
+ "name" : "options",
"type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "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" : "onNodeOver",
+ "name" : "capture",
"type" : "function",
- "desc" : "Called internally while the DropZone determines that a {@link Roo.dd.DragSource} is over a drop node\nthat it has registered. The default implementation returns this.dropNotAllowed, so it should be\noverridden to provide the proper feedback.",
- "sig" : "(nodeData, source, e, data)",
- "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" : "nodeData",
- "type" : "Object",
- "desc" : "The custom data associated with the drop node (this is the same value returned from\n{@link #getTargetFromEvent} for this node)",
- "isOptional" : false
- },
- {
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop zone",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
"isOptional" : false
},
{
- "name" : "data",
+ "name" : "scope",
"type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated"
- }
- ]
+ "returns" : []
},
{
- "name" : "padding",
+ "name" : "destroy",
"type" : "function",
- "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "disable",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Disable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "releaseCapture",
+ "name" : "enable",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "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" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "removeFromGroup",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Remove's this instance from the supplied interaction group",
- "sig" : "(sGroup)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "sGroup",
- "type" : "string",
- "desc" : "The group to drop",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "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" : "removeInvalidHandleClass",
+ "name" : "focus",
"type" : "function",
- "desc" : "Unsets an invalid css class",
- "sig" : "(cssClass)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the element(s) you wish to\nre-enable",
+ "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" : "removeInvalidHandleId",
+ "name" : "getBox",
"type" : "function",
- "desc" : "Unsets an invalid handle id",
- "sig" : "(id)",
+ "desc" : "Gets the current box measurements of the component's underlying element.",
+ "sig" : "(local)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "string",
- "desc" : "the id of the element to re-enable",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeInvalidHandleType",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
- "sig" : "(tagName)",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to unexclude",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "removeListener",
+ "name" : "getId",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "eventName",
+ "name" : "",
"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
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "resetConstraints",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "resetConstraints must be called if you manually reposition a dd element.",
- "sig" : "(maintainOffset)",
+ "desc" : "Gets the current XY position of the component's underlying element.",
+ "sig" : "(local)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "maintainOffset",
- "type" : "boolean",
- "desc" : "",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "The XY position of the element (e.g., [100, 200])"
+ }
+ ]
},
{
- "name" : "setDragElId",
+ "name" : "getSize",
"type" : "function",
- "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
- "sig" : "(id)",
+ "desc" : "Gets the current size of the component's underlying element.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "{string} the id of the element that will be used to initiate the drag",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setHandleElId",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
- "sig" : "(id)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
+ "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" : "setInitPosition",
+ "name" : "hide",
"type" : "function",
- "desc" : "Stores the initial placement of the linked element.",
- "sig" : "(diffX, diffY)",
+ "desc" : "Hide this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "diffX",
- "type" : "int",
- "desc" : "the X offset, default 0",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "diffY",
- "type" : "int",
- "desc" : "the Y offset, default 0",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setOuterHandleElId",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
- "sig" : "(id)",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "",
- "desc" : "the id of the element that will be used to initiate the drag",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setPadding",
+ "name" : "on",
"type" : "function",
- "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
- "sig" : "(iTop, iRight, iBot, iLeft)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iTop",
- "type" : "int",
- "desc" : "Top pad",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "iRight",
- "type" : "int",
- "desc" : "Right pad",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "iBot",
- "type" : "int",
- "desc" : "Bot pad",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
},
{
- "name" : "iLeft",
- "type" : "int",
- "desc" : "Left pad",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setXConstraint",
+ "name" : "onPosition",
"type" : "function",
- "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
- "sig" : "(iLeft, iRight, iTickSize)",
+ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
+ "sig" : "(x, y)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iLeft",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the left",
- "isOptional" : false
- },
- {
- "name" : "iRight",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the\nright",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
"isOptional" : false
},
{
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setYConstraint",
+ "name" : "onResize",
"type" : "function",
- "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
- "sig" : "(iUp, iDown, iTickSize)",
+ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
+ "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iUp",
- "type" : "int",
- "desc" : "the number of pixels the element can move up",
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
"isOptional" : false
},
{
- "name" : "iDown",
- "type" : "int",
- "desc" : "the number of pixels the element can move down",
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
"isOptional" : false
},
{
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "startDrag",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
- "sig" : "(X, Y)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "X",
- "type" : "int",
- "desc" : "click location",
- "isOptional" : false
- },
- {
- "name" : "Y",
- "type" : "int",
- "desc" : "click location",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "toString",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "toString method",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
+ "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" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "string",
- "desc" : "string representation of the dd obj"
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "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" : "unlock",
- "type" : "function",
- "desc" : "Unlock this instace",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "unreg",
- "type" : "function",
- "desc" : "Remove all drag and drop hooks for this element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.dd.Registry" : {
- "props" : [],
- "events" : [],
- "methods" : [
- {
- "name" : "getHandle",
+ "name" : "render",
"type" : "function",
- "desc" : "Returns the handle registered for a DOM Node by id",
- "sig" : "(id)",
+ "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" : "id",
- "type" : "String|HTMLElement",
- "desc" : "The DOM node or id to look up",
+ "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" : "",
- "type" : "Object",
- "desc" : "handle The custom handle data"
- }
- ]
+ "returns" : []
},
{
- "name" : "getHandleFromEvent",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Returns the handle that is registered for the DOM node that is the target of the event",
- "sig" : "(e)",
+ "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" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "handle The custom handle data"
- }
- ]
+ "returns" : []
},
{
- "name" : "getTarget",
+ "name" : "setPagePosition",
"type" : "function",
- "desc" : "Returns a custom data object that is registered for a DOM node by id",
- "sig" : "(id)",
+ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
+ "sig" : "(x, y)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String|HTMLElement",
- "desc" : "The DOM node or id to look up",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
"isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "data The custom data"
- }
- ]
- },
- {
- "name" : "getTargetFromEvent",
- "type" : "function",
- "desc" : "Returns a custom data object that is registered for the DOM node that is the target of the event",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "data The custom data"
- }
- ]
+ "returns" : []
},
{
- "name" : "register",
+ "name" : "setPosition",
"type" : "function",
- "desc" : "Register a drag drop element",
- "sig" : "(element, data)",
+ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
+ "sig" : "(left, top)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "element",
- "type" : "String|HTMLElement",
- "desc" : "The id or DOM node to register",
+ "name" : "left",
+ "type" : "Number",
+ "desc" : "The new left",
"isOptional" : false
},
{
- "name" : "data",
- "type" : "Object",
- "desc" : "(optional) A custom data object that will be passed between the elements that are involved\nin drag drop operations. You can populate this object with any arbitrary properties that your own code\nknows how to interpret, plus there are some specific properties known to the Registry that should be\npopulated in the data object (if applicable):\n<pre>\nValue Description<br />\n--------- ------------------------------------------<br />\nhandles Array of DOM nodes that trigger dragging<br />\n for the element being registered<br />\nisHandle True if the element passed in triggers<br />\n dragging itself, else false\n</pre>",
+ "name" : "top",
+ "type" : "Number",
+ "desc" : "The new top",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "unregister",
+ "name" : "setSize",
"type" : "function",
- "desc" : "Unregister a drag drop element",
- "sig" : "(element)",
+ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
+ "sig" : "(width, height)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "element",
- "type" : "String|HTMLElement",
- "desc" : "The id or DOM node to unregister",
+ "name" : "width",
+ "type" : "Number/Object",
+ "desc" : "The new width to set, or a size object in the format {width, height}",
"isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.dd.ScrollManager" : {
- "props" : [],
- "events" : [],
- "methods" : [
- {
- "name" : "refreshCache",
- "type" : "function",
- "desc" : "Manually trigger a cache refresh.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "register",
- "type" : "function",
- "desc" : "Registers new overflow element(s) to auto scroll",
- "sig" : "(el)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "el",
- "type" : "String/HTMLElement/Element/Array",
- "desc" : "The id of or the element to be scrolled or an array of either",
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height to set (not required if a size object is passed as the first arg)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.BoxComponent",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "unregister",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Unregisters overflow element(s) so they are no longer scrolled",
- "sig" : "(el)",
+ "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" : "el",
- "type" : "String/HTMLElement/Element/Array",
- "desc" : "The id of or the element to be removed or an array of either",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.dd.StatusProxy" : {
- "props" : [
- {
- "name" : "dropAllowed",
- "type" : "String",
- "desc" : "The CSS class to apply to the status element when drop is allowed (defaults to \"x-dd-drop-ok\").",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
- {
- "name" : "dropNotAllowed",
- "type" : "String",
- "desc" : "The CSS class to apply to the status element when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- }
- ],
- "events" : [],
- "methods" : [
- {
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns the underlying proxy {@link Roo.Layer}",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Layer",
- "desc" : "el"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getGhost",
+ "name" : "show",
"type" : "function",
- "desc" : "Returns the ghost element",
+ "desc" : "Show this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "el"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "hide",
+ "name" : "syncSize",
"type" : "function",
- "desc" : "Hides the proxy",
- "sig" : "(clear)",
+ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "clear",
- "type" : "Boolean",
- "desc" : "True to reset the status and clear the ghost contents, false to preserve them",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "repair",
+ "name" : "un",
"type" : "function",
- "desc" : "Causes the proxy to return to its position of origin via an animation. Should be called after an\ninvalid drop operation by the item being dragged.",
- "sig" : "(xy, callback, scope)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "xy",
- "type" : "Array",
- "desc" : "The XY position of the element ([x, y])",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "callback",
+ "name" : "handler",
"type" : "Function",
- "desc" : "The function to call after the repair is complete",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "The scope in which to execute the callback",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the status indicator to the default dropNotAllowed value",
- "sig" : "(clearGhost)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "clearGhost",
- "type" : "Boolean",
- "desc" : "True to also remove all content from the ghost, false to preserve it",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setStatus",
- "type" : "function",
- "desc" : "Updates the proxy's visual element to indicate the status of whether or not drop is allowed\nover the current target element.",
- "sig" : "(cssClass)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "cssClass",
- "type" : "String",
- "desc" : "The css class for the new drop status indicator image",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
- "type" : "function",
- "desc" : "Displays this proxy",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "stop",
- "type" : "function",
- "desc" : "Stops the repair animation if it's currently running",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "sync",
- "type" : "function",
- "desc" : "Force the Layer to sync its shadow and shim positions to the element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "update",
+ "name" : "updateBox",
"type" : "function",
- "desc" : "Updates the contents of the ghost element",
- "sig" : "(html)",
+ "desc" : "Sets the current box measurements of the component's underlying element.",
+ "sig" : "(box)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "html",
- "type" : "String",
- "desc" : "The html that will replace the current innerHTML of the ghost element",
+ "name" : "box",
+ "type" : "Object",
+ "desc" : "An object in the format {x, y, width, height}",
"isOptional" : false
}
],
{
"name" : "errorMask",
"type" : "Boolean",
- "desc" : "e) default fal",
+ "desc" : "Should the form be masked (and the active element highlighted on error - default false",
"memberOf" : "",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
+ "optvals" : []
},
{
"name" : "errorReader",
{
"name" : "maskOffset",
"type" : "Number",
- "desc" : "Default 100",
+ "desc" : "space around form element to mask if there is an error Default 100",
"memberOf" : "",
"isOptional" : false,
"optvals" : []
{
"name" : "asString",
"type" : "Boolean",
- "desc" : "",
+ "desc" : "(def)",
"isOptional" : false
}
],
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tabIndex",
"type" : "Number",
{
"name" : "labelAlign",
"type" : "String",
- "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
+ "desc" : "t)\nValid values are \"left,\" \"top\" and \"right\" (defaults to \"left",
"memberOf" : "Roo.form.Layout",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "left",
+ "top",
+ "right"
+ ]
},
{
"name" : "labelSeparator",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "lazyRender",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tabIndex",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tabIndex",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "width",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "lazyRender",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tabIndex",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "lazyRender",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tabIndex",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tabIndex",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tabIndex",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tabIndex",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tabIndex",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tabIndex",
"type" : "Number",
{
"name" : "labelAlign",
"type" : "String",
- "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
+ "desc" : "t)\nValid values are \"left,\" \"top\" and \"right\" (defaults to \"left",
"memberOf" : "Roo.form.Layout",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "left",
+ "top",
+ "right"
+ ]
},
{
"name" : "labelSeparator",
},
"Roo.form.Form" : {
"props" : [
- {
- "name" : "(left|center|right)",
- "type" : "String",
- "desc" : "buttonAlign Valid values are \"left,\" \"center\" and \"right\" (defaults to \"center\")",
- "memberOf" : "",
- "isOptional" : false,
- "optvals" : []
- },
{
"name" : "baseParams",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "buttonAlign",
+ "type" : "String",
+ "desc" : "t) Valid values are \"left,\" \"center\" and \"right\" (defaults to \"center",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
+ },
{
"name" : "buttons[]",
"type" : "Roo.Button",
{
"name" : "errorMask",
"type" : "Boolean",
- "desc" : "e) default fal",
+ "desc" : "Should the form be masked (and the active element highlighted on error - default false",
"memberOf" : "Roo.form.BasicForm",
"isOptional" : false,
- "optvals" : [
- "true",
- "false"
- ]
+ "optvals" : []
},
{
"name" : "errorReader",
{
"name" : "maskOffset",
"type" : "Number",
- "desc" : "Default 100",
+ "desc" : "space around form element to mask if there is an error Default 100",
"memberOf" : "Roo.form.BasicForm",
"isOptional" : false,
"optvals" : []
{
"name" : "asString",
"type" : "Boolean",
- "desc" : "",
+ "desc" : "(def)",
"isOptional" : false
}
],
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tabIndex",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tabIndex",
"type" : "Number",
"visibility"
]
},
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "language",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "stylesheets",
"type" : "Array",
{
"name" : "labelAlign",
"type" : "String",
- "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
+ "desc" : "t)\nValid values are \"left,\" \"top\" and \"right\" (defaults to \"left",
"memberOf" : "",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "left",
+ "top",
+ "right"
+ ]
},
{
"name" : "labelSeparator",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tabIndex",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tabIndex",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tabIndex",
"type" : "Number",
"desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.",
"sig" : "(value, suppressEvent)",
"static" : false,
- "memberOf" : "Roo.form.Checkbox",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "labelAlign",
"type" : "String",
- "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
+ "desc" : "t)\nValid values are \"left,\" \"top\" and \"right\" (defaults to \"left",
"memberOf" : "Roo.form.Layout",
"isOptional" : false,
- "optvals" : []
+ "optvals" : [
+ "left",
+ "top",
+ "right"
+ ]
},
{
"name" : "labelSeparator",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "lazyRender",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tabIndex",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "labels",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tabIndex",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tabIndex",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tabIndex",
"type" : "Number",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tag",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tabIndex",
"type" : "Number",
"events" : [],
"methods" : [
{
- "name" : "alpha'",
+ "name" : "alpha",
"type" : "function",
"desc" : "The function used to validate alpha values",
"sig" : "(value)",
"returns" : []
},
{
- "name" : "alphanum'",
+ "name" : "alphanum",
"type" : "function",
"desc" : "The function used to validate alphanumeric values",
"sig" : "(value)",
"returns" : []
},
{
- "name" : "email'",
+ "name" : "email",
"type" : "function",
"desc" : "The function used to validate email addresses",
"sig" : "(value)",
"returns" : []
},
{
- "name" : "url'",
+ "name" : "url",
"type" : "function",
"desc" : "The function used to validate URLs",
"sig" : "(value)",
}
],
"returns" : []
+ },
+ {
+ "name" : "urlWeb",
+ "type" : "function",
+ "desc" : "The funciton used to validate URLs (only allow schemes 'https' and 'http')",
+ "sig" : "(v)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "v",
+ "type" : "String",
+ "desc" : "The URL",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"isAbstract" : false,
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "footer",
+ "type" : "Roo.PagingToolbar",
+ "desc" : "the paging toolbar",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "footer",
+ "type" : "Roo.PagingToolbar",
+ "desc" : "the paging toolbar",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "footer",
+ "type" : "Roo.PagingToolbar",
+ "desc" : "the paging toolbar",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "updateEl",
"type" : "Boolean",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "footer",
+ "type" : "Roo.PagingToolbar",
+ "desc" : "the paging toolbar",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "listeners",
"type" : "Object",
"tree_children" : [],
"tree_parent" : []
},
+ "Roo.htmleditor.FilterHashLink" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
"Roo.htmleditor.FilterKeepChildren" : {
"props" : [],
"events" : [],
"memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "text",
"type" : "String",
"memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "text",
"type" : "String",
"memberOf" : "Roo.util.Observable",
"isOptional" : false,
"optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "text",
"type" : "String",
"isOptional" : false,
"optvals" : []
},
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "tree",
"type" : "Roo.tree.TreePanel",
"Roo.bootstrap.form.FieldLabel",
"Roo.bootstrap.form.Form",
"Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.HtmlEditorToolbarStandard",
+ "Roo.bootstrap.form.HtmlEditorToolbar.Standard",
"Roo.bootstrap.form.Input",
"Roo.bootstrap.form.Markdown",
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"Roo.data.DataProxy",
"Roo.data.HttpProxy",
"Roo.data.JsonStore",
+ "Roo.data.MemoryProxy",
"Roo.data.Node",
"Roo.data.SimpleStore",
"Roo.data.Store",
"Roo.dd.DragZone",
"Roo.dd.DropTarget",
"Roo.dd.DropZone",
+ "Roo.dialog.UploadCropbox",
"Roo.form.BasicForm",
"Roo.form.Checkbox",
"Roo.form.Column",
projects / roojs1 / blobdiff